Plotting a dataset

A factory to create instances of DatasetPlot.

The module factory contains the DatasetPlotFactory class which is a factory to instantiate a DatasetPlot from its class name. The class can be internal to GEMSEO or located in an external module whose path is provided to the constructor. It also provides a list of available cache types and allows you to test if a cache type is available.

class gemseo.post.dataset.factory.DatasetPlotFactory

This factory instantiates a DatasetPlot from its class name.

Return type

None

create(plot_name, dataset, **options)

Create a plot for dataset.

Parameters

• plot_name (str) – The name of a plot method for dataset (its class name).

• dataset (Dataset) – The dataset to visualize.

• options – The additional options specific to this plot method.

Returns

A plot method built from the provided dataset.

Return type

DatasetPlot

is_available(plot_name)

Check the availability of a plot for dataset.

Parameters

plot_name (str) – The name of a plot method for dataset (its class name).

Returns

True if the plot method is available.

Return type

bool

property plots: list[str]

The available plot methods for dataset.

An abstract class to plot data from a Dataset.

The dataset_plot module implements the abstract DatasetPlot class whose purpose is to build a graphical representation of a Dataset and to display it on screen or save it to a file.

This abstract class has to be overloaded by concrete ones implementing at least method DatasetPlot._run().

class gemseo.post.dataset.dataset_plot.DatasetPlot(dataset, **kwargs)

Abstract class for plotting a dataset.

Parameters

• dataset (Dataset) – The dataset containing the data to plot.

• **kwargs (Any) –

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 and file_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]

color: str | list[str]

The color(s) for the series.

If empty, use a default one.

colormap: str

The color map.

dataset: Dataset

The dataset to be plotted.

fig_size: tuple[float, float]

The figure size.

property fig_size_x: float

The x-component of figure size.

property fig_size_y: float

The y-component of figure size.

font_size: int

The font size.

property labels: Mapping[str, str]

The labels of the variables.

legend_location: str

The location of the legend.

linestyle: str | list[str]

The line style(s) for the series.

If empty, use a default one.

marker: str | list[str]

The marker(s) for the series.

If empty, use a default one.

property output_files: list[str]

The paths to the output files.

title: str

The title of the plot.

xlabel: str

The label for the x-axis.

xmax: float | None

The maximum value on the x-axis.”

If None, compute it from data.

xmin: float | None

The minimum value on the x-axis.

If None, compute it from data.

ylabel: str

The label for the y-axis.

ymax: float | None

The maximum value on the y-axis.

If None, compute it from data.

ymin: float | None

The minimum value on the y-axis.

If None, compute it from data.

zlabel: str

The label for the z-axis.

zmax: float | None

The maximum value on the z-axis.

If None, compute it from data.

zmin: float | None

The minimum value on the z-axis.

If None, compute it from data.

Draw Andrews curves from a Dataset.

The AndrewsCurves class implements the Andrew plot, a.k.a. Andrews curves, which is a way to visualize \(n\) samples of a high-dimensional vector

\[x=(x_1,x_2,\ldots,x_d)\in\mathbb{R}^d\]

in a 2D referential by projecting each sample

\[x^{(i)}=(x_1^{(i)},x_2^{(i)},\ldots,x_d^{(i)})\]

onto the vector

\[\left(\frac{1}{\sqrt{2}},\sin(t),\cos(t),\sin(2t),\cos(2t), \ldots\right)\]

which is composed of the \(d\) first elements of the Fourier series:

\[f_i(t)=\left(\frac{x_1^{(i)}}{\sqrt{2}},x_2^{(i)}\sin(t),x_3^{(i)}\cos(t), x_4^{(i)}\sin(2t),x_5^{(i)}\cos(2t),\ldots\right)\]

Each curve \(t\mapsto f_i(t)\) is plotted over the interval \([-\pi,\pi]\) and structure in the data may be visible in these \(n\) Andrews curves.

A variable name can be passed to the DatasetPlot.execute() method by means of the classifier keyword in order to color the curves according to the value of the variable name. This is useful when the data is labeled.

class gemseo.post.dataset.andrews_curves.AndrewsCurves(dataset, classifier)

Andrews curves.

Parameters

• dataset (gemseo.core.dataset.Dataset) – The dataset containing the data to plot.

• classifier (str) – The name of the variable to group the data.

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 and file_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]

property fig_size_x: float

The x-component of figure size.

property fig_size_y: float

The y-component of figure size.

property labels: Mapping[str, str]

The labels of the variables.

property output_files: list[str]

The paths to the output files.

Draw curves from a Dataset.

