gwsumm.tabs.gracedb module

Custom SummaryTab to display events queried from the Gravitational-wave Candidate Event Database (GraceDb)

class gwsumm.tabs.gracedb.GraceDbTab(*args, **kwargs)

Bases: DataTab

Custom tab displaying a summary of GraceDb results.

classmethod from_ini(config, section, **kwargs)

Define a new GraceDbTab from a ConfigParser.

process(config=<GWSummConfigParser()>, **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, **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 = 'gracedb'

write_state_html(state)

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