gemseo.post.scatter_plot_matrix_settings module#

Settings for post-processing.

Settings ScatterPlotMatrix_Settings(*, save=True, show=False, file_path='', directory_path='', file_name='', file_extension='', fig_size=(10.0, 10.0), filter_non_feasible=False, variable_names=())[source]#

Bases: BasePostSettings

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

  • save (bool) --

    By default it is set to True.

  • show (bool) --

    By default it is set to False.

  • file_path (Path | str) --

    By default it is set to "".

  • directory_path (Path | str) --

    By default it is set to "".

  • file_name (str) --

    By default it is set to "".

  • file_extension (str) --

    By default it is set to "".

  • fig_size (tuple[Annotated[float, Gt(gt=0)], Annotated[float, Gt(gt=0)]]) --

    By default it is set to (10.0, 10.0).

  • filter_non_feasible (bool) --

    By default it is set to False.

  • variable_names (Sequence[str]) --

    By default it is set to ().

Return type:

None

filter_non_feasible: bool = False#

Whether to remove the non-feasible points from the data.

variable_names: Sequence[str] = ()#

The functions names or design variables to plot. If empty, plot all design variables.

model_post_init(context, /)#

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that's what pydantic-core passes when calling it.

Parameters:

  • self (BaseModel) -- The BaseModel instance.

  • context (Any) -- The context.

Return type:

None