Clarify comment for size fields in bounding box messages #51
Conversation
msg/BoundingBox2D.msg
Outdated
| # The size (in pixels) of the bounding box surrounding the object relative | ||
| # to the pose of its center. | ||
| # The total size (in pixels) of the bounding box surrounding the | ||
| # object. The X and Y axes are relative to the center pose |
There was a problem hiding this comment.
What is "including rotation" mean?
There was a problem hiding this comment.
I don't think that entire second sentence is necessary (and honestly is pretty confusing)
There was a problem hiding this comment.
I agree, it's a confusing wording.
It was an attempt to clarify that the size is not measured in "global frame" XY coordinates, but in "local frame" XY coordinates. In other words, the sizes given are not for an axis-aligned bounding box, but for the rotated bounding box.
How about "The X and Y axes are expressed in the frame defined by the the center field" (pulled directly from #27 discussion)? Or do you still feel it's confusing?
There was a problem hiding this comment.
I think that you don't need to clarify this point, its pretty clear. What that ticket is commenting on is whether the size is full width or the width compared against the center point (like a radius vs diameter).
I think you just need the word "total" to clarify that point
Closes #27. See that issue for details.