subdir

gcn/notices/fermi/gbm/strict/FermiGBMAlert.schema.json

@@ -0,0 +1,171 @@
+{
+  "$id": "https://gcn.nasa.gov/schema/main/gcn/notices/fermi/gbm/strict/FermiGBMAlert.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "GCN Schema for Fermi GBM Alert Notices",
+  "description": "This schema is a stricter version of https://gcn.nasa.gov/schema/main/gcn/notices/core/AdditionalInfo.schema.json. The GCN classic notice numeric type is 110.",
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "const": "https://gcn.nasa.gov/schema/main/gcn/notices/fermi/gbm/FermiGBMAlert.schema.json",
+      "description": "Required by GCN"
+    },
+    "additional_info": {
+      "type": "string",
+      "default": null,
+      "description": "Free text comments about the event and the notice."
+    },
+    "alert_datetime": {
+      "type": "string",
+      "description": "Date and time of notice creation [UTC, ISO 8601], ex YYYY-MM-DDTHH:MM:SS.ssssssZ"
+    },
+    "alert_tense": {
+      "enum": [
+        "current",
+        "archival",
+        "planned",
+        "injection",
+        "commanded",
+        "test"
+      ],
+      "default": "current",
+      "description": "Indication of whether this alert refers to a recent observation (current), re-analysis of archival data (archival), a planned observation in the future (planned), a signal injection (injection), commanded trigger (commanded) or a test trigger (test)."
+    },
+    "alert_type": {
+      "enum": ["initial", "update", "retraction"],
+      "default": "initial",
+      "description": "Indication of alert sequence if multiple of same type sent"
+    },
+    "data_archive_page": {
+      "type": "string",
+      "description": "URL of archived data files"
+    },
+    "detectors_status": {
+      "type": "array",
+      "items": {
+        "enum": ["on", "off", "triggered"]
+      },
+      "minItems": 14,
+      "maxItems": 14,
+      "description": "Triggered detectors"
+    },
+    "event_name": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "Name of the event, for example GRB170817A"
+    },
+    "hitl": {
+      "type": "boolean",
+      "default": false,
+      "description": "Human-in-the-loop. A human made an input during the processing of this notice, if true"
+    },
+    "id": {
+      "type": "array",
+      "items": {
+        "oneOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "number"
+          }
+        ]
+      },
+      "description": "Instrument-specific trigger ID, for example: 745121685, bn240812094"
+    },
+    "instrument": {
+      "const": "GBM",
+      "default": "GBM",
+      "description": "Name of the instrument reporting the event"
+    },
+    "latitude": {
+      "type": "number",
+      "description": "Geocentric latitude [deg]"
+    },
+    "light_curve_url": {
+      "type": "string",
+      "description": "URL of the quicklook light curve plot"
+    },
+    "longitude": {
+      "type": "number",
+      "description": "Geocentric longitude [deg]"
+    },
+    "messenger": {
+      "const": "EM",
+      "default": "EM",
+      "description": "Messenger of report; EM, GW or Neutrino"
+    },
+    "mission": {
+      "const": "Fermi",
+      "default": "Fermi",
+      "description": "Name of Mission or Telescope reporting the event"
+    },
+    "notice_type": {
+      "const": "FERMI_GBM_ALERT",
+      "description": "Notice title"
+    },
+    "rate_duration": {
+      "type": "number",
+      "description": "Duration in seconds of the ime interval used in the signal to noise ratio calculation"
+    },
+    "rate_energy_range": {
+      "type": "array",
+      "items": {
+        "type": "number"
+      },
+      "minItems": 2,
+      "maxItems": 2,
+      "description": "Energy bounds in keV used in the signal to noise ratio calculation"
+    },
+    "rate_snr": {
+      "type": "number",
+      "description": "Signal to noise ratio"
+    },
+    "record_number": {
+      "type": "number",
+      "description": "Incremental number for notices related to the same trigger (ex: 1, 2, 3)"
+    },
+    "spectrum": {
+      "const": "energy",
+      "default": "energy",
+      "description": "high-energy or optical or radio observations, if not parsed, then default band is energy"
+    },
+    "trigger_algorithm_number": {
+      "type": "number",
+      "description": "The criterion number that caused the flight software to trigger. Not to be confused with flight software or any other version number."
+    },
+    "trigger_time": {
+      "type": "string",
+      "description": "Time of the trigger [ISO 8601], ex YYYY-MM-DDTHH:MM:SS.ssssssZ"
+    },
+    "trigger_type": {
+      "const": "rate",
+      "default": "rate",
+      "description": "Type of trigger algorithm used to identify the transient event."
+    },
+    "units": {
+      "const": "keV",
+      "default": "keV",
+      "description": "Units of band range, if not parsed, then default energy is keV"
+    }
+  },
+  "required": [
+    "alert_datetime",
+    "data_archive_page",
+    "detectors_status",
+    "event_name",
+    "id",
+    "latitude",
+    "light_curve_url",
+    "longitude",
+    "notice_type",
+    "rate_duration",
+    "rate_energy_range",
+    "rate_snr",
+    "record_number",
+    "trigger_algorithm_number",
+    "trigger_time"
+  ],
+  "additionalProperties": false
+}

gcn/notices/fermi/gbm/strict/FermiGBMAlert1.example.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "https://gcn.nasa.gov/schema/main/gcn/notices/fermi/gbm/FermiGBMAlert.schema.json",
+  "additional_info": "*** PREFACE TO THIS EXAMPLE: This is an example of a Fermi GBM Alert GCN notice. All possible properties are present. This preface uses a field reserved for free-text comments to the notice. The preface is not going to be part of a real-life notice but here might be other comments. This field may be missing or empty in case of no comments. An example of a typical notice comment follows. ***\n\nLightcurve and other quicklook files will not be created until about 15 minutes after the trigger.",
+  "alert_datetime": "2024-08-24T02:14:54",
+  "alert_tense": "current",
+  "alert_type": "initial",
+  "data_archive_page": "http://heasarc.gsfc.nasa.gov/FTP/fermi/data/gbm/triggers/2024/bn240812094",
+  "detectors_status": [
+    "triggered",
+    "on",
+    "triggered",
+    "triggered",
+    "on",
+    "on",
+    "triggered",
+    "on",
+    "on",
+    "on",
+    "on",
+    "on",
+    "on",
+    "on"
+  ],
+  "event_name": ["GRB240824A"],
+  "hitl": false,
+  "id": ["745121685", "bn240812094"],
+  "instrument": "GBM",
+  "latitude": 23.83,
+  "light_curve_url": "http://heasarc.gsfc.nasa.gov/FTP/fermi/data/gbm/triggers/2024/bn240812094/quicklook/glg_lc_medres34_bn240812094.gif",
+  "longitude": 257.4,
+  "messenger": "EM",
+  "mission": "Fermi",
+  "notice_type": "FERMI_GBM_ALERT",
+  "rate_duration": 2.048,
+  "rate_energy_range": [47, 291],
+  "rate_snr": 4.9,
+  "record_number": 1,
+  "spectrum": "energy",
+  "trigger_algorithm_number": 14,
+  "trigger_time": "2024-08-24T02:14:40.43",
+  "trigger_type": "rate",
+  "units": "keV"
+}

gcn/notices/fermi/gbm/strict/FermiGBMAlert2.example.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "https://gcn.nasa.gov/schema/main/gcn/notices/fermi/gbm/FermiGBMAlert.schema.json",
+  "additional_info": "*** PREFACE TO THIS EXAMPLE: This is an example of a Fermi GBM Alert GCN notice. Only stricly necessary fields are present. This preface uses a field reserved for free-text comments to the notice. The preface is not going to be part of a real-life notice but here might be other comments. This field may be missing or empty in case of no comments. An example of a typical notice comment follows. ***\n\nLightcurve and other quicklook files will not be created until about 15 minutes after the trigger.",
+  "alert_datetime": "2024-08-24T02:14:54",
+  "data_archive_page": "http://heasarc.gsfc.nasa.gov/FTP/fermi/data/gbm/triggers/2024/bn240812094",
+  "detectors_status": [
+    "triggered",
+    "on",
+    "triggered",
+    "triggered",
+    "on",
+    "on",
+    "triggered",
+    "on",
+    "on",
+    "on",
+    "on",
+    "on",
+    "on",
+    "on"
+  ],
+  "event_name": ["GRB240824A"],
+  "id": ["745121685", "bn240812094"],
+  "latitude": 23.83,
+  "light_curve_url": "http://heasarc.gsfc.nasa.gov/FTP/fermi/data/gbm/triggers/2024/bn240812094/quicklook/glg_lc_medres34_bn240812094.gif",
+  "longitude": 257.4,
+  "notice_type": "FERMI_GBM_ALERT",
+  "rate_duration": 2.048,
+  "rate_energy_range": [47, 291],
+  "rate_snr": 4.9,
+  "record_number": 1,
+  "trigger_algorithm_number": 14,
+  "trigger_time": "2024-08-24T02:14:40.43"
+}

gcn/notices/fermi/gbm/strict/FermiGBMClassification.schema.json~

