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

improve target_[xy] documentation #342

Open
adriaanph opened this issue Jul 28, 2021 · 1 comment
Open

improve target_[xy] documentation #342

adriaanph opened this issue Jul 28, 2021 · 1 comment

Comments

@adriaanph
Copy link
Member

current documentation in dataset.py does not state the sign convention adopted for target_x & target_y. consider adding something like one of the following:

a) "Conventions for target_x & target_y are described in katpoint.projection.", or

b) "The (target_x, target_y) coordinates correspond to the (L, M) direction cosines calculated in [Gre1993a]_ and
[Gre1993b]_." (adapted from katpoint.projection), or

c) "The target_y coordinate axis in the plane points along the target's meridian of longitude towards the positive singularity of the sphere (in the direction of increasing elevation or declination, depending on coordinate system used). The target_x coordinate axis is perpendicular to it and points in the direction of increasing latitude (azimuth or right ascension)." (adapted from katpoint.projection).

it might be useful to add simple statements like:
"The coordinate convention roughly translates to [antenna pointing]_x ~ [target centre]_x + [offset]target_x"
"The coordinate convention roughly translates to [antenna pointing]_y ~ [target centre]_y + [offset]target_y"

@adriaanph
Copy link
Member Author

@ludwigschwardt

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant