Details
-
Type:
Bug
-
Status: To Do
-
Resolution: Unresolved
-
Fix Version/s: None
-
Component/s: Qserv
-
Labels:
-
Story Points:1
-
Epic Link:
-
Sprint:DB_F22_6, DB_S23_6
-
Team:Data Access and Database
-
Urgent?:No
Description
The documentation for qserv_areaspec_ellipse appears to be wrong. It documents three arguments, but surely it must have five in order to specify an ellipse center, axis lengths, and rotation angle. Cursory inspection of the source code seems to confirm this.
Please correct the documentation. Also, please double check the documented units, and clarify the definition of the angle parameter. I assume that it's the angle "east of north" of the semi-major axis, but the documentation doesn't say that. Confirmation that it's really a clockwise angle, not the usual analytic geometry convention of positive angles being counterclockwise, would be good, too.
Thanks!
Although it wasn't mentioned on this ticket, the missing arguments were added to the documentation in commit https://github.com/lsst/qserv/commit/85ea9b5f9b2b42304e409805b229c2b9cf55a94e#diff-8ba3c52f628b29fc9481bf247321a612 but unfortunately that seems to have introduced an error in the description of the units for the ellipse axes.