FRB Schema for the CHIME Telescope #217

tabbott36 · 2024-11-05T00:40:36Z

Description

Added the FRB schema for the Canadian Hydrogen Intensity Mapping Experiment (CHIME). Also added an example json for each alert type (detection, subsequent, retraction, and update).

Questions for GCN Team

I tentatively used the "alert_type" parameter (from the Alert schema), however, there are 4 alert types for CHIME/FRB, so if this is not the correct decision, I can add a property to the FRB schema.
Can I use a Transient Name Server name for the "id" parameter in the Event schema?

Testing

I modelled the schema after other observatories' schemas but am open to suggestions regarding testing.

tabbott36 · 2024-11-05T19:27:46Z

Seeing many failed checks, is there action I should take on this? Cheers!

lpsinger · 2024-11-05T19:48:32Z

Seeing many failed checks, is there action I should take on this? Cheers!

Yes, there were some missing contributing instructions to configure pre-commit hooks. See #218.

Vidushi-GitHub · 2024-11-18T21:40:49Z

@tabbott36 A gentle reminder. Please validate it and run prettier, before we start reviewing it.

gcn/notices/chime/frb.schema.json

dakota002 · 2024-11-22T20:19:59Z

Hi @tabbott36, I see from your commits that you ran the version command. You don't need to do so, as we will take care of this once your updates are merged into main. Can you please revert the changes in your repo that update fields from 4.1.0 to 4.2.0?

Also, I would suggest updating the names of your example files, for example: from gcn/notices/chime/subsequent.example.json to gcn/notices/chime/frb.subsequent.example.json. The schema name (frb) as a prefix will allow our schema viewer to properly recognize which schema it is an example for

tabbott36 · 2024-11-22T20:22:32Z

Hi @dakota002, thanks for the help! Yes, I will revert the versioning and rename the example files.

gcn/notices/chime/detection.example.json

dakota002 · 2024-11-22T20:25:16Z

gcn/notices/chime/detection.example.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://gcn.nasa.gov/schema/main/gcn/notices/chime/frb.schema.json",
+  "alert_type": "detection",


This is not a valid option, the allowed values are:

"allowedValues": [ "initial", "update", "retraction" ]

These are defined here https://github.com/nasa-gcn/gcn-schema/blob/main/gcn/notices/core/Alert.schema.json

Thanks for the review, I was hoping to be consistent with existing CHIME/FRB Alert types (see issue 198), but if this is too much trouble, "initial" can replace what we currently call "detection" and "subsquent".

