ogstools.plot.utils module#

ogstools.plot.utils.justified_labels(points)[source]#

Formats an array of points to a list of aligned str.

Return type:

list[str]

ogstools.plot.utils.label_spatial_axes(fig, axes, x_var, y_var)[source]#

Add labels to x and y axis.

If given an array of axes, only the outer axes will be labeled.

Return type:

None

ogstools.plot.utils.label_ax(fig, ax, x_label, y_label, fontsize=None)[source]#

Labels the x- and y-Axes according to the given Variables.

Accounts for shared axes and if that’s the case, only the first axes in a row or column will be labeled.

Return type:

None

ogstools.plot.utils.update_font_sizes(axes, fontsize=None)[source]#

Update font sizes of labels and texts.

This also scales the ticks accordingly.

Parameters:

  • ax – matplotlib axes which should be updated

  • fontsize (float | None) – font size for the labels and ticks

Return type:

None

ogstools.plot.utils.get_data_aspect(mesh)[source]#

Calculate the data aspect ratio of a 2D mesh.

Return type:

float

ogstools.plot.utils.get_rows_cols(meshes)[source]#
Return type:

tuple[int, ...]

ogstools.plot.utils.get_projection(mesh)[source]#

Identify which projection is used: XY, XZ or YZ.

Parameters:

mesh (UnstructuredGrid) – singular mesh

Return type:

tuple[int, int, int, ndarray]

Returns:

x_id, y_id, projection, mean_normal

ogstools.plot.utils.save_animation(anim, filename, fps)[source]#

Save a FuncAnimation with some codec presets.

Parameters:

  • anim (FuncAnimation) – the FuncAnimation to be saved

  • filename (str) – the name of the resulting file

  • fps (int) – the number of frames per second

Return type:

None

ogstools.plot.utils.get_cmap_norm(levels, variable, **kwargs)[source]#

Construct a discrete colormap and norm for the variable field.

Return type:

tuple[Colormap, Normalize]

ogstools.plot.utils.contrast_color(color)[source]#

Return black or white - whichever has more contrast to color.

https://stackoverflow.com/questions/3942878/how-to-decide-font-color-in-white-or-black-depending-on-background-color

Return type:

tuple[float, float, float] | str | tuple[float, float, float, float] | tuple[tuple[float, float, float] | str, float] | tuple[tuple[float, float, float, float], float]

ogstools.plot.utils.colors_from_cmap(cmap, num)[source]#

Convert a colormap to a list of colors.

Return type:

list[str]

ogstools.plot.utils.padded(ax, x, y, pad_x=True)[source]#

Add a padding to x and y towards the axes center.

Return type:

tuple[float, float]

ogstools.plot.utils.color_twin_axes(axes, colors)[source]#
Return type:

None