Package pylal :: Package dq :: Module summary :: Class SegmentSummaryTab

Class SegmentSummaryTab

object --+    
         |    
SummaryTab --+
             |
            SegmentSummaryTab

Object representing a summary of segments.

Instance Methods

[hide private]

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

source code

segdict(self)

source code

add_segments(self, flag, seglist)
Add a glue.segments.segmentlist for a given flag to this object

source code

tosegwizard(self, flag, filename=None)
Write the segments know for the given flag to a segwizard format file.

source code

plotsegments(self, outfile, subplot=False, **kwargs)
Plot the segments associated with this SegmentSummaryTab.

source code

plotduration(self, outfile, flag, subplot=False, **kwargs)
Plot the segment durations for the given flag.

source code

plothistogram(self, outfile, subplot=False, **kwargs)
Plot a histogram of the segments associated with this SegmentSummaryTab.

source code

plotdutycycle(self, outfile, subplot=False, **kwargs)
Plot the duty cycle of segments associated with this SegmentSummaryTab.

source code

finalize(self)
Generate a markup.page object representing the HTML summary of the segments associated with this SegmentSummaryTab.

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)

segdict(self)

source code

Decorators:

@segdict.deleter

add_segments(self, flag, seglist)

source code

Add a glue.segments.segmentlist for a given flag to this object

Parameters:

flag (str) - name of flag to record
seglist (glue.segments.segmentlist) - list of segments to record

tosegwizard(self, flag, filename=None)

source code

Write the segments know for the given flag to a segwizard format file. If an output filename is not given, one is generated.

Parameters:

flag (str) - name of flag whose segments are to be written
filename (str) - path string of file to be written

plotsegments(self, outfile, subplot=False, **kwargs)

source code

Plot the segments associated with this SegmentSummaryTab.

Parameters:

outfile (str) - filename for plot
subplot (bool) - record plot as a subplot, default: False
**kwargs - other arguments to pass to plotsegments.plotsegmentlistdict

plotduration(self, outfile, flag, subplot=False, **kwargs)

source code

Plot the segment durations for the given flag.

Parameters:

outfile (str) - filename for plot
flag (str) - name of flag whose segments are to be plotted
subplot (bool) - record plot as a subplot, default: False
**kwargs - other arguments to pass to plotsegments.plotsegmentlistdict

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

source code

Plot a histogram of the segments associated with this SegmentSummaryTab.

Parameters:

outfile (str) - filename for plot
subplot (bool) - record plot as a subplot, default: False
**kwargs - other arguments to pass to plotsegments.plotsegmentlistdict

plotdutycycle(self, outfile, subplot=False, **kwargs)

source code

Plot the duty cycle of segments associated with this SegmentSummaryTab.

Parameters:

outfile (str) - filename for plot
subplot (bool) - record plot as a subplot, default: False
**kwargs - other arguments to pass to plotsegments.plotsegmentlistdict

Class SegmentSummaryTab

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

segdict(self)

add_segments(self, flag, seglist)

tosegwizard(self, flag, filename=None)

plotsegments(self, outfile, subplot=False, **kwargs)

plotduration(self, outfile, flag, subplot=False, **kwargs)

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

plotdutycycle(self, outfile, subplot=False, **kwargs)

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