ligo.raven.gracedb_events

Module to define functions and attributes corresponding to both gravitational-wave candidates and external triggers.

class ligo.raven.gracedb_events.ExtTrig(graceid, gracedb=None, event_dict=None, fitsfile=None, is_moc=True, use_radec=False, nested=True)[source]

Bases: object

Instance of an external trigger event (e.g. gamma-ray burst)

Parameters:

  • graceid (str) – ID of the trigger used by GraceDB

  • gracedb (class) – SDK or REST API client for HTTP connection

  • event_dict (dict) – Dictionary of external event

  • fitsfile (str) – External event’s skymap file name

  • is_moc (bool) – If True, assumes multi-order coverage (MOC) external event skymap

  • use_radec (bool) – If True, use ra and dec for single pixel external skymap

  • nested (bool) – If True, assumes external skymap uses nested ordering, otherwise assumes ring ordering

submit_gracedb_log(message, filename=None, filecontents=None, tags=[])[source]

Upload log to GraceDB for this event

Parameters:

  • message (str) – Log message to upload

  • filename (class) – Name of file to upload

  • filecontents (bytes) – Contents of file to upload in bytes

  • tags (list) – List of tags to include in log message

class ligo.raven.gracedb_events.SE(superevent_id, event_dict=None, gracedb=None, fitsfile=None, is_moc=True, nested=True, use_preferred_event_skymap=False)[source]

Bases: object

Instance of a superevent

Parameters:

  • graceid (str) – ID of the trigger used by GraceDB

  • gracedb (class) – SDK or REST API client for HTTP connection

  • event_dict (dict) – Dictionary of superevent

  • fitsfile (str) – GW’s skymap file name

  • is_moc (bool) – If True, assumes multi-order coverage (MOC) GW skymap

  • nested (bool) – If True, assumes GW skymap uses nested ordering, otherwise assumes ring ordering

submit_gracedb_log(message, filename=None, filecontents=None, tags=[])[source]

Upload log to GraceDB for this event

Parameters:

  • message (str) – Log message to upload

  • filename (class) – Name of file to upload

  • filecontents (bytes) – Contents of file to upload in bytes

  • tags (list) – List of tags to include in log message

ligo.raven.gracedb_events.load_skymap(filename, is_moc=True, nested=True)[source]