@tabbott36 we are working on adding subsequent (see #221).
However, initial will likely remain the same, else we need to take votes from the missions that are already using it.

For validation, as detection and subsequent please add a new property, current alert_type is not consistent.

Ok, sounds good to me. Thanks, Vidushi!

gcn/notices/chime/retraction.example.json

gcn/notices/chime/subsequent.example.json

gcn/notices/chime/update.example.json

dakota002 · 2024-11-22T20:29:34Z

Hi @dakota002, thanks for the help! Yes, I will revert the versioning and rename the example files.

No problem! I have suggested a few other changes that should also fix your validation checks

dakota002 · 2024-12-04T15:03:32Z

@tabbott36 This looks good to me now, can you please squash your commits down to 1? If you have questions on this I can assist you

… the frb schema feat(chime/frb.schema.json): final touches on the FRB schema "properties" fix(npm): Fixed npm checks 4.2.0 Back to development Update gcn/notices/chime/frb.schema.json Co-authored-by: Dakota Dutko <[email protected]> Update gcn/notices/chime/detection.example.json Co-authored-by: Dakota Dutko <[email protected]> Update gcn/notices/chime/retraction.example.json Co-authored-by: Dakota Dutko <[email protected]> Update gcn/notices/chime/subsequent.example.json Co-authored-by: Dakota Dutko <[email protected]> Update gcn/notices/chime/update.example.json Co-authored-by: Dakota Dutko <[email protected]> fix(Versioning): reverted version number to 4.1.0 fix(version): Reverted the version to 4.1.0 using npm fix(gal_el_model-properties): corrected galactic electron density model properties fix(Data-types): Fixed incorrect data types in FRB schema

tabbott36 · 2024-12-05T18:44:17Z

Sure thing! I believe it's been squashed to one commit now. Thanks!

dakota002 · 2024-12-10T16:14:56Z

@Vidushi-GitHub @jracusin is this good now?

Vidushi-GitHub · 2024-12-10T18:46:07Z

@Vidushi-GitHub @jracusin is this good now?

We still are working on it.

jracusin · 2024-12-10T19:14:56Z

gcn/notices/chime/frb.schema.json

+      "type": "number",
+      "description": "A machine learning score from 0-1 separating RFI (0) from an astrophysical signal (1)"
+    },
+    "probability": {


Suggested change

"probability": {

"association_probability": {

jracusin · 2024-12-10T19:16:32Z

gcn/notices/chime/frb.schema.json

+    },
+    "sampling_time": {
+      "type": "number",
+      "description": "The time resolution of the real-time FRB search."


in what units?

Thanks for the review, I will correct this to say milliseconds.

Vidushi-GitHub · 2024-12-12T20:15:05Z

gcn/notices/chime/frb.schema.json

+  "properties": {
+    "alert_kind": {
+      "type": "string",
+      "description": "The kind of alert (detection or subsequent). Similar meaning to alert_type"


This is updated in the core schema, please utilize it.

Vidushi-GitHub · 2024-12-12T20:22:29Z

gcn/notices/chime/frb.schema.json

+    },
+    "snr": {
+      "type": "number",
+      "description": "Signal-to-noise ratio of the burst"


Is this different from rate_snr in core/Statistics.schema.json?

Suggested change

"description": "Signal-to-noise ratio of the burst"

"description": "Signal-to-noise ratio of the burst [dimensionless]"

Vidushi-GitHub · 2024-12-12T20:24:01Z

gcn/notices/chime/frb.schema.json

+      "type": "number",
+      "description": "Estimated contribution to the dispersion measure from the Galaxy using the YMW2016 model."
+    },
+    "trigger_time_error": {


This property has been added in the core/DateTime.schema.json, please utilize it.

Vidushi-GitHub · 2024-12-12T20:28:38Z

gcn/notices/chime/frb.schema.json

+      "type": "number",
+      "description": "The time resolution of the real-time FRB search."
+    },
+    "bandwidth": {


Do you think it's same as spectrum property in core/Reporter.schema.json?

Ah, yes, it looks like the same thing. "bandwidth" here is the frequencies over which the instrument observes, so I think it alligns well with the "spectrum" property. I'll update it! Thanks

Vidushi-GitHub · 2024-12-13T03:06:36Z

Hi @tabbott36, we have added a few properties in core schema motivated from your CHIME/FRB schema, thanks!
Please provide your valuable feedback for #226. Please comment on what are usually common properties among FRBs, that should be include in the core.

Vidushi-GitHub requested review from Vidushi-GitHub and jracusin November 5, 2024 15:27

dakota002 mentioned this pull request Nov 5, 2024

CHIME JSON Notices nasa-gcn/gcn.nasa.gov#2626

Open

5 tasks

dakota002 requested changes Nov 22, 2024

View reviewed changes

gcn/notices/chime/frb.schema.json Outdated Show resolved Hide resolved

dakota002 requested changes Nov 22, 2024

View reviewed changes

tabbott36 force-pushed the main branch from d2de73c to 6422f8d Compare December 5, 2024 18:41

dakota002 self-requested a review December 10, 2024 16:14

jracusin reviewed Dec 10, 2024

View reviewed changes

Vidushi-GitHub reviewed Dec 12, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FRB Schema for the CHIME Telescope #217

FRB Schema for the CHIME Telescope #217

tabbott36 commented Nov 5, 2024

tabbott36 commented Nov 5, 2024

lpsinger commented Nov 5, 2024

Vidushi-GitHub commented Nov 18, 2024 •

edited

Loading

dakota002 commented Nov 22, 2024

tabbott36 commented Nov 22, 2024

dakota002 Nov 22, 2024

tabbott36 Nov 22, 2024

Vidushi-GitHub Nov 22, 2024 •

edited

Loading

tabbott36 Nov 22, 2024

dakota002 commented Nov 22, 2024

dakota002 commented Dec 4, 2024

tabbott36 commented Dec 5, 2024

dakota002 commented Dec 10, 2024

Vidushi-GitHub commented Dec 10, 2024

jracusin Dec 10, 2024

jracusin Dec 10, 2024

tabbott36 Dec 10, 2024

Vidushi-GitHub Dec 12, 2024 •

edited

Loading

Vidushi-GitHub Dec 12, 2024

Vidushi-GitHub Dec 12, 2024

Vidushi-GitHub Dec 12, 2024 •

edited

Loading

tabbott36 Dec 12, 2024

Vidushi-GitHub commented Dec 13, 2024

	"description": "Signal-to-noise ratio of the burst"
	"description": "Signal-to-noise ratio of the burst [dimensionless]"

FRB Schema for the CHIME Telescope #217

Are you sure you want to change the base?

FRB Schema for the CHIME Telescope #217

Conversation

tabbott36 commented Nov 5, 2024

Description

Questions for GCN Team

Testing

tabbott36 commented Nov 5, 2024

lpsinger commented Nov 5, 2024

Vidushi-GitHub commented Nov 18, 2024 • edited Loading

dakota002 commented Nov 22, 2024

tabbott36 commented Nov 22, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Vidushi-GitHub Nov 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dakota002 commented Nov 22, 2024

dakota002 commented Dec 4, 2024

tabbott36 commented Dec 5, 2024

dakota002 commented Dec 10, 2024

Vidushi-GitHub commented Dec 10, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Vidushi-GitHub Dec 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Vidushi-GitHub Dec 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Vidushi-GitHub commented Dec 13, 2024

Vidushi-GitHub commented Nov 18, 2024 •

edited

Loading

Vidushi-GitHub Nov 22, 2024 •

edited

Loading

Vidushi-GitHub Dec 12, 2024 •

edited

Loading

Vidushi-GitHub Dec 12, 2024 •

edited

Loading