Skip to content

Bright Neighbor Validation #2

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.

Sign up for GitHub

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

Closed
wants to merge 16 commits into from
Closed

Bright Neighbor Validation #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
e372339
add initial bright neighbor validation code
imedan Apr 2, 2024
4f7bee7
add dependencies for validation code
imedan Apr 2, 2024
68ea8fa
fix linter errors
imedan Apr 2, 2024
4b35908
linter imports
imedan Apr 2, 2024
f6d577f
linter imports
imedan Apr 2, 2024
662799e
add comment
imedan Apr 2, 2024
1fab038
add return
imedan Apr 2, 2024
cd7056a
add coordio to dependencies
imedan Apr 4, 2024
4f91c67
add can_offset to the datamodel
imedan Apr 4, 2024
b5de250
add can_offset to sample
imedan Apr 4, 2024
8087e8f
add epoch for rows with proper motions
imedan Apr 4, 2024
64323af
ran poetry update
imedan Apr 4, 2024
f4b5d83
add offseting and proper motion correction to bn_validation
imedan Apr 4, 2024
aa6f61e
add observatory to input for validation
imedan Apr 4, 2024
5443ab0
add magnitude check
imedan Apr 11, 2024
764d437
rename return for bn check
imedan Apr 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 35 additions & 34 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,40 +25,41 @@ This package deals with all the aspects of loading and processing targets of opp

Target of opportunity files must be CSV or [Parquet](https://parquet.apache.org) files with a table/dataframe that conforms to the following structure:

| Column | Type | Description |
|---------------------|---------|----------------------------------------------------------------------------------------------------------|
| too_id | int64 | Unique identifier for the ToO target. [required] |
| fiber_type | string | Type of fiber to be used to observe the target. [required. |
| catalogid | int64 | catalogid for this target. |
| sdss_id | int64 | sdss_id for this target. |
| gaia_dr3_source_id | int64 | Unique identifier of the target in the Gaia DR3 catalog (`source_id` column). |
| twomass_pts_key | int32 | Unique identifier of the target in the 2MASS catalog (`pts_key` column). |
| sky_brightness_mode | string | The sky brightness mode. Either `bright` or `dark`. |
| ra | float64 | The Right Ascension of the target in ICRS coordinates as decimal degrees. [required] |
| dec | float64 | The declination of the target in ICRS coordinates as decimal degrees. [required] |
| pmra | float32 | The proper motion in RA in mas/yr as a true angle (the cos(dec) factor must have been applied). |
| pmdec | float32 | The proper motion in Dec in mas/yr as a true angle. |
| epoch | float32 | The epoch of the ra/dec coordinates. Required but only relevant if pmra/pmdec are defined. |
| parallax | float32 | The parallax in arcsec. |
| lambda_eff | float32 | The effective wavelength to calculate the atmospheric refraction correction for the target. |
| u_mag | float32 | Sloan u' magnitude of the target. |
| g_mag | float32 | Sloan g' magnitude of the target. |
| r_mag | float32 | Sloan r' magnitude of the target. |
| i_mag | float32 | Sloan i' magnitude of the target. |
| z_mag | float32 | Sloan z' magnitude of the target. |
| optical_prov | string | Source of the optical magnitudes. |
| gaia_bp_mag | float32 | |
| gaia_rp_mag | float32 | |
| gaia_g_mag | float32 | Gaia G magnitude of the target. |
| h_mag | float32 | H-band magnitude of the target. |
| delta_ra | float32 | Fixed RA offset as a true angle, in arcsec. |
| delta_dec | float32 | Fixed Dec offset, in arcsec. |
| inertial | boolean | `true` if not offset correction should be applied based on target magnitude. `false` otherwise. |
| n_exposures | int16 | The minimum number of exposures required for the ToO to be complete and not assigned anymore. [required] |
| priority | int16 | |
| active | boolean | `true` if the target is active and should be assigned to configurations if possible. [required] |
| expiration_date | int32 | MJD at which the target should automatically be consider inactive. If empty, the target never expires. |
| observed | boolean | `true` if the target has been fully observed and should not be assigned again. [required] |
| Column | Type | Description |
|---------------------|---------|----------------------------------------------------------------------------------------------------------------------|
| too_id | int64 | Unique identifier for the ToO target. [required] |
| fiber_type | string | Type of fiber to be used to observe the target. [required. |
| catalogid | int64 | catalogid for this target. |
| sdss_id | int64 | sdss_id for this target. |
| gaia_dr3_source_id | int64 | Unique identifier of the target in the Gaia DR3 catalog (`source_id` column). |
| twomass_pts_key | int32 | Unique identifier of the target in the 2MASS catalog (`pts_key` column). |
| sky_brightness_mode | string | The sky brightness mode. Either `bright` or `dark`. |
| ra | float64 | The Right Ascension of the target in ICRS coordinates as decimal degrees. [required] |
| dec | float64 | The declination of the target in ICRS coordinates as decimal degrees. [required] |
| pmra | float32 | The proper motion in RA in mas/yr as a true angle (the cos(dec) factor must have been applied). |
| pmdec | float32 | The proper motion in Dec in mas/yr as a true angle. |
| epoch | float32 | The epoch of the ra/dec coordinates. Required but only relevant if pmra/pmdec are defined. |
| parallax | float32 | The parallax in arcsec. |
| lambda_eff | float32 | The effective wavelength to calculate the atmospheric refraction correction for the target. |
| u_mag | float32 | Sloan u' magnitude of the target. |
| g_mag | float32 | Sloan g' magnitude of the target. |
| r_mag | float32 | Sloan r' magnitude of the target. |
| i_mag | float32 | Sloan i' magnitude of the target. |
| z_mag | float32 | Sloan z' magnitude of the target. |
| optical_prov | string | Source of the optical magnitudes. |
| gaia_bp_mag | float32 | |
| gaia_rp_mag | float32 | |
| gaia_g_mag | float32 | Gaia G magnitude of the target. |
| h_mag | float32 | H-band magnitude of the target. |
| delta_ra | float32 | Fixed RA offset as a true angle, in arcsec. |
| delta_dec | float32 | Fixed Dec offset, in arcsec. |
| can_offset | boolean | `true` if the ToO is allowed to be offset. Offseting will only occur if target violates magnitude limits. [required] |
| inertial | boolean | `true` if not offset correction should be applied based on target magnitude. `false` otherwise. |
| n_exposures | int16 | The minimum number of exposures required for the ToO to be complete and not assigned anymore. [required] |
| priority | int16 | |
| active | boolean | `true` if the target is active and should be assigned to configurations if possible. [required] |
| expiration_date | int32 | MJD at which the target should automatically be consider inactive. If empty, the target never expires. |
| observed | boolean | `true` if the target has been fully observed and should not be assigned again. [required]

At least one magnitude is required. If one of the Sloan magnitude is provided, *all* the ugriz values must be provided. A sample, valid ToO file can be found [here](docs/sample.csv).

Expand Down
Loading
Loading