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.

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

DM-44955: Update eff_time metric documentation #231

Merged
merged 1 commit into from
Jun 21, 2024
Merged

DM-44955: Update eff_time metric documentation #231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion yml/cdb_latiss.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -790,7 +790,7 @@ tables:
- name: eff_time
"@id": "#visit1_quicklook.eff_time"
datatype: float
description: Effective exposure time.
description: Effective exposure time calculated from PSF sigma, sky background, and zero point.
ivoa:unit: s
- name: eff_time_psf_sigma_scale
"@id": "#visit1_quicklook.eff_time_psf_sigma_scale"
Expand Down
7 changes: 2 additions & 5 deletions yml/cdb_lsstcomcam.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1227,23 +1227,20 @@ tables:
- name: eff_time
"@id": "#ccdvisit1_quicklook.eff_time"
datatype: float
description: Effective exposure time.
description: Effective exposure time calculated from PSF sigma, sky background, and zero point.
ivoa:unit: s
- name: eff_time_psf_sigma_scale
"@id": "#ccdvisit1_quicklook.eff_time_psf_sigma_scale"
datatype: float
description: Effective exposure time, PSF sigma scale.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why were the units removed?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might make sense to change the description to be "Scale factor for effective exposure time based on PSF sigma".

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

100%. Also perhaps a better name pattern would be eff_time_scale_psf_sigma (etc.) -- it's an "effective time scale [factor]" due to "PDF sigma"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you are interested in the original naming discussion surrounding these quantities...
https://lsstc.slack.com/archives/C01JTSDV7CH/p1706307463383399

ivoa:unit: s
- name: eff_time_psf_sky_bg_scale
"@id": "#ccdvisit1_quicklook.eff_time_sky_bg_scale"
datatype: float
description: Effective exposure time, sky backgroundscale.
ivoa:unit: s
description: Effective exposure time, sky background scale.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why were the units removed?

- name: eff_time_psf_zero_point_scale
"@id": "#ccdvisit1_quicklook.eff_time_zero_point_scale"
datatype: float
description: Effective exposure time, zero point scale.
ivoa:unit: s
- name: mean_var
"@id": "#ccdvisit1_quicklook.mean_var"
datatype: float
Expand Down
7 changes: 2 additions & 5 deletions yml/cdb_lsstcomcamsim.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1227,23 +1227,20 @@ tables:
- name: eff_time
"@id": "#ccdvisit1_quicklook.eff_time"
datatype: float
description: Effective exposure time.
description: Effective exposure time calculated from PSF sigma, sky background, and zero point.
ivoa:unit: s
- name: eff_time_psf_sigma_scale
"@id": "#ccdvisit1_quicklook.eff_time_psf_sigma_scale"
datatype: float
description: Effective exposure time, PSF sigma scale.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why were the units removed?

ivoa:unit: s
- name: eff_time_psf_sky_bg_scale
"@id": "#ccdvisit1_quicklook.eff_time_sky_bg_scale"
datatype: float
description: Effective exposure time, sky backgroundscale.
ivoa:unit: s
description: Effective exposure time, sky background scale.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why were the units removed?

- name: eff_time_psf_zero_point_scale
"@id": "#ccdvisit1_quicklook.eff_time_zero_point_scale"
datatype: float
description: Effective exposure time, zero point scale.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why were the units removed?

ivoa:unit: s
- name: mean_var
"@id": "#ccdvisit1_quicklook.mean_var"
datatype: float
Expand Down
Loading