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 misc.
- 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 misc 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]) – 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.
- 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.
- title: str
The title of the plot.
- xlabel: str
The label for the x-axis.
- ylabel: str
The label for the y-axis.
- zlabel: str
The label for the z-axis.