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:
gemseo.post.dataset.dataset_plot.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.
By default it is set to None.
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]) –
Either the number of contour lines or the values of the contour lines in increasing order. If
None
, select them automatically.By default it is set to None.
- 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]