lines module¶
Connect the observations of variables stored in a Dataset
with lines.
- class gemseo.post.dataset.lines.Lines(dataset, variables=None, abscissa_variable=None, add_markers=False)[source]¶
Bases:
gemseo.post.dataset.dataset_plot.DatasetPlot
Connect the observations of variables with lines.
- Parameters
dataset (Dataset) – The dataset containing the data to plot.
variables (Sequence[str] | None) –
The names of the variables to plot.
By default it is set to None.
abscissa_variable (str | None) –
The name of the variable used in abscissa. The observations of the
variables
are plotted in function of the observations of thisabscissa_variable
. IfNone
, the observations of thevariables
are plotted in function of the indices of the observations.By default it is set to None.
add_markers (bool) –
Whether to mark the observations with dots.
By default it is set to False.
- Raises
ValueError – If the dataset is empty.
- Return type
None
- 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
.By default it is set to None.
directory_path (str | Path | None) –
The path of the directory to save the figures. If None, use the current working directory.
By default it is set to None.
file_name (str | None) –
The name of the file to save the figures. If None, use a default one generated by the post-processing.
By default it is set to None.
file_format (str | None) –
A file format, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.
By default it is set to None.
properties (Mapping[str, DatasetPlotPropertyType] | None) –
The general properties of a
DatasetPlot
.By default it is set to None.
fig (None | Figure) –
The figure to plot the data. If
None
, create a new one.By default it is set to None.
axes (None | Axes) –
The axes to plot the data. If
None
, create new ones.By default it is set to None.
**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]