Package pylal :: Module plotutils :: Class PlotSegmentsPlot
[hide private]
[frames] | no frames]

Class PlotSegmentsPlot

source code

object --+    
         |    
 BasicPlot --+
             |
            PlotSegmentsPlot

Horizontal bar segment plot.

Instance Methods [hide private]
 
__init__(self, xlabel="", ylabel="", title="", subtitle="", t0=0, dt=1)
Create a fresh plot.
source code
 
add_content(self, segdict, keys=None, **kwargs)
Stub.
source code
 
highlight_segment(self, seg, **plot_args)
Highlight a particular segment with dashed lines.
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
 
finalize(self, labels_inset=False, hidden_colorbar=False)
Stub.
source code

Inherited from BasicPlot: add_legend_if_labels_exist, close, savefig

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, xlabel="", ylabel="", title="", subtitle="", t0=0, dt=1)
(Constructor)

source code 

Create a fresh plot. Provide t0 to provide reference time to use as zero, and dt to use a different number of seconds for each unit of the x-axis.

Overrides: object.__init__

add_content(self, segdict, keys=None, **kwargs)

source code 

Stub. Replace with a method that appends values or lists of values to self.data_sets and appends labels to self.data_labels. Feel free to accept complicated inputs, but try to store only the raw numbers that will enter the plot.

Overrides: BasicPlot.add_content
(inherited documentation)

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.

finalize(self, labels_inset=False, hidden_colorbar=False)

source code 

Stub. Replace with a function that creates and makes your plot pretty. Do not do I/O here.

Decorators:
  • @method_callable_once
Overrides: BasicPlot.finalize
(inherited documentation)

Class Variable Details [hide private]

color_code

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