src.plot.plot

Classes

Plot(**kwargs)

Exceptions

PlotException([message])

exception src.plot.plot.PlotException(message='')

Author:

Alberto M. Esmoris Pena

Class for exceptions related to plot components. See VL3DException

__init__(message='')

class src.plot.plot.Plot(**kwargs)

Author:

Alberto M. Esmoris Pena

Abstract class providing the interfaces governing any plot.

Variables:

• path (str) – The path to save the plot to a file.

• show (bool) – The boolean flag controlling whether to show the plot (True) or not (False).

__init__(**kwargs)

Root initialization for any instance of type Plot.

Parameters:

kwargs – The attributes for the plot.

abstractmethod plot(**kwargs)

Do the plot effective. The typical steps are:

1. Do plot computations, i.e., prepare the plot, build the plot, and format the plot.

2. If the plot is associated to a path, then write it to the corresponding file.

3. If the show flag is true, visualize the plot.

Returns:

Nothing.