Package pylal :: Module plotsegments :: Class PlotSegmentsPlot

Class PlotSegmentsPlot

object --+
         |
        PlotSegmentsPlot

Represent a plotsegments plot. To use it, one must instantiate a PlotSegmentsPlot object, call add_contents(), then call finalize(). To save, call the savefig() method. To display to the screen, call pylab.show().

Developer note: There is the transformation function _time_transform. Follow the convention of applying it before storing internal data so that there is no ambiguity about whether data has been transformed or not.

Instance Methods

[hide private]

__init__(self, t0=0)
Create a fresh plot.

source code

add_contents(self, segdict, ifos=None)
Add the contents of segdict to the plot.

source code

set_window(self, window_seg, padding=0)
Define a window of interest by setting the x-limits of the plot appropriately.

source code

highlight_segment(self, seg)
Highlight a particular segment with dashed lines.

source code

finalize(self)
Make final changes to the plot with the guarantee that no additional data will be added.

source code

close(self)

source code

__del__(self)

source code

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

Class Variables

[hide private]

color_code = {'H1': 'r', 'H2': 'b', 'L1': 'g', 'V1': 'm', 'G1'...

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, t0=0)
(Constructor)

source code

Create a fresh plot. Provide t0 to provide a reference time to use as zero.

Overrides: object.__init__

add_contents(self, segdict, ifos=None)

source code

Add the contents of segdict to the plot. Provide the list ifos, if you wish to specify the order in which they appear or wish to plot a subset of the segmentlists in segdict.

set_window(self, window_seg, padding=0)

source code

Define a window of interest by setting the x-limits of the plot appropriately. If padding is also present, protract the x-limits by that quantity and mark the unpadded window with solid black lines.

Class Variable Details

[hide private]

color_code

Value:

{'H1': 'r', 'H2': 'b', 'L1': 'g', 'V1': 'm', 'G1': 'k'}

Class PlotSegmentsPlot

__init__(self, t0=0) (Constructor)

add_contents(self, segdict, ifos=None)

set_window(self, window_seg, padding=0)

color_code

init(self, t0=0)
(Constructor)