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

Etiher the documentation or PhotometryData needs updating... #452

Open
mwcraig opened this issue Sep 15, 2024 · 1 comment
Open

Etiher the documentation or PhotometryData needs updating... #452

mwcraig opened this issue Sep 15, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@mwcraig
Copy link
Contributor

mwcraig commented Sep 15, 2024

In the documentation we say this about photometry data in stellarphot:

Photometry objects always have these attributes, also available dictionary-style:

+ ``mag`` -- the calibrated magnitude; may be missing (e.g. your data prior to calibration)
+ ``mag_err`` -- error in ``mag``
+ ``inst_mag`` -- the instrumental magnitude; may be missing (e.g. catalog data)
+ ``inst_mag_err`` -- error int the ``inst_mag``
+ ``band`` -- the filter of the magnitude; required
+ ``BJD`` -- Barycentric Julian Date of the midpoint of the observation; may be missing/masked
+ ``RA2000`` -- right ascension in degrees, in the ICRS frame at epoch 2000
+ ``DEC2000`` -- declination in degrees in the ICRS frame at epoch 2000

We should either update PhotometryData to do this (which seems like a fine and simple route) or update the documentation. I'd lean towards having a coordinate object provided instead of separate RA and Dec, though. The coordinate object is much more useful.

@JuanCab -- accumulating issues to talk through 😬

@mwcraig mwcraig added the documentation Improvements or additions to documentation label Sep 15, 2024
@mwcraig mwcraig added this to the 2.0.0 milestone Sep 15, 2024
@JuanCab
Copy link
Contributor

JuanCab commented Sep 15, 2024

I have no problem with using a coordinate object to hold the positions although maybe providing properties to access RA and Dec easily might be useful, I can't remember if I assumed access to these coordinates everywhere.

As for augmenting issues, I am available most afternoons next week, just let me know.

@mwcraig mwcraig modified the milestones: 2.0.0, 2.0.0-beta Oct 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants