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

Fermi #199

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
+434 −0
Open

Fermi #199

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
dc47b17
Fermi gbm
dakota002 Oct 15, 2024
42ec420
commit
shb46 Oct 17, 2024
96bf975
Corrections to examples
shb46 Oct 17, 2024
896bf94
$schema property fix
shb46 Nov 1, 2024
c3bb0a8
Issue #199: hitl -> human_in_th_loop
shb46 Nov 6, 2024
5d7ca02
Issue #199: Elaborate on "detectors_status" description.
shb46 Nov 6, 2024
c5576ab
Issue #199: Typo in the rate_duration description
shb46 Nov 6, 2024
6bf5331
Issue #199: Specify explicitly "rate_energy_range", as the number wit…
shb46 Nov 6, 2024
cb904dd
Issue #199: "real-life" -> "streamed/real".
shb46 Nov 6, 2024
07f1cbc
Issue #199: Renamed fields in examples to reflect schema
shb46 Nov 6, 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
43 changes: 43 additions & 0 deletions gcn/notices/fermi/gbm/alert.example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{
"$schema": "https://gcn.nasa.gov/schema/main/gcn/notices/fermi/gbm/alert.schema.json",
"additional_info": "Lightcurve 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"
}
51 changes: 51 additions & 0 deletions gcn/notices/fermi/gbm/alert.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
{
"$id": "https://gcn.nasa.gov/schema/main/gcn/notices/fermi/gbm/alert.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "GCN Schema for Fermi GBM Alert Notices",
"description": "This schema is used to report Fermi GBM Alerts.",
"type": "object",
"allOf": [
{
"$ref": "../../core/AdditionalInfo.schema.json"
},
{
"$ref": "../../core/Alert.schema.json"
},
{
"$ref": "../../core/DateTime.schema.json"
},
{
"$ref": "../../core/Event.schema.json"
},
{
"$ref": "../../core/GeoLocBase.schema.json"
},
{
"$ref": "../../core/Reporter.schema.json"
},
{
"$ref": "../../core/Statistics.schema.json"
},
{
"$ref": "detectors.schema.json"
}
],
"properties": {
"notice_type": {
"type": "string",
"description": "Notice title"
},
"human_in_the_loop": {
"type": "boolean",
"description": "Someimes abbreviated as \"HITL\". When false, the notice was generated entirely automatically. A value of true means that a human had an input, while the notice was being prepared. The latter includes notices, which weren't altered by the human input, but a human was given the option to make an input, or asked to confirm, or approve before further processing."
},
"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."
Vidushi-GitHub marked this conversation as resolved.
Show resolved Hide resolved
},
"light_curve_url": {
"type": "string",
"description": "URL of the quicklook light curve plot"
}
}
}
18 changes: 18 additions & 0 deletions gcn/notices/fermi/gbm/detectors.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"$id": "https://gcn.nasa.gov/schema/main/gcn/notices/fermi/gbm/detectors.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "",
"description": "",
"type": "object",
"properties": {
"detectors_status": {
"type": "array",
"items": {
"$ref": "../../core/DetectorStatus.schema.json"
},
"minItems": 14,
"maxItems": 14,
"description": "The array shows which of the 14 GBM detectors triggered, and for the rest, whether they are on or off. Array elements 0-11 correspond to NaI detectors 0-11, among which 10 and 11 are sometimes labeled as \"a\" and \"b\" respectively. The status of the BGO0 and BGO1 detectors is at indices 12 and 13."
}
}
}
43 changes: 43 additions & 0 deletions gcn/notices/fermi/gbm/strict/alert.1.example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{
"$schema": "https://gcn.nasa.gov/schema/main/gcn/notices/fermi/gbm/alert.schema.json",
"additional_info": "*** ABOUT THIS EXAMPLE: This is an example of a Fermi GBM Alert GCN notice. All fields, including the optional ones, are present. This 'about' note is not going to be part of a streamed real notice. 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,
Copy link
Member

Choose a reason for hiding this comment

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

Please make the example field name consistent with schema.
Additionally, validate the schema against examples, in case any change is left out.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Vidushi-GitHub: Changed. Thank you for the reminder!

"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"
}
43 changes: 43 additions & 0 deletions gcn/notices/fermi/gbm/strict/alert.1strict.example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{
"$schema": "https://gcn.nasa.gov/schema/main/gcn/notices/fermi/gbm/strict/alert.schema.json",
"additional_info": "*** ABOUT THIS EXAMPLE: This is an example of a Fermi GBM Alert GCN notice. All fields, including the optional ones, are present. This 'about' note is not going to be part of a streamed real notice. 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"
}
34 changes: 34 additions & 0 deletions gcn/notices/fermi/gbm/strict/alert.2.example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"$schema": "https://gcn.nasa.gov/schema/main/gcn/notices/fermi/gbm/alert.schema.json",
"additional_info": "*** ABOUT THIS EXAMPLE: This is an example of a Fermi GBM Alert GCN notice. Only stricly necessary fields are present. This 'about' note is not going to be part of a streamed real notice. 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"
}
34 changes: 34 additions & 0 deletions gcn/notices/fermi/gbm/strict/alert.2strict.example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"$schema": "https://gcn.nasa.gov/schema/main/gcn/notices/fermi/gbm/strict/alert.schema.json",
"additional_info": "*** ABOUT THIS EXAMPLE: This is an example of a Fermi GBM Alert GCN notice. Only stricly necessary fields are present. This 'about' note is not going to be part of a streamed real notice. 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"
}
Loading
Loading