Plotter.contours2d

Plotter.contours2d(blocks: List[str] | None = None, attributes: List[str] | None = None, transformed: bool = False, downsamp: int = 2, smoothing: float = 1, output_name: str | None = None) → Figure | None[source]

Plots the 2D contours of all the selected attributes (= DataObject’s) in the given data block.

Parameters:

blocks (List[str], optional, default=None) – Name(s) of the data blocks to be plotted. The block must be available in the dataset or in the datamodule. If specified, attributes argument is ignored, and instead all attributes (variables) belonging to each block will be plotted.
attributes (List[str], optional, default=None) – List of attributes (i.e. variable names) to be plotted if no blocks are specified. If None, then at least one data block must be specified.
transformed (bool, optional, default=False) – If True, the data is plotted transformed, while False returns the plots it in its original domain
downsamp (int, optional, default=2) – Down-sampling factor for the data.
smoothing (float, optional, default=1) – Smoothing factor between 0 and 1.3 for the contours lines in the contour plot.
output_name (str, optional, default=None) – Name of the output file. If None, the name is automatically generated from the data block name.

Returns:

Optional[plotly.graph_objects.Figure] – Plotly figure object, if self.output is None, otherwise None.