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

FRB Schema for the CHIME Telescope #217

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 25 additions & 0 deletions gcn/notices/chime/frb.detection.example.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"$schema": "https://gcn.nasa.gov/schema/main/gcn/notices/chime/frb.schema.json",
"alert_type": "initial",
"trigger_time": "2024-09-18T07:19:10.765268Z",
"trigger_time_error": [0.007864319719374001],
"id": ["427325191"],
"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,
"spectrum": "wavelength",
"spectral_center": 600,
"bandwidth": 400,
"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]."
}
8 changes: 8 additions & 0 deletions gcn/notices/chime/frb.retraction.example.json
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"],
"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]."
}
64 changes: 64 additions & 0 deletions gcn/notices/chime/frb.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
{
"$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 [dimensionless]"
},
"dm_gal_ne_2001_max": {
"type": "number",
"description": "Estimated contribution to the dispersion measure from the Galaxy using the NE2001 model [pc/cm^3]"
},
"dm_gal_ymw_2016_max": {
"type": "number",
"description": "Estimated contribution to the dispersion measure from the Galaxy using the YMW2016 model [pc/cm^3]"
},
"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": "number",
"description": "A machine learning score separating RFI (0) from an astrophysical signal (1)"
},
"association_probability": {
"type": "number",
"description": "A score of known source association probability from poorly associated (0) to confidently associated (1)"
},
"bandwidth": {
Copy link
Member

@Vidushi-GitHub Vidushi-GitHub Dec 12, 2024

Choose a reason for hiding this comment

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

Do you think it's same as spectrum property in core/Reporter.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.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Looking back at this, I am noticing that "spectrum" is one of ["energy", "wavelength", "frequency"], which I originially misunderstood. Since bandwidth is a number describing the observatory's observing band, I've reintroduced it into the FRB schema.

"type": "number",
"description": "The bandwidth of the real-time FRB search [MHz]"
},
"npol": {
"type": "number",
"description": "The number of polarizations of the real-time FRB search"
},
"tsys": {
"type": "number",
"description": "The system temperature of the real-time FRB search [K]"
},
"update_message": {
"type": "string",
"description": "Message to be included in an update alert"
}
}
}
27 changes: 27 additions & 0 deletions gcn/notices/chime/frb.subsequent.example.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"$schema": "https://gcn.nasa.gov/schema/main/gcn/notices/chime/frb.schema.json",
"alert_type": "subsequent",
"known_source": "FRB 20231013B",
"trigger_time": "2024-09-18T07:19:10.765268Z",
"trigger_time_error": [0.007864319719374001],
"id": ["FRB 20240918A"],
"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,
"association_probability": 0.932,
"sampling_time": 0.983,
"spectrum": "wavelength",
"spectral_center": 600,
"bandwidth": 400,
"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/frb.update.example.json
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"],
"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]."
}
4 changes: 4 additions & 0 deletions gcn/notices/core/DateTime.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -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]"
},
"observation_start": {
"type": "string",
"description": "Start time of the observation [ISO 8601]"
Expand Down
23 changes: 23 additions & 0 deletions gcn/notices/core/DispersionMeasure.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"$id": "https://gcn.nasa.gov/schema/main/gcn/notices/core/DispersionMeasure.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"title": "Schema for Radio Transients Observables",
"description": "Dispersion Measure schema used for radio transients",
"properties": {
"dm": {
"type": "number",
"description": "Dispersion measure (DM) of the burst [pc/cm^3], representing the integrated column density of free electrons along the line of sight."
},
"dm_error": {
"type": "array",
"items": { "type": "number" },
"maxItems": 2,
"description": "Uncertainity associated with the dispersion measure [pc/cm^3, 1-sigma], with optional asymmetric uncertainty."
},
"dm_gal_ne_2001_max": {
"type": "number",
"description": "Estimated contribution to the dispersion measure [pc/cm^3] from the Galaxy using the NE2001 model."
}
}
}
4 changes: 4 additions & 0 deletions gcn/notices/core/Reporter.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@
"type": "string",
"default": "energy"
},
"spectral_center": {
"description": "Central value of the observing band, should have same units as spectrum",
"type": "number"
},
"units": {
"enum": ["keV", "nm", "Hz"],
"description": "Units of band range, if not parsed, then default energy is keV",
Expand Down
12 changes: 7 additions & 5 deletions package-lock.json

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
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.2.0",
"version": "4.1.0",
"repository": {
"type": "git",
"url": "github:nasa-gcn/gcn-schema"
Expand Down