sampo.utilities.visualization.base#

Overview#

Classes#
`VisualizationMode`	Support for flags

Function#
`visualize`(fig, mode, file_name)	Visualizes the figure according to the provided settings

class sampo.utilities.visualization.base.VisualizationMode#

Bases: enum.Flag

Support for flags

sampo.utilities.visualization.base.visualize(fig: plotly.graph_objects.Figure | matplotlib.pyplot.Figure, mode: VisualizationMode, file_name: str = None) → plotly.graph_objects.Figure | matplotlib.pyplot.Figure | None#: Visualizes the figure according to the provided settings :param fig: The figure :param mode: Visualisation mode. Can be bitwise-or (|) of several modes. :param file_name: Optional name of a saved file. Passed, if SaveFig in mode. :return: The figure, if ReturnFig in mode. Otherwise, None.