Package pylal :: Package dq :: Module dqPlotUtils :: Class ColorbarScatterPlot
[hide private]
[frames] | no frames]

Class ColorbarScatterPlot

source code

         object --+    
                  |    
plotutils.BasicPlot --+
                      |
                     ColorbarScatterPlot

A scatter plot of x- versus y-data, coloured by z-data. A single colorbar is used, from the union of the ranges of z-data for each content set, unless strict limits are passed as clim=(cmin, cmax) to finalize().

Instance Methods [hide private]
 
__init__(self, xlabel="", ylabel="", zlabel="", title="", subtitle="")
Basic plot initialization.
source code
 
add_content(self, x_data, y_data, z_data, rank_data, **kwargs)
Stub.
source code
 
finalize(self, loc='best', logx=False, logy=False, logz=False, clim=None, base=10)
Stub.
source code
 
set_colorbar(self, mappable, clim=None, log=True, base=10) source code
 
add_colorbar(self, mappable, cax=None, clim=None, log=False, base=10, label=None, **kwargs) source code

Inherited from plotutils.BasicPlot: add_legend_if_labels_exist, close, savefig

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, xlabel="", ylabel="", zlabel="", title="", subtitle="")
(Constructor)

source code 

Basic plot initialization. A subclass can override __init__ and call this one (plotutils.BasicPlot.__init__(self, *args, **kwargs)) and then initialize variables to hold data to plot and labels.

Overrides: object.__init__
(inherited documentation)

add_content(self, x_data, y_data, z_data, rank_data, **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: plotutils.BasicPlot.add_content
(inherited documentation)

finalize(self, loc='best', logx=False, logy=False, logz=False, clim=None, base=10)

source code 

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

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