Home       Trees       Indices       Help   
pylal
Package pylal :: Package dq :: Module summary :: Class DataSummaryTab
[hide private]
[frames] | no frames]

Class DataSummaryTab

source code

object --+    
         |    
SummaryTab --+
             |
            DataSummaryTab

SummaryTab representing the summary of data extracted from frames.

Instance Methods [hide private]
 
__init__(self, *args, **kwargs)
Initialise a SummaryTab object.		 source code
 
add_timeseries(self, channel, series)
Add a glue.ligolw.table for a given channel to this object		 source code
 
add_spectrogram(self, channel, *sequencelist)
Add a list of REAL8VectorSequence objects as the spectrogram for this channel.		 source code
 
add_median_spectrum(self, channel, series)
Add a FrequencySeries object as the median spectrum for this channel.		 source code
 
add_min_spectrum(self, channel, series)
Add a FrequencySeries object as the minimum spectrum for this channel.		 source code
 
add_max_spectrum(self, channel, series)
Add a REAL8FrequencySeries object as the maximum spectrum for this channel.		 source code
 
add_design_spectrum(self, channel, series)
Add a FrequencySeries object as the maximum spectrum for this channel.		 source code
 
add_reference_spectrum(self, channel, series)
Add a FrequencySeries object as the maximum spectrum for this channel.		 source code
 
plottimeseries(self, outfile, channels=None, subplot=False, **kwargs)
Plot the timeseries for this TriggerSummary, one column against another.		 source code
 
plothistogram(self, outfile, channels=None, subplot=False, **kwargs)
Plot the histogram of data contained with the timeseries' for this DataSummary.		 source code
 
plotspectrogram(self, outfile, channel=None, ratio=None, subplot=False, **kwargs)
Plot the spectrogram of the given channel		 source code
 
plotspectrum(self, outfile, channel=None, psd=False, subplot=False, **kwargs)
Plot the spectrum of the given channel		 source code
 
finalize(self)
Generate a markup.page object representing the HTML summary of the data associated with this DataSummaryTab.		 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_timeseries(self, channel, series)

source code 

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

Parameters:
  • channel (str) - name of channel to store
  • series (lal.XXXXTimeSeries) - TimeSeries data object to store

add_spectrogram(self, channel, *sequencelist)

source code 

Add a list of REAL8VectorSequence objects as the spectrogram for this channel.

Parameters:
  • channel (str) - name of channel to store
  • sequencelist - spectrogram data object to store, or list of spectrograms

add_median_spectrum(self, channel, series)

source code 

Add a FrequencySeries object as the median spectrum for this channel.

Parameters:
  • channel (str) - name of channel to store
  • series (lal.XXXXFrequencySeries) - FrequencySeries data object to store

add_min_spectrum(self, channel, series)

source code 

Add a FrequencySeries object as the minimum spectrum for this channel.

Parameters:
  • channel (str) - name of channel to store
  • series (lal.XXXXFrequencySeries) - FrequencySeries data object to store

add_max_spectrum(self, channel, series)

source code 

Add a REAL8FrequencySeries object as the maximum spectrum for this channel.

Parameters:
  • channel (str) - name of channel to store
  • series (lal.XXXXFrequencySeries) - FrequencySeries data object to store

add_design_spectrum(self, channel, series)

source code 

Add a FrequencySeries object as the maximum spectrum for this channel.

Parameters:
  • channel (str) - name of channel to store
  • series (lal.XXXXFrequencySeries) - FrequencySeries data object to store

add_reference_spectrum(self, channel, series)

source code 

Add a FrequencySeries object as the maximum spectrum for this channel.

Parameters:
  • channel (str) - name of channel to store
  • series (lal.XXXXFrequencySeries) - FrequencySeries data object to store

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

source code 

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

Parameters:
  • outfile (str) - filename for plot
  • channels (list) - list of channels to plot, default: all of them
  • subplot (bool) - record plot as a subplot, default: False
  • **kwargs - other arguments to pass to plotdata.plottimeseries

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

source code 

Plot the histogram of data contained with the timeseries' for this DataSummary.

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

plotspectrogram(self, outfile, channel=None, ratio=None, subplot=False, **kwargs)

source code 

Plot the spectrogram of the given channel

Parameters:
  • outfile (str) - filename for plot
  • channels (list) - list of channels to plot, default: all of them
  • ratio (list) - description of ratio to calculate on-the-fly, e.g. "median", or "design"
  • subplot (bool) - record plot as a subplot, default: False
  • **kwargs - other arguments to pass to plotdata.plotspectrogram

plotspectrum(self, outfile, channel=None, psd=False, subplot=False, **kwargs)

source code 

Plot the spectrum of the given channel

Parameters:
  • outfile (str) - filename for plot
  • channels (list) - list of channels to plot, default: all of them
  • psd (bool) - plot spectrum as a PSD, default False
  • subplot (bool) - record plot as a subplot, default: False
  • **kwargs - other arguments to pass to plotdata.plotfrequencyseries

   Home       Trees       Indices       Help   
pylal
Generated by Epydoc 3.0.1 on Tue Dec 12 01:21:42 2017 http://epydoc.sourceforge.net