gwcelery.tasks.raven module¶
Search for GRB-GW coincidences with ligo-raven.
- (task)gwcelery.tasks.raven.calculate_coincidence_far(superevent, exttrig, tl, th, use_superevent_skymap=None)[source]¶
Compute coincidence FAR for external trigger and superevent coincidence by calling ligo.raven.search.calc_signif_gracedb, using sky map info if available.
- Parameters:
superevent (dict) – superevent dictionary
exttrig (dict) – external event dictionary
tl (float) – start of coincident time window
th (float) – end of coincident time window
use_superevent_skymap (bool) – If True/False, use/don’t use skymap info from superevent. Else if None, check SKYMAP_READY label in external event.
- (task)gwcelery.tasks.raven.coincidence_search(gracedb_id, alert_object, group=None, pipelines=[], searches=[], se_searches=[])[source]¶
Perform ligo-raven search for coincidences. Determines time window to use. If events found, launches raven pipeline.
- (task)gwcelery.tasks.raven.search(gracedb_id, alert_object, tl=-5, th=5, group=None, pipelines=[], searches=[], se_searches=[])[source]¶
Perform ligo-raven search for coincidences.
- Parameters:
gracedb_id (str) – ID of the trigger used by GraceDB
alert_object (dict) – Alert dictionary
tl (int) – number of seconds to search before
th (int) – number of seconds to search after
group (str) – Burst or CBC
pipelines (list) – list of external trigger pipelines for performing coincidence search against
searches (list) – list of external trigger searches
se_searches (list) – list of superevent searches
- Return type:
list with the dictionaries of related gracedb events
- (task)gwcelery.tasks.raven.raven_pipeline(raven_search_results, gracedb_id, alert_object, tl, th, gw_group, use_superevent_skymap=None)[source]¶
Executes much of the full raven pipeline, including adding the external trigger to the superevent, calculating the coincidence false alarm rate, and applying ‘EM_COINC’ to the appropriate events. Also a preimlinary alert will be triggered if the coincidence passes threshold.
- Parameters:
raven_search_results (list) – list of dictionaries of each related gracedb trigger
gracedb_id (str) – ID of either a superevent or external trigger
alert_object (dict) – Alert dictionary, either a superevent or an external event
gw_group (str) – Burst or CBC
use_superevent_skymap (bool) – If True/False, use/don’t use skymap info from superevent. Else if None, check SKYMAP_READY label in external event.
- (task)gwcelery.tasks.raven.preferred_superevent(raven_search_results)[source]¶
Chooses the superevent with the lowest far for an external event to be added to. This is to prevent errors from trying to add one external event to multiple superevents.
- Parameters:
raven_search_results (list) – list of dictionaries of each related gracedb trigger
- (task)gwcelery.tasks.raven.update_coinc_far(coinc_far_dict, superevent, ext_event)[source]¶
Update joint info in superevent based on the current preferred coincidence. This prefers a spacetime joint FAR over a time-only joint FAR. A SNEWS coincidence is preferred over either.
Parameters
RAVEN
- supereventdict
superevent dictionary
- ext_event: dict
external event dictionary
- (task)gwcelery.tasks.raven.trigger_raven_alert(coinc_far_dict, superevent, gracedb_id, ext_event, gw_group)[source]¶
Determine whether an event should be published as a preliminary alert. If yes, then triggers an alert by applying RAVEN_ALERT to the preferred event.
All of the following conditions must be true for a preliminary alert:
The external event must be a threshold GRB or SNEWS event.
If triggered on a SNEWS event, the GW false alarm rate must pass
snews_gw_far_threshold
.The event’s RAVEN coincidence false alarm rate, weighted by the group-specific trials factor as specified by the
preliminary_alert_trials_factor
configuration setting, is less than or equal topreliminary_alert_far_threshold
.If the external event is from Swift, both sky maps must be present.
- (task)gwcelery.tasks.raven.sog_paper_pipeline(ext_event, superevent)[source]¶
Determine whether an a speed of gravity measurment manuscript should be triggered for a given coincidence. This is denoted by applying the SOG_READY label to a superevent.
All of the following conditions must be true for a SoG paper:
The coincidence is significant and FARs more significant than in
sog_paper_far_threshold
.The external event is a high-significance GRB and from a MOU partner.
The GW event is a CBC candidate.