A Curves plot represents samples of a functional variable \(y(x)\) discretized over a 1D mesh. Both evaluations of \(y\) and mesh are stored in a Dataset, \(y\) as a parameter and the mesh as a metadata.

class gemseo.post.dataset.curves.Curves(dataset, mesh, variable, samples=None)

Plot curves 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 the samples.

  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 and file_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]

property fig_size_x: float

The x-component of figure size.

property fig_size_y: float

The y-component of figure size.

property labels: Mapping[str, str]

The labels of the variables.

property output_files: list[str]

The paths to the output files.

Draw parallel coordinates from a Dataset.

The ParallelCoordinates class implements the parallel coordinates plot, a.k.a. cowebplot, which is a way to visualize \(n\) samples of a high-dimensional vector

\[x=(x_1,x_2,\ldots,x_d)\in\mathbb{R}^d\]

in a 2D referential by representing each sample

\[x^{(i)}=(x_1^{(i)},x_2^{(i)},\ldots,x_d^{(i)})\]

as a piece-wise line where the x-values of the nodes from left to right are the values of \(x_1\), \(x_2\), … and \(x_d^{(i)}\).

A variable name is required by the DatasetPlot.execute() method by means of the classifier keyword in order to color the curves according to the value of the variable name. This is useful when the data is labeled or when we are looking for the samples for which the classifier value is comprised in some interval specified by the lower and upper arguments (default values are set to -inf and inf respectively). In the latter case, the color scale is composed of only two values: one for the samples positively classified and one for the others.

class gemseo.post.dataset.parallel_coordinates.ParallelCoordinates(dataset, classifier, lower=- inf, upper=inf, **kwargs)

Parallel coordinates.

Parameters

• dataset (gemseo.core.dataset.Dataset) – The dataset containing the data to plot.

• classifier (str) – The name of the variable to group the data.

• lower (float) –

  The lower bound of the cluster.

  By default it is set to -inf.

• upper (float) –

  The upper bound of the cluster.

  By default it is set to inf.

• **kwargs – The description is missing.

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 and file_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]

property fig_size_x: float

The x-component of figure size.

property fig_size_y: float

The y-component of figure size.

property labels: Mapping[str, str]

The labels of the variables.

property output_files: list[str]

The paths to the output files.

Draw a radar visualization from a Dataset.

The Radar class implements the Radviz plot, which is a way to visualize \(n\) samples of a multi-dimensional vector

\[x=(x_1,x_2,\ldots,x_d)\in\mathbb{R}^d\]

in a 2D referential and to highlight the separability of the data.

For that, each sample

\[x^{(i)}=(x_1^{(i)},x_2^{(i)},\ldots,x_d^{(i)})\]

is rendered inside the unit disc with the influences of the different parameters evenly distributed on its circumference. Each parameter influence varies from 0 to 1 and can be interpreted compared to the others.

A variable name is required by the DatasetPlot.execute() method by means of the classifier keyword in order to color the curves according to the value of the variable name. This is useful when the data is labeled or when we are looking for the samples for which the classifier value is comprised in some interval specified by the lower and upper arguments (default values are set to -inf and inf respectively). In the latter case, the color scale is composed of only two values: one for the samples positively classified and one for the others.

class gemseo.post.dataset.radviz.Radar(dataset, classifier)

Radar visualization.

Parameters

• dataset (gemseo.core.dataset.Dataset) – The dataset containing the data to plot.

• classifier (str) – The name of the variable to group the data.

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 and file_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]

property fig_size_x: float

The x-component of figure size.

property fig_size_y: float

The y-component of figure size.

property labels: Mapping[str, str]

The labels of the variables.

property output_files: list[str]

The paths to the output files.

Draw a scatter matrix from a Dataset.

The ScatterMatrix class implements the scatter plot matrix, which is a way to visualize \(n\) samples of a multi-dimensional vector

\[x=(x_1,x_2,\ldots,x_d)\in\mathbb{R}^d\]

in several 2D subplots where the (i,j) subplot represents the cloud of points

\[\left(x_i^{(k)},x_j^{(k)}\right)_{1\leq k \leq n}\]

while the (i,i) subplot represents the empirical distribution of the samples

\[x_i^{(1)},\ldots,x_i^{(n)}\]

by means of an histogram or a kernel density estimator.

A variable name can be passed to the DatasetPlot.execute() method by means of the classifier keyword in order to color the curves according to the value of the variable name. This is useful when the data is labeled.

class gemseo.post.dataset.scatter_plot_matrix.ScatterMatrix(dataset, variable_names=None, classifier=None, kde=False, size=25, marker='o', plot_lower=True, plot_upper=True)

