gwsumm.tabs.etg module

Custom SummaryTab for the output of an ETG.

class gwsumm.tabs.etg.EventTriggerTab(*args, **kwargs)

Bases: DataTab

Custom DataTab displaying a summary of event trigger generation

Parameters:

namestr

name of this tab (required)

startLIGOTimeGPS, str

start time of this DataTab, anything that can be parsed by ~gwpy.time.to_gps is fine

endLIGOTimeGPS, str

end time of this DataTab, format as for start

channelstr

name of the channel of interest

etgstr, optional

name of this event trigger generator (ETG), defaults to the name of this EventTriggerTab

stateslist of states <gwsumm.state.SummaryState>

the list of states (~gwsumm.state.SummaryState) over which this DataTab should be processed. More states can be added later (but before running :meth:`~DataTab.process`) via :meth:`~DataTab.add_state`.

tabletype, str, optional

LIGO_LW ~glue.ligolw.table.Table class to use for this ETG, e.g. use ~glue.ligolw.lsctables.SnglBurstTable for Omicron, or ~glue.ligolw.lsctables.SnglInspiralTable for CBC

cache~glue.lal.Cache, str, optional

Cache object, or path to a LAL-format cache file on disk, from which to read the event triggers. If no cache is given, the gwtrigfind module will be used to automatically locate the trigger files.

urlstr, optional

URL for linking to more details results for this tab.

**kwargs

all other keyword arguments accepted by the DataTab

See also

:obj:`gwsumm.tabs.DataTab`

for details on the other keyword arguments (**kwargs) accepted by the constructor for this EventTriggerTab.

finalize_states(config=None, **kwargs)

Fetch the segments for each state for this SummaryTab

classmethod from_ini(config, section, **kwargs)

Define a new EventTriggerTab from a ConfigParser.

Parameters:

cp:class:`~gwsumm.config.GWConfigParser`

customised configuration parser containing given section

sectionstr

name of section to parse

*args, **kwargs

other positional and keyword arguments to pass to the class constructor (__init__)

See also

:obj:`DataTab.from_ini`

the parent parsing method that handles parsing plot defintions, amongst other things

Notes

In addition to those attributes parsed by the parent DataTab.from_ini method, this method will parse the following attributes from a ConfigParser:

.. autosummary::

~EventTriggerTab.channel ~EventTriggerTab.etg ~EventTriggerTab.url ~EventTriggerTab.cache ~EventTriggerTab.table

Additionally, the loudest events table is configured by giving the following options

—————– ——————————————— loudest the number of events to include in the table loudest-rank the statistic to use in sorting the table loudest-dt the minimum time separation for unique events loudest-columns the columns to print in the table loudest-labels the labels for each of the given columns —————– ———————————————

process(*args, **kwargs)

Process data for this tab

Parameters:

configConfigParser.ConfigParser, optional

job configuration to pass to \(~DataTab.finalize_states\)

**stateargs

all other keyword arguments are passed directly onto the :meth:`~DataTab.process_state` method.

process_state(state, *args, **kwargs)

Process data for this tab in a given state

Parameters:

state~gwsumm.state.SummaryState

the state to process. Can give None to process ALLSTATE with no plots, useful to load all data for other states

ndsbool, optional

True to use NDS to read data, otherwise read from frames. Use None to read from frames if possible, otherwise using NDS.

nprocint, optional

number of parallel cores to use when reading data and making plots, default: 1

configConfigParser, optional

configuration for this analysis

datacache~glue.lal.Cache, optional

Cache of files from which to read time-series data

trigcache~glue.lal.Cache, optional

Cache of files from which to read event triggers

segmentcache~glue.lal.Cache, optional

Cache of files from which to read segments

segdb_errorstr, optional

if 'raise': raise exceptions when the segment database reports exceptions, if 'warn''`, print warnings but continue, otherwise ``'ignore' them completely and carry on.

type = 'triggers'

write_state_html(state, pre=None)

Write the ‘#main’ HTML content for this EventTriggerTab.