ogstools.meshplotlib.plot_setup module#

Plot configuration setup.

class ogstools.meshplotlib.plot_setup.PlotSetup[source]#

Bases: object

Configuration class for easy plot adjustments.

Each entry has a default value as listed in ogstools.meshplotlib.plot_setup_defaults.

combined_colorbar: bool#: True if all subplots share on colorbar, else each has its own colorbar.

dpi: int#: The resolution (dots per inch) for the figure.

fig_scale: float#: A scaling factor for the figure.

min_ax_aspect: float | None#: Minimum aspect ratio of subplots.

max_ax_aspect: float | None#: Maximum aspect ratio of subplots.

invert_colorbar: bool#: A boolean indicating whether to invert the colorbar.

layout: str#: Layout of the figure

length: Scalar#: A property to set data and output unit of a models spatial extension.

material_names: dict#: A dictionary that maps material names to regions (MaterialIDs).

num_levels: int#: The aimed number of levels / bins of the colorbar. See ogstools.meshplotlib.levels

num_streamline_interp_pts: int | None#: The number of interpolation points for streamlines.

p_max: float | None#: The fixed upper limit for the current scale.

p_min: float | None#: The fixed lower limit for the current scale.

__init__(combined_colorbar, dpi, fig_scale, min_ax_aspect, max_ax_aspect, invert_colorbar, layout, length, material_names, num_levels, num_streamline_interp_pts, p_max, p_min, rcParams, show_element_edges, title_center, title_left, title_right, x_label, y_label, log_scaled, show_region_bounds, embedded_region_names_color)#

Parameters:

combined_colorbar (bool)
dpi (int)
fig_scale (float)
min_ax_aspect (float | None)
max_ax_aspect (float | None)
invert_colorbar (bool)
layout (str)
length (Scalar)
material_names (dict)
num_levels (int)
num_streamline_interp_pts (int | None)
p_max (float | None)
p_min (float | None)
rcParams (dict)
show_element_edges (bool | str)
title_center (str)
title_left (str)
title_right (str)
x_label (str)
y_label (str)
log_scaled (bool)
show_region_bounds (bool)
embedded_region_names_color (str)

Return type:

None

rcParams: dict#: Matplotlib runtime configuration. See ogstools.meshplotlib.plot_setup_defaults

show_element_edges: bool | str#: Controls the display of element edges, can be a boolean or ‘str’. In the latter case element edges are always shown for if the name matches the property data name.

title_center: str#: The center part of the plot’s title.

title_left: str#: The left part of the plot’s title.

title_right: str#: The right part of the plot’s title.

x_label: str#: The label for the x-axis.

y_label: str#: The label for the y-axis.

log_scaled: bool#: A boolean indicating whether the scaling should be logarithmic.

show_region_bounds: bool#: Controls the display of region (MaterialIDs) edges.

embedded_region_names_color: str#: Color of the embedded region names inside the plot.

property rcParams_scaled: dict#: Get the scaled rcParams values.

classmethod from_dict(obj)[source]#

Create a PlotSetup instance from a dictionary.

Parameters:: obj (dict)
Return type:: PlotSetup

reset()[source]#

Reset the plot setup to default values.

Return type:: None