Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

aruco: documentation for Board class contradicts tutorial #3197

Closed
crackwitz opened this issue Mar 15, 2022 · 2 comments · Fixed by #3174
Closed

aruco: documentation for Board class contradicts tutorial #3197

crackwitz opened this issue Mar 15, 2022 · 2 comments · Fixed by #3174
Assignees
Labels
category: aruco category: documentation Documentation fix or update, does not affect code

Comments

@crackwitz
Copy link

crackwitz commented Mar 15, 2022

The tutorial states (emphasis mine)

For each marker, its four corners are stored in the standard order, i.e. in clockwise order and starting with the top left corner.

The docs state (emphasis mine)

array of object points of all the marker corners in the board each marker include its 4 corners in CCW order. For M markers, the size is Mx4.

My practical experience is that the tutorial is right and it even explains "standard order". The docs are wrong and incomplete there.

The API doc for aruco::Board should state the order clearly and correctly. If reference to "the standard order" is deemed sufficient, it should be defined in the API docs. API docs frequently refer to "clockwise" order without stating which corner is the first. That information can be inferred from the first aruco tutorial, where the top left corner is marked, and axes in the standard RGB coloring indicate this to be the -X+Y corner, order proceeding negatively around Z (i.e. clockwise looking at the marker).

Places of those docs:

@AleksandrPanov
Copy link
Contributor

This PR fix your issue #3174.

@AleksandrPanov AleksandrPanov linked a pull request Mar 16, 2022 that will close this issue
6 tasks
@AleksandrPanov AleksandrPanov self-assigned this Mar 16, 2022
@asmorkalov
Copy link
Contributor

@crackwitz May we close the ticket then?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: aruco category: documentation Documentation fix or update, does not affect code
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants