Plottable

class optika.mixins.Plottable

Bases: ABC

An object that can be plotted.

Attributes

kwargs_plot

Extra keyword arguments that will be used in the call to named_arrays.plt.plot() within the plot() method.

Methods

__init__()
plot([ax, transformation, components])	Plot the selected components onto the given axes.

Inheritance Diagram

abstractmethod plot(ax=None, transformation=None, components=None, **kwargs)

Plot the selected components onto the given axes.

Parameters:

• ax (None | Axes | ScalarArray[ndarray[tuple[Any, ...], dtype[_ScalarT]]]) – The matplotlib axes to plot onto

• transformation (None | AbstractTransformation) – Any extra transformations to apply to the coordinate system before plotting

• components (None | tuple[str, ...]) – Which 3d components to plot, helpful if plotting in 2d.

• kwargs – Additional keyword arguments that will be passed along to named_arrays.plt.plot()

Return type:

AbstractScalar | dict[str, AbstractScalar]

abstract property kwargs_plot: None | dict

Extra keyword arguments that will be used in the call to named_arrays.plt.plot() within the plot() method.