Scatter plot matrix.

Parameters

• dataset (Dataset) – The dataset containing the data to plot.

• variable_names (Sequence[str] | None) –

  The description is missing.

  By default it is set to None.

• classifier (str | None) –

  The name of the variable to build the cluster.

  By default it is set to None.

• kde (bool) –

  The type of the distribution representation. If True, plot kernel-density estimator on the diagonal. Otherwise, use histograms.

  By default it is set to False.

• size (int) –

  The size of the points.

  By default it is set to 25.

• marker (str) –

  The marker for the points.

  By default it is set to o.

• plot_lower (bool) –

  Whether to plot the lower part.

  By default it is set to True.

• plot_upper (bool) –

  Whether to plot the upper part.

  By default it is set to True.

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 and file_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]

property fig_size_x: float

The x-component of figure size.

property fig_size_y: float

The y-component of figure size.

property labels: Mapping[str, str]

The labels of the variables.

property output_files: list[str]

The paths to the output files.

Draw a scatter plot from a Dataset.

A Scatter plot represents a set of points \(\{x_i,y_i\}_{1\leq i \leq n}\) as markers on a classical plot where the color of points can be heterogeneous.

class gemseo.post.dataset.scatter.Scatter(dataset, x, y, x_comp=0, y_comp=0)

Plot curve y versus x.

Parameters

• dataset (gemseo.core.dataset.Dataset) – The dataset containing the data to plot.

• x (str) – The name of the variable on the x-axis.

• y (str) – The name of the variable on the y-axis.

• x_comp (str) –

  The component of x.

  By default it is set to 0.

• y_comp (str) –

  The component of y.

  By default it is set to 0.

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 and file_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]

property fig_size_x: float

The x-component of figure size.

property fig_size_y: float

The y-component of figure size.

property labels: Mapping[str, str]

The labels of the variables.

property output_files: list[str]

The paths to the output files.

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)

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 and file_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]

property fig_size_x: float

The x-component of figure size.

property fig_size_y: float

The y-component of figure size.

property labels: Mapping[str, str]

The labels of the variables.

property output_files: list[str]

The paths to the output files.

Draw a variable versus another from a Dataset.

A YvsX plot represents samples of a couple \((x,y)\) as a set of points whose values are stored in a Dataset. The user can select the style of line or markers, as well as the color.

class gemseo.post.dataset.yvsx.YvsX(dataset, x, y, x_comp=0, y_comp=0)

Plot curve y versus x.

Parameters

• dataset (gemseo.core.dataset.Dataset) – The dataset containing the data to plot.

• x (str) – The name of the variable on the x-axis.

• y (str) – The name of the variable on the y-axis.

• x_comp (int) –

  The component of x.

  By default it is set to 0.

• y_comp (int) –

  The component of y.

  By default it is set to 0.

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 and file_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]

property fig_size_x: float

The x-component of figure size.

property fig_size_y: float

The y-component of figure size.

property labels: Mapping[str, str]

The labels of the variables.

property output_files: list[str]

The paths to the output files.

Draw a variable versus two others from a Dataset.

A ZvsXY plot represents the variable \(z\) with respect to \(x\) and \(y\) as a surface plot, based on a set of points :points \(\{x_i,y_i,z_i\}_{1\leq i \leq n}\). This interpolation is relies on the Delaunay triangulation of \(\{x_i,y_i\}_{1\leq i \leq n}\)

class gemseo.post.dataset.zvsxy.ZvsXY(dataset, x, y, z, x_comp=0, y_comp=0, z_comp=0, add_points=False, fill=True, levels=None, other_datasets=None)

Plot surface z versus x,y.

Parameters

• dataset (Dataset) – The dataset containing the data to plot.

• x (str) – The name of the variable on the x-axis.

• y (str) – The name of the variable on the y-axis.

• z (str) – The name of the variable on the z-axis.

• x_comp (int) –

  The component of x.

  By default it is set to 0.

• y_comp (int) –

  The component of y.

  By default it is set to 0.

• z_comp (int) –

  The component of z.

  By default it is set to 0.

• add_points (bool) –

  Whether to display the entries of the dataset as points above the surface.

  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.

• other_datasets (Iterable[Dataset]) –

  Additional datasets to be plotted as points above the surface.

  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 and file_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]

property fig_size_x: float

The x-component of figure size.

property fig_size_y: float

The y-component of figure size.

property labels: Mapping[str, str]

The labels of the variables.

property output_files: list[str]

The paths to the output files.