gemseo_calibration / post

Show inherited members

multiple_scatter module

Overlay several scatter plots from a Dataset.

A Scatter plot represents a set of points \(\{x_i,y_i\}_{1\leq i \leq n}\) as markers on a classical plot, while a MultipleScatter plot represents a set of points \(\{x_i,y_{i,1},\ldots,y_{i,d}\}_{1\leq i \leq n}\) as markers on a classical plot, with one color per series \(\{y_i\}_{1\leq i \leq n}\).

class gemseo_calibration.post.multiple_scatter.MultipleScatter(dataset, x, y, x_comp=0, y_comp=mappingproxy({}))[source]

Bases: DatasetPlot

Overlay several scatter y_i versus x.

Parameters:

  • dataset (Dataset) – The dataset containing the data to plot.

  • x (str) – The name of the variable on the x-axis.

  • y (str | Iterable[str]) – The names of the variables on the y-axis.

  • x_comp (int) –

    The component of x.

    By default it is set to 0.

  • y_comp (Mapping[str, int]) –

    The components of y, where the names are the names of the variables and the values are the components. If empty or if a name is missing, use the first component.

    By default it is set to {}.

Raises:

ValueError – If the dataset is empty.

color: str | list[str]

The color(s) for the series.

If empty, use a default one.

colormap: str

The color map.

dataset: Dataset

The dataset to be plotted.

fig_size: FigSizeType

The figure size.

font_size: int

The font size.

legend_location: str

The location of the legend.

linestyle: str | list[str]

The line style(s) for the series.

If empty, use a default one.

marker: str | list[str]

The marker(s) for the series.

If empty, use a default one.

title: str

The title of the plot.

xlabel: str

The label for the x-axis.

xmax: float | None

The maximum value on the x-axis.”.

If None, compute it from data.

xmin: float | None

The minimum value on the x-axis.

If None, compute it from data.

xtick_rotation: float

The rotation angle in degrees for the x-ticks.

ylabel: str

The label for the y-axis.

ymax: float | None

The maximum value on the y-axis.

If None, compute it from data.

ymin: float | None

The minimum value on the y-axis.

If None, compute it from data.

zlabel: str

The label for the z-axis.

zmax: float | None

The maximum value on the z-axis.

If None, compute it from data.

zmin: float | None

The minimum value on the z-axis.

If None, compute it from data.