Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lambdaloop committed Mar 25, 2019
1 parent d6d2f0b commit 59e37ce
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,18 @@ from checkerboard import detect_checkerboard

size = (9, 6) # size of checkerboard
image = ... # obtain checkerboard
corners = detect_checkerboard(image, size)
corners, score = detect_checkerboard(image, size)
```

The `corners` returned are in the same format as the
`findChessboardCorners` function from OpenCV, and are already computed
to subpixel precision.

The `score` returned is a metric of the quality of the checkerboard
detection. A perfectly detected checkerboard would have a score of 0,
whereas a bad detection would have a score of 1.


## References

The implementation of checkerboard detection is mainly based on [libcbdetect](http://www.cvlibs.net/software/libcbdetect/)
Expand Down

0 comments on commit 59e37ce

Please sign in to comment.