gemseo.post.dataset.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 Surfaces(dataset, mesh, variable, samples=(), add_points=False, fill=True, levels=())

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]) --

  The indices of the samples to plot. If empty, plot all samples.

  By default it is set to ().

• 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 empty, select them automatically.

  By default it is set to ().

Raises:

ValueError -- If the dataset is empty.