surfaces module¶
Draw surfaces from a Dataset
.
A Surfaces
plot represents samples
of a functional variable \(z(x,y)\) discretized over a 2D mesh.
Both evaluations of \(z\) and mesh are stored in a Dataset
,
\(z\) as a parameter and the mesh as a metadata.
- class gemseo.post.dataset.surfaces.Surfaces(dataset, mesh, variable, samples=None, add_points=False, fill=True, levels=None)[source]¶
Bases:
DatasetPlot
Plot surfaces y_i over the mesh x.
- Parameters:
dataset (Dataset) – The dataset containing the data to plot.
mesh (str) – The name of the dataset metadata corresponding to the mesh.
variable (str) – The name of the variable for the x-axis.
samples (Sequence[int] | None) – The indices of the samples to plot. If
None
, plot all samples.add_points (bool) –
If
True
then display the samples over the surface plot.By default it is set to False.
fill (bool) –
Whether to generate a filled contour plot.
By default it is set to True.
levels (int | Sequence[int] | None) – Either the number of contour lines or the values of the contour lines in increasing order. If
None
, select them automatically.
- Raises:
ValueError – If the dataset is empty.
- class PlotEngine(value)¶
Bases:
StrEnum
An engine of plots.
- MATPLOTLIB = 'MatplotlibPlotFactory'¶
- PLOTLY = 'PlotlyPlotFactory'¶
- execute(save=True, show=False, file_path='', directory_path='', file_name='', file_format='png', file_name_suffix='', **engine_parameters)¶
Execute the post-processing.
- Parameters:
save (bool) –
Whether to save the plot.
By default it is set to True.
show (bool) –
Whether to display the plot.
By default it is set to False.
file_path (str | Path) –
The path of the file to save the figures. If empty, create a file path from
directory_path
,file_name
andfile_format
.By default it is set to “”.
directory_path (str | Path) –
The path of the directory to save the figures. If empty, use the current working directory.
By default it is set to “”.
file_name (str) –
The name of the file to save the figures. If empty, use a default one generated by the post-processing.
By default it is set to “”.
file_format (str) –
A file format, e.g. ‘png’, ‘pdf’, ‘svg’, …
By default it is set to “png”.
file_name_suffix (str) –
The suffix to be added to the file name.
By default it is set to “”.
**engine_parameters (Any) – The parameters specific to the plot engine.
- Returns:
The figures.
- Return type:
- DEFAULT_PLOT_ENGINE: ClassVar[PlotEngine] = 'MatplotlibPlotFactory'¶
The default engine of plots.
- FILE_FORMATS_TO_PLOT_ENGINES: ClassVar[dict[str, PlotEngine]] = {'html': PlotEngine.PLOTLY}¶
The file formats bound to the engines of plots.
The method
execute()
uses this dictionary to select the engine of plots associated with itsfile_format
argument. If missing, the method uses theDEFAULT_PLOT_ENGINE
.
- property color: str | list[str]¶
The color.
Either a global one or one per item if
n_items
is non-zero. If empty, use a default one.
- property fig_size: FigSizeType¶
The figure size.
- property linestyle: str | Sequence[str]¶
The line style.
Either a global one or one per item if
n_items
is non-zero. If empty, use a default one.