plot_contour

ReportPlotter.plot_contour(trace: int = 0, polar: bool = False, levels: int = 64, max_theta: int = 360, min_theta: int = 0, color_bar=None, snapshot_path=None, show: bool = True, figure=None, is_spherical: bool = True, normalize=None)

Create a Matplotlib figure contour based on a list of data.

Parameters:

traceint, str, optional

Trace index on which create the 3D Plot.

polarbool, optional

Generate the plot in polar coordinates. The default is True. If False, the plot generated is rectangular.

levelsint, optional

Number of color map levels. The default is 64.

max_thetafloat or int, optional

Maximum theta angle for plotting polar data. The default is 360.

min_thetafloat or int, optional

Minimum theta angle for plotting polar data. The default is 0.

color_barstr, optional

Color bar title. The default is None in which case the color bar is not included.

snapshot_pathstr, optional

Full path to image file if a snapshot is needed. The default value is None.

showbool, optional

Whether to show the plot or return the matplotlib object. Default is True.

figurematplotlib.pyplot.Figure, optional

An existing Matplotlib Figure to which the plot is added. If not provided, a new Figure and Axes object are created.

is_sphericalbool, optional

Whether to use spherical or cartesian data.

normalizelist, optional

Normalize the color scale using the provided [vmin, vmax] values. If not provided or invalid, automatic normalization is applied.

Returns:

matplotlib.pyplot.Figure

Matplotlib figure object.