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.
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.
- execute(save=True, show=False, file_path=None, directory_path=None, file_name=None, file_format=None, properties=None, fig=None, axes=None, **plot_options)¶
Execute the post-processing.
- Parameters:
save (bool) –
If True, save the plot.
By default it is set to True.
show (bool) –
If True, display the plot.
By default it is set to False.
file_path (str | Path | None) – The path of the file to save the figures. If None, create a file path from
directory_path
,file_name
andfile_format
.directory_path (str | Path | None) – The path of the directory to save the figures. If None, use the current working directory.
file_name (str | None) – The name of the file to save the figures. If None, use a default one generated by the post-processing.
file_format (str | None) – A file format, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.
properties (Mapping[str, DatasetPlotPropertyType] | None) – The general properties of a
DatasetPlot
.fig (None | Figure) – The figure to plot the data. If
None
, create a new one.axes (None | Axes) – The axes to plot the data. If
None
, create new ones.**plot_options – The options of the current class inheriting from
DatasetPlot
.
- Returns:
The figures.
- Raises:
AttributeError – When the name of a property is not the name of an attribute.
- Return type:
list[Figure]
- fig_size: FigSizeType¶
The figure size.