Package pylal :: Package dq :: Module summary :: Class AuxTriggerSummaryTab
[hide private]
[frames] | no frames]

Class AuxTriggerSummaryTab

source code

   object --+        
            |        
   SummaryTab --+    
                |    
TriggerSummaryTab --+
                    |
                   AuxTriggerSummaryTab

Object representing a summary of auxiliary channel triggers.

Instance Methods [hide private]
 
__init__(self, *args, **kwargs)
Initialise a SummaryTab object.
source code
 
get_coincs(self, channel1, channel2, dt=0.03)
Find triggers for channel1 within dt of a trigger for channel2.
source code
 
compute_coinc_significance(self, channel, dt=0.03, shifts=[0])
Calculate the statistical significance of the number of triggers in channel coincident with a trigger in the mainchannel.
source code
 
plottable(self, outfile, channel, **kwargs)
Plot the triggers for the given channel.
source code
 
plothistogram(self, outfile, channel, **kwargs)
Plot a histogram of the triggers for this TriggerSummary.
source code
 
plotrate(self, outfile, channel, **kwargs)
Plot the rate of triggers for this TriggerSummary.
source code
 
plotautocorrelation(self, outfile, channel, **kwargs)
Plot the auto correlation function of the trigers for this TriggerSummary.
source code
 
plotcoincs(self, outfile, channel, **kwargs)
Plot the coincident triggers between the given channel and the mainchannel.
source code
 
plotsigma(self, outfile, channel=None, **kwargs)
Plot the statistical significance of the number of coincidences between the mainchannel and all auxiliary channels.
source code
 
plotnumslides(self, outfile, channel, **kwargs)
Plot the number of coincidences between this channel and the mainchannel for all slides and zerolag.
source code
 
finalize(self)
Generate a glue.markup.page summarising the auxiliary channel triggers for this AuxTriggerSummaryTab.
source code

Inherited from TriggerSummaryTab: add_triggers, toxml

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)

compute_coinc_significance(self, channel, dt=0.03, shifts=[0])

source code 

Calculate the statistical significance of the number of triggers in channel coincident with a trigger in the mainchannel. Give a list of numerical time shifts to calculate for multiple events.

plottable(self, outfile, channel, **kwargs)

source code 

Plot the triggers for the given channel.

Parameters:
  • outfile - filename for plot
  • channels - list of channels to plot
  • subplot - record plot as a subplot, default: False
  • **kwargs - other arguments to pass to plottriggers.plottable
Overrides: TriggerSummaryTab.plottable

plothistogram(self, outfile, channel, **kwargs)

source code 

Plot a histogram of the triggers for this TriggerSummary.

Parameters:
  • outfile - filename for plot
  • channels - list of channels to plot
  • subplot - record plot as a subplot, default: False
  • **kwargs - other arguments to pass to plottriggers.plothistogram
Overrides: TriggerSummaryTab.plothistogram
(inherited documentation)

plotrate(self, outfile, channel, **kwargs)

source code 

Plot the rate of triggers for this TriggerSummary.

Parameters:
  • outfile - filename for plot
  • channels - list of channels to plot
  • subplot - record plot as a subplot, default: False
  • **kwargs - other arguments to pass to plottriggers.plotrate
Overrides: TriggerSummaryTab.plotrate
(inherited documentation)

plotautocorrelation(self, outfile, channel, **kwargs)

source code 

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

Parameters:
  • outfile - filename for plot
  • channels - list of channels to plot
  • subplot - record plot as a subplot, default: False
  • **kwargs - other arguments to pass to plottriggers.plotautocorrelation
Overrides: TriggerSummaryTab.plotautocorrelation
(inherited documentation)

finalize(self)

source code 

Generate a glue.markup.page summarising the auxiliary channel triggers for this AuxTriggerSummaryTab.

Overrides: TriggerSummaryTab.finalize