radar_chart module¶
Draw a radar chart from a Dataset
.
- class gemseo.post.dataset.radar_chart.RadarChart(dataset, display_zero=True, connect=False, radial_ticks=False, n_levels=6, scientific_notation=True)[source]¶
Bases:
gemseo.post.dataset.dataset_plot.DatasetPlot
Radar Chart visualization.
- Parameters
dataset (gemseo.core.dataset.Dataset) – The dataset containing the data to plot.
display_zero (bool) –
Whether to display the line where the output is equal to zero.
By default it is set to True.
connect (bool) –
Whether to connect the elements of a series with a line.
By default it is set to False.
radial_ticks (bool) –
Whether to align the ticks names with the radius.
By default it is set to False.
n_levels (int) –
The number of grid levels.
By default it is set to 6.
scientific_notation (bool) –
Whether to format the grid levels with the scientific notation.
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
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]