@@ -0,0 +1,81 @@
+{
+  "$id": "https://gcn.nasa.gov/schema/main/gcn/notices/fermi/gbm/strict/FermiGBMClassification.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Schema for Fermi GBM GCN notices",
+  "description": "",
+  "properties": {
+    "classification": {
+      "type": "object",
+      "properties": {
+        "UNRELIABLE_LOCATION": {
+          "$ref": "#/properties/classification/$defs/P",
+          "description": "Localization failed. If present, should be the only cand and should be a probability of 100%. (Classic notice numeric code: 1)"
+        },
+        "LOCAL_PARTICLES": {
+          "$ref": "#/properties/classification/$defs/P",
+          "description": "Local particles (equal rates in opposite detectors). If present, should be the only cand and should be with a probability of 100%. (Classic notice numeric code: 2)"
+        },
+        "BELOW_HORIZON": {
+          "$ref": "#/properties/classification/$defs/P",
+          "description": "Distant particles, assumed to come from the horizon. If present, should be the only class and should be a probability of 100%. (Classic notice numeric code: 3)"
+        },
+        "GRB": {
+          "$ref": "#/properties/classification/$defs/P",
+          "description": "For bursts with good localizations. (Classic notice numeric code: 4)"
+        },
+        "GENERIC_SGR": {
+          "$ref": "#/properties/classification/$defs/P",
+          "description": "This is any SGR, except 1806-20. (Classic notice numeric code: 5)"
+        },
+        "GENERIC_TRANSIENT": {
+          "$ref": "#/properties/classification/$defs/P",
+          "description": "Any astrophysical transient not included elsewhere. (Classic notice numeric code: 6)"
+        },
+        "DISTANT_PARTICLES": {
+          "$ref": "#/properties/classification/$defs/P",
+          "description": "Particles at a distance. (Classic notice numeric code: 7)"
+        },
+        "SOLAR_FLARE": {
+          "$ref": "#/properties/classification/$defs/P",
+          "description": "This is a Solar flare event. (Classic notice numeric code: 8)"
+        },
+        "CYG_X1": {
+          "$ref": "#/properties/classification/$defs/P",
+          "description": "This trigger was caused by a CygX1 fluctuation. (Classic notice numeric code: 9)"
+        },
+        "SGR_1806_20": {
+          "$ref": "#/properties/classification/$defs/P",
+          "description": "This trigger came from SGR 1806-20. (Classic notice numeric code: 10)"
+        },
+        "GROJ_0422_32": {
+          "$ref": "#/properties/classification/$defs/P",
+          "description": "This trigger came from GROJ0422-32. (Classic notice numeric code: 11)"
+        },
+        "TGF": {
+          "$ref": "#/properties/classification/$defs/P",
+          "description": "A terrestial gamma flash. (Classic notice numeric code: 19)"
+        },
+        "DUP": {
+          "$ref": "#/properties/classification/$defs/P",
+          "description": "If the class is repeated by mistake, this is second probability."
+        }
+      },
+      "patternProperties": {
+        "^CLASS_[0-9][0-9][0-9]$": {
+          "$ref": "#/properties/classification/$defs/P",
+          "description": "CLASS_XYZ stands for an undefined source class with a numeric code XYZ."
+        }
+      },
+      "$defs": {
+        "P": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 1
+        }
+      },
+      "minProperties": 1,
+      "maxProperties": 2,
+      "unevaluatedProperties": false
+    }
+  }
+}

gcn/notices/fermi/gbm/strict/FermiGBMLocalization.schema.json~

@@ -0,0 +1,32 @@
+{
+  "$id": "https://gcn.nasa.gov/schema/main/gcn/notices/fermi/gbm/strict/FermiGBMLocalization.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "title": "Localization",
+  "description": "Localization of transient",
+  "properties": {
+    "ra_dec_error": {
+      "type": "number",
+      "description": "Uncertainty region described as a circle with a radius [deg]."
+    }
+  },
+  "dependentRequired": {
+    "healpix_file": ["ra"],
+    "ra": [
+      "dec",
+      "ra_dec_error",
+      "containment_probability",
+      "systematic_included",
+      "instrument_phi",
+      "instrument_theta",
+      "healpix_url"
+    ],
+    "dec": ["ra"],
+    "ra_dec_error": ["ra"],
+    "containment_probability": ["ra"],
+    "systematic_included": ["ra"],
+    "instrument_phi": ["ra"],
+    "instrument_theta": ["ra"],
+    "healpix_url": ["ra"]
+  }
+}

gcn/notices/fermi/gbm/strict/README

@@ -0,0 +1 @@
+Under construction...