Event Candidate I/O (ligo.skymap.io.events
)¶
This module provides a high-level interface for reading event records from search pipelines.
Openers¶
-
ligo.skymap.io.events.
open
(f, *args, **kwargs)¶ Read events from either HDF or LIGO-LW files. The format is determined using the POSIX
file
command, which determines the file by looking for ‘magic’ byte strings (hence the name of this module).- Returns
- source
EventSource
- source
-
ligo.skymap.io.events.gracedb.
open
(graceids, client=None)¶ Read events from GraceDB.
- Parameters
- graceidslist
List of GraceDB ID strings.
- client
ligo.gracedb.rest.GraceDb
, optional Client object
Abstract Base Classes¶
-
class
ligo.skymap.io.events.
EventSource
[source]¶ Bases:
collections.abc.Mapping
Abstraction of a source of coincident events.
This is a mapping from event IDs (which may be any hashable type, but are generally integers or strings) to instances of
Event
.
-
class
ligo.skymap.io.events.
Event
[source]¶ Abstraction of a coincident trigger.
- Attributes
- singleslist, tuple
Sequence of
SingleEvent
- template_argsdict
Dictionary of template parameters
-
class
ligo.skymap.io.events.
SingleEvent
[source]¶ Abstraction of a single-detector trigger.
- Attributes
- detectorstr
Instrument name (e.g. ‘H1’)
- snrfloat
Signal to noise ratio
- phasefloat
Phase on arrival
- timefloat
GPS time on arrival
- zerolag_timefloat
GPS time on arrival in zero-lag data, without time slides applied
- psd
REAL8FrequencySeries
Power spectral density
- snr_series
COMPLEX8TimeSeries
SNR time series