gemseo / post / dataset

Show inherited members

color_evolution module

Evolution of the variables by means of a color scale.

class gemseo.post.dataset.color_evolution.ColorEvolution(dataset, variables=None, use_log=False, opacity=0.6, **options)[source]

Bases: DatasetPlot

Evolution of the variables by means of a color scale.

Based on the matplotlib function imshow().

Tip

Use colormap to set a matplotlib colormap, e.g. "seismic".

Parameters:

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

  • variables (Iterable[str] | None) – The variables of interest If None, use all the variables.

  • use_log (bool) –

    Whether to use a symmetric logarithmic scale.

    By default it is set to False.

  • opacity (float) –

    The level of opacity (0 = transparent; 1 = opaque).

    By default it is set to 0.6.

  • **options (bool | float | str | None) – The options for the matplotlib function imshow().

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.

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.