gwsumm.triggers module

Read and store transient event triggers

gwsumm.triggers.add_triggers(table, key, segments=None)

Add a EventTable to the global memory cache

gwsumm.triggers.get_etg_read_kwargs(etg, config=None, exclude=['columns'])

Read keyword arguments to pass to the trigger reader for a given etg

gwsumm.triggers.get_etg_table(etg)

Find which table should be used for the given etg

Parameters:

etgstr

name of Event Trigger Generator for which to query

Returns:

tabletype, subclass of ~ligo.lw.table.Table

LIGO_LW table registered to the given ETG

Raises:

KeyError

if the ETG is not registered

gwsumm.triggers.get_time_column(table, etg)

Get the time column name for this table

gwsumm.triggers.get_times(table, etg)

Get the time data for this table

See also

:obj:`get_time_column`

gwsumm.triggers.get_triggers(channel, etg, segments, config=<GWSummConfigParser()>, cache=None, columns=None, format=None, query=True, nproc=1, ligolwtable=None, filter=None, timecolumn=None, verbose=False, return_=True)

Read a table of transient event triggers for a given channel.

gwsumm.triggers.keep_in_segments(table, segmentlist, etg=None)

Return a view of the table containing only those rows in the segmentlist

gwsumm.triggers.read_cache(cache, segments, etg, nproc=1, timecolumn=None, **kwargs)

Read a table of events from a cache

This function is mainly meant for use from the get_triggers method

Parameters:

cache:class:`glue.lal.Cache`

the formatted list of files to read

segments~gwpy.segments.SegmentList

the list of segments to read

etgstr

the name of the trigger generator that created the files

nprocint, optional

the number of parallel processes to use when reading

**kwargs

other keyword arguments are passed to the EventTable.read or {tableclass}.read methods

Returns:

table~gwpy.table.EventTable, None

a table of events, or None if the cache has no overlap with the segments