From 6422f8df5929309dd2ce0a39106e00d6106520a6 Mon Sep 17 00:00:00 2001 From: tabbott36 Date: Mon, 4 Nov 2024 17:45:57 -0500 Subject: [PATCH 1/3] feat(gcn/notices/chime): Added some example jsons and nearly finished 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 Update gcn/notices/chime/detection.example.json Co-authored-by: Dakota Dutko Update gcn/notices/chime/retraction.example.json Co-authored-by: Dakota Dutko Update gcn/notices/chime/subsequent.example.json Co-authored-by: Dakota Dutko Update gcn/notices/chime/update.example.json Co-authored-by: Dakota Dutko 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 --- gcn/notices/chime/frb.detection.example.json | 24 +++++ gcn/notices/chime/frb.retraction.example.json | 8 ++ gcn/notices/chime/frb.schema.json | 88 +++++++++++++++++++ gcn/notices/chime/frb.subsequent.example.json | 26 ++++++ gcn/notices/chime/frb.update.example.json | 9 ++ package-lock.json | 12 +-- package.json | 2 +- 7 files changed, 163 insertions(+), 6 deletions(-) create mode 100644 gcn/notices/chime/frb.detection.example.json create mode 100644 gcn/notices/chime/frb.retraction.example.json create mode 100644 gcn/notices/chime/frb.schema.json create mode 100644 gcn/notices/chime/frb.subsequent.example.json create mode 100644 gcn/notices/chime/frb.update.example.json diff --git a/gcn/notices/chime/frb.detection.example.json b/gcn/notices/chime/frb.detection.example.json new file mode 100644 index 00000000..2b0f490b --- /dev/null +++ b/gcn/notices/chime/frb.detection.example.json @@ -0,0 +1,24 @@ +{ + "$schema": "https://gcn.nasa.gov/schema/main/gcn/notices/chime/frb.schema.json", + "alert_kind": "detection", + "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, + "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 thomas.abbott@mail.mcgill.ca." +} diff --git a/gcn/notices/chime/frb.retraction.example.json b/gcn/notices/chime/frb.retraction.example.json new file mode 100644 index 00000000..b3979bdc --- /dev/null +++ b/gcn/notices/chime/frb.retraction.example.json @@ -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 thomas.abbott@mail.mcgill.ca." +} diff --git a/gcn/notices/chime/frb.schema.json b/gcn/notices/chime/frb.schema.json new file mode 100644 index 00000000..2070c136 --- /dev/null +++ b/gcn/notices/chime/frb.schema.json @@ -0,0 +1,88 @@ +{ + "$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": { + "alert_kind": { + "type": "string", + "description": "The kind of alert (detection or subsequent). Similar meaning to alert_type" + }, + "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": "number", + "description": "Estimated contribution to the dispersion measure from the Galaxy using the NE2001 model." + }, + "dm_gal_ymw_2016_max": { + "type": "number", + "description": "Estimated contribution to the dispersion measure from the Galaxy using the YMW2016 model." + }, + "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": "number", + "description": "A machine learning score from 0-1 separating RFI (0) from an astrophysical signal (1)" + }, + "probability": { + "type": "number", + "description": "A score of known source association probability from poorly associated (0) to confidently associated (1)" + }, + "sampling_time": { + "type": "number", + "description": "The time resolution of the real-time FRB search." + }, + "bandwidth": { + "type": "number", + "description": "The bandwidth of the real-time FRB search." + }, + "centre_frequency": { + "type": "number", + "description": "The centre frequency of the real-time FRB search." + }, + "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." + }, + "update_message": { + "type": "string", + "description": "Message to be included in an update alert" + } + } +} diff --git a/gcn/notices/chime/frb.subsequent.example.json b/gcn/notices/chime/frb.subsequent.example.json new file mode 100644 index 00000000..4bb54764 --- /dev/null +++ b/gcn/notices/chime/frb.subsequent.example.json @@ -0,0 +1,26 @@ +{ + "$schema": "https://gcn.nasa.gov/schema/main/gcn/notices/chime/frb.schema.json", + "alert_kind": "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, + "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 thomas.abbott@mail.mcgill.ca." +} diff --git a/gcn/notices/chime/frb.update.example.json b/gcn/notices/chime/frb.update.example.json new file mode 100644 index 00000000..9df10b54 --- /dev/null +++ b/gcn/notices/chime/frb.update.example.json @@ -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 thomas.abbott@mail.mcgill.ca." +} diff --git a/package-lock.json b/package-lock.json index 570b27b7..a6402929 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@nasa-gcn/schema", - "version": "4.2.0", + "version": "4.1.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@nasa-gcn/schema", - "version": "4.2.0", + "version": "4.1.0", "devDependencies": { "@nasa-gcn/eslint-config-gitignore": "^0.0.2", "ajv": "^8.17.1", @@ -298,6 +298,7 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.17.1.tgz", "integrity": "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==", "dev": true, + "license": "MIT", "dependencies": { "fast-deep-equal": "^3.1.3", "fast-uri": "^3.0.1", @@ -508,10 +509,11 @@ "license": "MIT" }, "node_modules/cross-spawn": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", - "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz", + "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==", "dev": true, + "license": "MIT", "dependencies": { "path-key": "^3.1.0", "shebang-command": "^2.0.0", diff --git a/package.json b/package.json index 13326c47..ba1a6fa0 100644 --- a/package.json +++ b/package.json @@ -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" From b54913e549d773ea752d7bfad9d99d0f0dadb6ca Mon Sep 17 00:00:00 2001 From: tabbott36 Date: Tue, 11 Feb 2025 12:52:20 -0500 Subject: [PATCH 2/3] fix(frb.schema.json): Made changes to address suggestions from PR #217 --- gcn/notices/chime/frb.schema.json | 28 ++++++++-------------------- 1 file changed, 8 insertions(+), 20 deletions(-) diff --git a/gcn/notices/chime/frb.schema.json b/gcn/notices/chime/frb.schema.json index 2070c136..4aff3e63 100644 --- a/gcn/notices/chime/frb.schema.json +++ b/gcn/notices/chime/frb.schema.json @@ -12,17 +12,13 @@ { "$ref": "../core/Localization.schema.json" } ], "properties": { - "alert_kind": { - "type": "string", - "description": "The kind of alert (detection or subsequent). Similar meaning to alert_type" - }, "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" + "description": "Signal-to-noise ratio of the burst [dimensionless]" }, "dm": { "type": "number", @@ -34,15 +30,11 @@ }, "dm_gal_ne_2001_max": { "type": "number", - "description": "Estimated contribution to the dispersion measure from the Galaxy using the NE2001 model." + "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." - }, - "trigger_time_error": { - "type": "number", - "description": "Error on the trigger time [s]" + "description": "Estimated contribution to the dispersion measure from the Galaxy using the YMW2016 model [pc/cm^3]" }, "trigger_time_inf_freq": { "type": "string", @@ -56,29 +48,25 @@ "type": "number", "description": "A machine learning score from 0-1 separating RFI (0) from an astrophysical signal (1)" }, - "probability": { + "association_probability": { "type": "number", "description": "A score of known source association probability from poorly associated (0) to confidently associated (1)" }, "sampling_time": { "type": "number", - "description": "The time resolution of the real-time FRB search." - }, - "bandwidth": { - "type": "number", - "description": "The bandwidth of the real-time FRB search." + "description": "The time resolution of the real-time FRB search [ms]" }, "centre_frequency": { "type": "number", - "description": "The centre frequency of the real-time FRB search." + "description": "The centre frequency of the real-time FRB search [MHz]" }, "npol": { "type": "number", - "description": "The number of polarizations of the real-time FRB search." + "description": "The number of polarizations of the real-time FRB search" }, "tsys": { "type": "number", - "description": "The system temperature of the real-time FRB search." + "description": "The system temperature of the real-time FRB search [K]" }, "update_message": { "type": "string", From 26b7ff01fa9f3702dc06fb22167c7b30a70c4c43 Mon Sep 17 00:00:00 2001 From: tabbott36 Date: Tue, 11 Feb 2025 14:14:39 -0500 Subject: [PATCH 3/3] fix(notices/chime): Made changes to frb.schema.json based on suggestions in PR #217 and updated the frb example JSONs Also made modifications to the definitions of spectrum and spectral_center in the Reporter.schema.json --- gcn/notices/chime/frb.detection.example.json | 7 +++--- gcn/notices/chime/frb.retraction.example.json | 2 +- gcn/notices/chime/frb.schema.json | 18 +++------------ gcn/notices/chime/frb.subsequent.example.json | 9 ++++---- gcn/notices/chime/frb.update.example.json | 2 +- gcn/notices/core/DateTime.schema.json | 4 ++++ .../core/DispersionMeasure.schema.json | 23 +++++++++++++++++++ gcn/notices/core/Reporter.schema.json | 4 ++++ 8 files changed, 45 insertions(+), 24 deletions(-) create mode 100644 gcn/notices/core/DispersionMeasure.schema.json diff --git a/gcn/notices/chime/frb.detection.example.json b/gcn/notices/chime/frb.detection.example.json index 2b0f490b..a54d66a3 100644 --- a/gcn/notices/chime/frb.detection.example.json +++ b/gcn/notices/chime/frb.detection.example.json @@ -1,8 +1,8 @@ { "$schema": "https://gcn.nasa.gov/schema/main/gcn/notices/chime/frb.schema.json", - "alert_kind": "detection", + "alert_type": "initial", "trigger_time": "2024-09-18T07:19:10.765268Z", - "trigger_time_error": 0.007864319719374001, + "trigger_time_error": [0.007864319719374001], "id": ["427325191"], "snr": 12.698559761047363, "ra": 346.77850859547, @@ -16,8 +16,9 @@ "trigger_time_inf_freq_error": 0.013108099559195993, "importance": 0.9871308604784662, "sampling_time": 0.983, + "spectrum": "wavelength", + "spectral_center": 600, "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 thomas.abbott@mail.mcgill.ca." diff --git a/gcn/notices/chime/frb.retraction.example.json b/gcn/notices/chime/frb.retraction.example.json index b3979bdc..ceb66037 100644 --- a/gcn/notices/chime/frb.retraction.example.json +++ b/gcn/notices/chime/frb.retraction.example.json @@ -3,6 +3,6 @@ "alert_type": "retraction", "id": ["FRB 20231013B"], "trigger_time": "2024-09-18T07:19:10.765268Z", - "trigger_time_error": 0.007864319719374001, + "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 thomas.abbott@mail.mcgill.ca." } diff --git a/gcn/notices/chime/frb.schema.json b/gcn/notices/chime/frb.schema.json index 4aff3e63..0dfd4051 100644 --- a/gcn/notices/chime/frb.schema.json +++ b/gcn/notices/chime/frb.schema.json @@ -20,14 +20,6 @@ "type": "number", "description": "Signal-to-noise ratio of the burst [dimensionless]" }, - "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": "number", "description": "Estimated contribution to the dispersion measure from the Galaxy using the NE2001 model [pc/cm^3]" @@ -46,19 +38,15 @@ }, "importance": { "type": "number", - "description": "A machine learning score from 0-1 separating RFI (0) from an astrophysical signal (1)" + "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)" }, - "sampling_time": { - "type": "number", - "description": "The time resolution of the real-time FRB search [ms]" - }, - "centre_frequency": { + "bandwidth": { "type": "number", - "description": "The centre frequency of the real-time FRB search [MHz]" + "description": "The bandwidth of the real-time FRB search [MHz]" }, "npol": { "type": "number", diff --git a/gcn/notices/chime/frb.subsequent.example.json b/gcn/notices/chime/frb.subsequent.example.json index 4bb54764..012f459b 100644 --- a/gcn/notices/chime/frb.subsequent.example.json +++ b/gcn/notices/chime/frb.subsequent.example.json @@ -1,9 +1,9 @@ { "$schema": "https://gcn.nasa.gov/schema/main/gcn/notices/chime/frb.schema.json", - "alert_kind": "subsequent", + "alert_type": "subsequent", "known_source": "FRB 20231013B", "trigger_time": "2024-09-18T07:19:10.765268Z", - "trigger_time_error": 0.007864319719374001, + "trigger_time_error": [0.007864319719374001], "id": ["FRB 20240918A"], "snr": 12.698559761047363, "ra": 346.77850859547, @@ -16,10 +16,11 @@ "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, + "association_probability": 0.932, "sampling_time": 0.983, + "spectrum": "wavelength", + "spectral_center": 600, "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 thomas.abbott@mail.mcgill.ca." diff --git a/gcn/notices/chime/frb.update.example.json b/gcn/notices/chime/frb.update.example.json index 9df10b54..ee982b0a 100644 --- a/gcn/notices/chime/frb.update.example.json +++ b/gcn/notices/chime/frb.update.example.json @@ -3,7 +3,7 @@ "alert_type": "update", "id": ["FRB 20231013B"], "trigger_time": "2024-09-18T07:19:10.765268Z", - "trigger_time_error": 0.007864319719374001, + "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 thomas.abbott@mail.mcgill.ca." } diff --git a/gcn/notices/core/DateTime.schema.json b/gcn/notices/core/DateTime.schema.json index d816a8c0..f0cb23e6 100644 --- a/gcn/notices/core/DateTime.schema.json +++ b/gcn/notices/core/DateTime.schema.json @@ -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]" diff --git a/gcn/notices/core/DispersionMeasure.schema.json b/gcn/notices/core/DispersionMeasure.schema.json new file mode 100644 index 00000000..34ac745e --- /dev/null +++ b/gcn/notices/core/DispersionMeasure.schema.json @@ -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." + } + } +} diff --git a/gcn/notices/core/Reporter.schema.json b/gcn/notices/core/Reporter.schema.json index 296cbbd8..327cd763 100644 --- a/gcn/notices/core/Reporter.schema.json +++ b/gcn/notices/core/Reporter.schema.json @@ -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",