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

Jump to bottom

FRB Schema for the CHIME Telescope #217

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

FRB Schema for the CHIME Telescope #217

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
468a613
feat(gcn/notices/chime): Added some example jsons and nearly finished…
tabbott36 Nov 4, 2024
8ce8bd5
feat(chime/frb.schema.json): final touches on the FRB schema "propert…
tabbott36 Nov 4, 2024
f24d367
fix(npm): Fixed npm checks
tabbott36 Nov 22, 2024
2ed0008
4.2.0
tabbott36 Nov 22, 2024
75cd2af
Back to development
tabbott36 Nov 22, 2024
9037eda
Update gcn/notices/chime/frb.schema.json
tabbott36 Nov 22, 2024
a36a7b4
Update gcn/notices/chime/detection.example.json
tabbott36 Nov 22, 2024
7a3246a
Update gcn/notices/chime/retraction.example.json
tabbott36 Nov 22, 2024
b970e05
Update gcn/notices/chime/subsequent.example.json
tabbott36 Nov 22, 2024
bdcf2d8
Update gcn/notices/chime/update.example.json
tabbott36 Nov 22, 2024
fb8a56b
fix(Versioning): reverted version number to 4.1.0
tabbott36 Nov 22, 2024
dd64873
Merge branch 'nasa-gcn:main' into main
tabbott36 Nov 22, 2024
42053b9
fix(version): Reverted the version to 4.1.0 using npm
tabbott36 Nov 22, 2024
7279d59
fix(gal_el_model-properties): corrected galactic electron density mod…
tabbott36 Nov 22, 2024
d2de73c
fix(Data-types): Fixed incorrect data types in FRB schema
tabbott36 Nov 25, 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
24 changes: 24 additions & 0 deletions gcn/notices/chime/detection.example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"$schema": "https://gcn.nasa.gov/schema/main/gcn/notices/chime/frb.schema.json",
"alert_type": "detection",
Copy link
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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".

Copy link
Member

@Vidushi-GitHub Vidushi-GitHub Nov 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

@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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok, sounds good to me. Thanks, Vidushi!

"trigger_time": "2024-09-18T07:19:10.765268Z",
"trigger_time_error": 0.007864319719374001,
"id": "427325191",
tabbott36 marked this conversation as resolved.
Show resolved Hide resolved
"snr": 12.698559761047363,
"ra": 346.77850859547,
"dec": 12.632485229956252,
"ra_dec_error": [0.503806986334273, 0.598921231135782, 0],
"dm": 279.422607421875,
"dm_error": 0.40437427163124,
"dm_gal_ne_2001_max": 37.78909399600771,
"dm_gal_ymw_2016_max": 29.94072212814185,
"trigger_time_inf_freq": "2024-09-18 07:19:03.518831+00:00",
"trigger_time_inf_freq_error": 0.013108099559195993,
"importance": 0.9871308604784662,
"sampling_time": 0.983,
"bandwidth": 400,
"centre_frequency": 600,
"npol": 2,
"tsys": 50,
"description": "This alert was generated automatically by the CHIME/FRB Real-time Search Pipeline. Please direct comments, questions, and concerns to Thomas Abbott at [email protected]."
}
78 changes: 78 additions & 0 deletions gcn/notices/chime/frb.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
{
"$id": "https://gcn.nasa.gov/schema/main/gcn/notices/chime/frb.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "CHIME/FRB Alert",
"description": "Fast radio burst alert from the Canadian Hydrogen Intensity Mapping Experiment.",
"type": "object",
"allOf": [
{ "$ref": "../core/Alert.schema.json" },
{ "$ref": "../core/Reporter.schema.json" },
{ "$ref": "../core/Event.schema.json" },
{ "$ref": "../core/DateTime.schema.json" },
{ "$ref": "../core/Localization.schema.json" }
],
"properties": {
"known_source": {
"type": "string",
"description": "Transient Name Server name of the known source (if a repeating FRB source)"
},
"snr": {
"type": "number",
"description": "Signal-to-noise ratio of the burst"
},
"dm": {
"type": "number",
"description": "Dispersion measure of the burst [pc/cm^3]"
},
"dm_error": {
"type": "number",
"description": "Error on the dispersion measure [pc/cm^3]"
},
"dm_gal_ne_2001_max": { "type": "string", "description": "." },
"dm_gal_ymw_2016_max": { "type": "string", "description": "." },
"trigger_time_error": {
"type": "number",
"description": "Error on the trigger time [s]"
},
"trigger_time_inf_freq": {
"type": "string",
"description": "Time of the trigger at infinite frequency [ISO 8601]"
},
"trigger_time_inf_freq_error": {
"type": "number",
"description": "Error on the trigger time at infinite frequency [s]"
},
"importance": {
"type": "string",
"description": "A machine learning score from 0-1 separating RFI (0) from an astrophysical signal (1)"
},
"probability": {
"type": "string",
"description": "A score of known source association probability from poorly associated (0) to confidently associated (1)"
},
"sampling_time": {
"type": "string",
"description": "The time resolution of the real-time FRB search."
},
"bandwidth": {
"type": "string",
"description": "The bandwidth of the real-time FRB search."
},
"centre_frequency": {
"type": "string",
"description": "The centre frequency of the real-time FRB search."
},
"npol": {
"type": "string",
"description": "The number of polarizations of the real-time FRB search."
},
"tsys": {
"type": "string",
"description": "The system temperature of the real-time FRB search."
},
"update_message": {
"type": "string",
"description": "Message to be included in an update alert"
}
}
}
8 changes: 8 additions & 0 deletions gcn/notices/chime/retraction.example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"$schema": "https://gcn.nasa.gov/schema/main/gcn/notices/chime/frb.schema.json",
"alert_type": "retraction",
"id": "FRB 20231013B",
tabbott36 marked this conversation as resolved.
Show resolved Hide resolved
"trigger_time": "2024-09-18T07:19:10.765268Z",
"trigger_time_error": 0.007864319719374001,
"description": "This alert was generated automatically by human-issued retraction. Please direct comments, questions, and concerns to Thomas Abbott at [email protected]."
}
26 changes: 26 additions & 0 deletions gcn/notices/chime/subsequent.example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"$schema": "https://gcn.nasa.gov/schema/main/gcn/notices/chime/frb.schema.json",
"alert_type": "subsequent",
Copy link
Contributor

