Package pylal :: Package dq :: Module summary :: Class TriggerSummaryTab

Class TriggerSummaryTab

object --+    
         |    
SummaryTab --+
             |
            TriggerSummaryTab

Object representing a summary of triggers.

Instance Methods

[hide private]

__init__(self, *args, **kwargs)
Initialise a SummaryTab object.

source code

add_triggers(self, channel, trigtable)
Add a glue.ligolw.table for a given channel to this object

source code

toxml(self, channel, filename=None)
Write the trigtable for the given channel to an xml file.

source code

plottable(self, outfile, channels=None, subplot=False, **kwargs)
Plot the triggers for this TriggerSummary, one column against another.

source code

plothistogram(self, outfile, channels=None, subplot=False, **kwargs)
Plot a histogram of the triggers for this TriggerSummary.

source code

plotrate(self, outfile, channels=None, subplot=False, **kwargs)
Plot the rate of triggers for this TriggerSummary.

source code

plotautocorrelation(self, outfile, channels=None, subplot=False, **kwargs)
Plot the auto correlation function of the trigers for this TriggerSummary.

source code

finalize(self, snrs=[5,8,10,20,50,100,500,1000])
Generate a markup.page object summarising the triggers in this TriggerSummaryTab.

source code

Inherited from SummaryTab: add_child, add_information, build, directory, end_time, frametohtml, get_child, href, index, name, plots, segments, span, start_time, subplots, write_ifo_links, write_menu

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

[hide private]

Inherited from SummaryTab: ifo, mode

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, *args, **kwargs)
(Constructor)

source code

Initialise a SummaryTab object. At least a name must be given.

Parameters:

name - a name string for the tab

Overrides: object.__init__

(inherited documentation)

add_triggers(self, channel, trigtable)

source code

Add a glue.ligolw.table for a given channel to this object

Parameters:

channel (str) - name of channel to record
trigtable (glue.ligolw.table.Table) - LIGOLw table of triggers to record

toxml(self, channel, filename=None)

source code

Write the trigtable for the given channel to an xml file.

Parameters:

channel (str) - name of channel to record
filename (str) - path of file to write, preferrably xml.gz extension

plottable(self, outfile, channels=None, subplot=False, **kwargs)

source code

Plot the triggers for this TriggerSummary, one column against another.

Parameters:

outfile (str) - filename for plot
channels (list) - list of channels to plot
subplot (bool) - record plot as a subplot, default: False
**kwargs - other arguments to pass to plottriggers.plottable

plothistogram(self, outfile, channels=None, subplot=False, **kwargs)

source code

Plot a histogram of the triggers for this TriggerSummary.

Parameters:

outfile (str) - filename for plot
channels (list) - list of channels to plot
subplot (bool) - record plot as a subplot, default: False
**kwargs - other arguments to pass to plottriggers.plothistogram

plotrate(self, outfile, channels=None, subplot=False, **kwargs)

source code

Plot the rate of triggers for this TriggerSummary.

Parameters:

outfile (str) - filename for plot
channels (list) - list of channels to plot
subplot (bool) - record plot as a subplot, default: False
**kwargs - other arguments to pass to plottriggers.plotrate

plotautocorrelation(self, outfile, channels=None, subplot=False, **kwargs)

source code

Plot the auto correlation function of the trigers for this TriggerSummary.

Parameters:

outfile (str) - filename for plot
channels (list) - list of channels to plot
subplot (bool) - record plot as a subplot, default: False
**kwargs - other arguments to pass to plottriggers.plotautocorrelation

Class TriggerSummaryTab

__init__(self, *args, **kwargs) (Constructor)

add_triggers(self, channel, trigtable)

toxml(self, channel, filename=None)

plottable(self, outfile, channels=None, subplot=False, **kwargs)

plothistogram(self, outfile, channels=None, subplot=False, **kwargs)

plotrate(self, outfile, channels=None, subplot=False, **kwargs)

plotautocorrelation(self, outfile, channels=None, subplot=False, **kwargs)

init(self, *args, **kwargs)
(Constructor)