Package schrodinger :: Package analysis :: Module enrichment :: Class Plotter

[frames] | no frames]

Class Plotter

  object --+    
           |    
_BasePlotter --+
               |
              Plotter


A class to plot multiple series of Calculator data.

API example
-----------
Where <enrich_calc1> and <enrich_calc2> are instances of Calculator:

enrich_plotter = enrichment.Plotter([enrich_calc1, enrich_calc2])
enrich_plotter.plot() # Launch interactive plot window.
enrich_plotter.savePlot('my_plot.png') # Save plot to file. 

There are six line styles defined by default.  Plotting more than
six results cycles through the styles.

Instance Methods

__init__(self, calcs, title='Screen Results')
Returns: None

list

getPointsFromCalc(self, calc)
Returns points for this metric from the given Calculator instance.

str

getLegendLabel(self, calc)
Return the string to show in the series legend.

Inherited from _BasePlotter: addReferenceSeries, addSeries, getPlotFigure, plot, savePlot, showPlotWindow

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

Properties

Inherited from object: __class__

Method Details

init(self, calcs, title=`'Screen Results'`)
(Constructor)

x.__init__(...) initializes x; see help(type(x)) for signature

Parameters:

calcs (list) - List of Calculator instances.
title (string) - The plot title.

Returns:

None

Overrides: object.__init__

getPointsFromCalc(self, calc)

Returns points for this metric from the given Calculator instance.

Parameters:

calc (Calculator
@return List of (x, y) points
) - Calculator instance.

Returns: list

Overrides: _BasePlotter.getPointsFromCalc

getLegendLabel(self, calc)

Return the string to show in the series legend.

Parameters:

calc (Calculator) - Calculator instance.

Returns: str

Label string

Overrides: _BasePlotter.getLegendLabel