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

Class SimpleMapPlot

source code

object --+    
         |    
 BasicPlot --+
             |
            SimpleMapPlot

Class to create a clickable map html page.

Instance Methods [hide private]
 
__init__(self, *args, **kwargs)
Basic plot initialization.
source code
 
set_click_size(self, size)
Sets the size of the area around a point that can be clicked at.
source code
 
add_content(self, x_data, y_data, link, **kwargs)
Stub.
source code
 
finalize(self, loc=0)
Stub.
source code
 
rescale(self, dpi)
Calculate the rescaling to map the point coordinates to the actual coordinates on the image.
source code
 
create_html(self, plotname, dpi=None)
Create the html file with the name of the plot as the only additional input information needed.
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__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, *args, **kwargs)
(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, link, **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)

finalize(self, loc=0)

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)

create_html(self, plotname, dpi=None)

source code 

Create the html file with the name of the plot as the only additional input information needed. If the actual plot is saved with a different dpi than the standard one, it must be specified here!!