Plotter.distrib_attributes

Plotter.distrib_attributes(block: str | None = None, attributes: List[str] | None = None, transformed: bool = False, per_column: bool = False, n_cols: int = 3, sub_figs: bool = False, bottom_top: Tuple[float, float] = (0.1, 0.9), downsamp: int = 2, flag_compare_to_error: bool = False, output_name: str | None = None) → Figure | None[source]

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

Parameters:

  • block (str, optional, default=None) – Name of the data block to be plotted. The block must be available in the dataset or in the datamodule. If None, the block is automatically selected based on the attributes.

  • attributes (List[str], optional, default=None) – List of attributes (= names of DataObject’s) to be plotted. If None, all attributes are plotted. If the block argument is not None, the attributes need to be provided.

  • transformed (bool, optional, default=False) – If True, the data is plotted transformed, while False returns the plots it in its original domain

  • per_column (bool, optional, default=False) – If True, each column (= dimension) of a DataObject is plotted as separate trace, otherwise all data is flattened to a single trace.

  • n_cols (int, optional, default=3) – Number of columns in the plot. Argument is ignored if sub_figs=True.

  • sub_figs (bool, optional, default=False) – If True, each trace is plotted in a separate figure.

  • bottom_top (Tuple[float, float], optional, default=(0.1, 0.9)) – Tuple of two floats, defining the percentile lines (bottom and top) to be plotted in the histogram as vertical lines.

  • downsamp (int, optional, default=2) – Down-sampling factor for the data.

  • flag_compare_to_error (bool, optional, default=False) – If True, the distribution of the selected attributes is plotted for the samples with and without errors separately as two traces.

  • output_name (str, optional, default=None) – Name of the output file. If None, the name is automatically generated from the block name.

Returns:

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