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

Expanding Core Schema for FRB #226

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

Vidushi-GitHub
Copy link
Member

@Vidushi-GitHub Vidushi-GitHub commented Dec 4, 2024

Description

Observables relevant for radio transients:

  • Dispersion Measure schema

  • Reporter.schema.json: spectral_center

  • DateTime.schema.json: time_resolution

@Vidushi-GitHub Vidushi-GitHub force-pushed the frb/specific branch 2 times, most recently from 84437ee to 5bf3f24 Compare December 12, 2024 23:44
@Vidushi-GitHub Vidushi-GitHub marked this pull request as ready for review December 13, 2024 03:12
@Vidushi-GitHub Vidushi-GitHub self-assigned this Dec 16, 2024
Copy link
Contributor

@tabbott36 tabbott36 left a comment

Choose a reason for hiding this comment

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

The changes I recommend are as follows:

  • I would exclude the "dm_gal_ne_2001_max" from the core schema, as this value is an optional post detection analysis, and the specific model (i.e. NE_2001) may change or become obsolete.
  • In the definition of spectral center, it is written that: "enum": ["energy", "wavelength", "frequency"] and "type": "number" which appears to be contradictory. I suggest removing the "enum": ["energy", "wavelength", "frequency"].

Note: I've made these changes to PR #217 so that my commits could pass the new consistency checks that this change introduces. I believe this PR can be moved/combined with PR #217.

@Vidushi-GitHub
Copy link
Member Author

The changes I recommend are as follows:

  • I would exclude the "dm_gal_ne_2001_max" from the core schema, as this value is an optional post detection analysis, and the specific model (i.e. NE_2001) may change or become obsolete.
  • In the definition of spectral center, it is written that: "enum": ["energy", "wavelength", "frequency"] and "type": "number" which appears to be contradictory. I suggest removing the "enum": ["energy", "wavelength", "frequency"].

Note: I've made these changes to PR #217 so that my commits could pass the new consistency checks that this change introduces. I believe this PR can be moved/combined with PR #217.

Thank you, indeed helpful.

@Vidushi-GitHub
Copy link
Member Author

@jracusin please review it.

@Vidushi-GitHub
Copy link
Member Author

The changes I recommend are as follows:

  • I would exclude the "dm_gal_ne_2001_max" from the core schema, as this value is an optional post detection analysis, and the specific model (i.e. NE_2001) may change or become obsolete.
  • In the definition of spectral center, it is written that: "enum": ["energy", "wavelength", "frequency"] and "type": "number" which appears to be contradictory. I suggest removing the "enum": ["energy", "wavelength", "frequency"].

Note: I've made these changes to PR #217 so that my commits could pass the new consistency checks that this change introduces. I believe this PR can be moved/combined with PR #217.

Thank you, indeed helpful.

@tabbott36 please provide feedback/approve it.

Copy link
Contributor

@tabbott36 tabbott36 left a comment

Choose a reason for hiding this comment

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

Looks good to me!

"type": "string",
"enum": ["energy", "wavelength", "frequency"],
"description": "Mode of spectral measurement: high-energy or optical or radio observations, if not parsed, then default is energy",
Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps this should just be simplified into:
"Mode of spectral measurement; default is energy"

"type": "string",
"enum": ["keV", "nm", "Hz"],
"description": "Units for the spectral data, if not parsed, then default unit is keV",
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need "if not parsed"?

@@ -15,6 +15,10 @@
"maxItems": 2,
"description": "Trigger time uncertainty [s, 1-sigma], with optional asymmetric uncertainty"
},
"time_resolution": {
"type": "number",
"description": "Time resolution used for the source search [ms]"
Copy link
Member

Choose a reason for hiding this comment

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

How is this different from trigger_time_error?

Copy link
Member Author

Choose a reason for hiding this comment

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

time_error is based on instrument time resolution.

time_resolution is choice based on transient type.

Copy link
Member

Choose a reason for hiding this comment

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

Discretization is nothing more than a particular source of error. Why do we need a separate field for it?

Comment on lines +14 to +16
"items": { "type": "number" },
"maxItems": 2,
"description": "Uncertainity associated with the dispersion measure [pc/cm^3, 1-sigma], with optional asymmetric uncertainty."
Copy link
Member

Choose a reason for hiding this comment

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

If the asymmetric uncertainty is optional, can you please accept either an array or a number?

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

Successfully merging this pull request may close these issues.

4 participants