|
OpenMPCD
|
Public Member Functions | |
| def | __init__ (self) |
| def | run (self) |
| def | provideData (self, x, y, show=True, label=None, characteristics=None) |
| def | provideDataFile (self, path, characteristics={}) |
| def | provideDataDirectory (self, path, characteristics={}, recursive=False) |
| def | setXScale (self, scale) |
| def | setYScale (self, scale) |
| def | setPlotDashedIfNegative (self, state) |
| def | hideCharacteristics (self, toHide) |
| def | setCharacteristicsOrder (self, order) |
| def | setSortingCharacteristic (self, characteristic, ascending) |
| def | toggleVisibility (self, plotID) |
| def | replot (self) |
| def | plot (self, x, y, **kwargs) |
Public Attributes | |
| app | |
| plots | |
| nextPlotID | |
Graphical User Interface for plotting data.
@var _plotDashedIfNegative Whether the negative parts of plots should instead be plotted
positively, but with dashed lines.
@var _yScaleIsLog Whether the y axis is logarithmic.
@var _plotSelector Instance of _PlotSelectionList used to select plots for display.
@var _hiddenCharacteristics List of plot characteristics that are hidden in the plot selector.
@var _characteristicsOrder Order of the plot characteristics.
Definition at line 21 of file Plotter.py.
| def MPCDAnalysis.InteractivePlotter.Plotter.Plotter.hideCharacteristics | ( | self, | |
| toHide | |||
| ) |
Hides the given characteristics from the plot selection window.
@param[in] toHide A list of plot characteristics to hide.
Definition at line 169 of file Plotter.py.
| def MPCDAnalysis.InteractivePlotter.Plotter.Plotter.provideData | ( | self, | |
| x, | |||
| y, | |||
show = True, |
|||
label = None, |
|||
characteristics = None |
|||
| ) |
Provides a new plot by specifying the x and y coordinates.
@param[in] x A list of x coordinates.
@param[in] y A list of y coordinates corresponding to the x coordinates.
@param[in] show Whether to draw the plot initially, as a bool.
@param[in] label The label for the plot.
@param[in] characteristics Plot characteristics, as used in the plot selection window.
@throw TypeError Throws if show is not of type bool.
Definition at line 46 of file Plotter.py.
| def MPCDAnalysis.InteractivePlotter.Plotter.Plotter.provideDataDirectory | ( | self, | |
| path, | |||
characteristics = {}, |
|||
recursive = False |
|||
| ) |
Adds all files in the given directory to the available data files.
Each file corresponds to a plot.
The added plots are not drawn on the canvas.
@param[in] path The path to the directory to be added.
@param[in] characteristics A dictionary of characteristics for all plots.
Conflicting file comments are ignored.
@param[in] recursive Whether to traverse the directory recursively.
@throw FileFormatException Any of the given files did not adhere to the expected format,
as described in provideDataFile.
Definition at line 136 of file Plotter.py.
| def MPCDAnalysis.InteractivePlotter.Plotter.Plotter.provideDataFile | ( | self, | |
| path, | |||
characteristics = {} |
|||
| ) |
Adds the given file, or rather its contents, to the list of available plots.
The added plot is not drawn on the canvas.
Each line in the file that is of the form
#name = value
is considered to describe the plot's characteristic "name", the value of which
is "value". "value" is treated as a float, if possible, and as a string otherwise.
Any other line must consist of a float, followed by a space, and another float.
The first float corresponds to the x coordinate of a plot point, the second
float is the corresponding y coordinate.
@param[in] path The path to the file.
@param[in] characteristics A dictionary of characteristics for the plot.
Conflicting file comments are ignored.
@throw FileFormatException Throws if the given file did not adhere to the expected format.
Definition at line 84 of file Plotter.py.
| def MPCDAnalysis.InteractivePlotter.Plotter.Plotter.setCharacteristicsOrder | ( | self, | |
| order | |||
| ) |
Sets the order in which plot characteristics are displayed in the plot selection window.
@param[in] order An ordered list of characteristics to display. Characteristics not in
this list will be displayed in undetermined order after all
characteristics present in this list.
Definition at line 182 of file Plotter.py.
| def MPCDAnalysis.InteractivePlotter.Plotter.Plotter.setSortingCharacteristic | ( | self, | |
| characteristic, | |||
| ascending | |||
| ) |
Sets by which characteristic to sort the plots in the plot selection window.
@param[in] characteristic The characteristic name to sort by.
@param[in] ascending Set to true to sort by ascending values, false for descending.
@throw InvalidArgumentException Throws if there is no such characteristic.
Definition at line 194 of file Plotter.py.
1.8.17