CADETProcess.plotting.setup_figure

Contents

CADETProcess.plotting.setup_figure#

CADETProcess.plotting.setup_figure(n_rows: int | None = 1, n_cols: int | None = 1, style: str | None = None, squeeze: bool | None = True) tuple[Figure, Axes][source]#

Set up a matplotlib figure with specified dimensions and style.

Parameters:
n_rowsint, optional

Number of rows in the figure, by default 1.

n_colsint, optional

Number of columns in the figure, by default 1.

stylestr, optional

Style to use for the figure. Uses a predefined style if None.

squeezebool, optional

If True, extra dimensions are removed from the returned Axes array, by default True.

Returns:
tuple[Figure, Axes]

A tuple containing the Figure object and an Axes object or an array of Axes objects.