Plotter.distrib_attributes2d

Plotter.distrib_attributes2d(block: str | List[str], attributes: List[str] | None = None, transformed: bool = False, downsamp: int = 2, output_name: str | None = None) Figure | None[source]

Plots the 2D joint distribution of all the selected attributes (= DataObject’s) in the given data blocks.

Parameters:
  • block (Union[str, List[str]]) – Name or list of names of the data blocks to be plotted. The blocks must be available in the dataset or in the datamodule.

  • attributes (List[str], optional, default=None) – List of attributes (= names of DataObject’s) to be plotted. If None, all attributes of the blocks are plotted.

  • 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.

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

Returns:

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