Choose a reason for hiding this comment

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

This is also not a valid value for alert_type, would update make sense here?

"known_source": "FRB 20231013B",
"trigger_time": "2024-09-18T07:19:10.765268Z",
"trigger_time_error": 0.007864319719374001,
"id": "FRB 20240918A",
tabbott36 marked this conversation as resolved.
Show resolved Hide resolved
"snr": 12.698559761047363,
"ra": 346.77850859547,
"dec": 12.632485229956252,
"ra_dec_error": [0.503806986334273, 0.598921231135782, 0],
"dm": 279.422607421875,
"dm_error": 0.40437427163124,
"dm_gal_ne_2001_max": 37.78909399600771,
"dm_gal_ymw_2016_max": 29.94072212814185,
"trigger_time_inf_freq": "2024-09-18 07:19:03.518831+00:00",
"trigger_time_inf_freq_error": 0.013108099559195993,
"importance": 0.9871308604784662,
"probability": 0.932,
"sampling_time": 0.983,
"bandwidth": 400,
"centre_frequency": 600,
"npol": 2,
"tsys": 50,
"description": "This alert was generated automatically by the CHIME/FRB Real-time Search Pipeline. Please direct comments, questions, and concerns to Thomas Abbott at [email protected]."
}
9 changes: 9 additions & 0 deletions gcn/notices/chime/update.example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"$schema": "https://gcn.nasa.gov/schema/main/gcn/notices/chime/frb.schema.json",
"alert_type": "update",
"id": "FRB 20231013B",
tabbott36 marked this conversation as resolved.
Show resolved Hide resolved
"trigger_time": "2024-09-18T07:19:10.765268Z",
"trigger_time_error": 0.007864319719374001,
"update_message": "The dispersion measure of FRB 20231013B has been updated to 221.19271850585938 +/- 0.40437427163124 pc/cm^3.",
"description": "This alert was generated automatically by human-issued retraction. Please direct comments, questions, and concerns to Thomas Abbott at [email protected]."
}
11 changes: 6 additions & 5 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@nasa-gcn/schema",
"description": "Unified JSON Schema for multi-messenger and high-energy astronomy alerts",
"version": "4.1.0",
"version": "4.2.0",
"repository": {
"type": "git",
"url": "github:nasa-gcn/gcn-schema"
Expand Down
Loading