pylbo.visualisation.modes.cartesian_2d

Classes

CartesianSlicePlot2D

Class for handling Cartesian 2D plots of the eigenmode solutions.

Module Contents

class pylbo.visualisation.modes.cartesian_2d.CartesianSlicePlot2D(data: pylbo.visualisation.modes.mode_data.ModeVisualisationData, u2: float | numpy.ndarray, u3: float | numpy.ndarray, time: float, slicing_axis: str, figsize: tuple[int, int], show_ef_panel: bool, **kwargs)

Bases: pylbo.visualisation.modes.mode_figure.ModeFigure

Class for handling Cartesian 2D plots of the eigenmode solutions.

Parameters:

  • data (ModeVisualisationData) – The data for the visualisation.

  • u2 (float or ndarray) – The \(y\) coordinate of the eigenmode solution.

  • u3 (float or ndarray) – The \(z\) coordinate of the eigenmode solution.

  • time (float) – The time at which the eigenmode solution is calculated.

  • slicing_axis (str) – The axis along which the eigenmode solution is sliced.

  • figsize (tuple[int, int]) – The size of the figure.

  • show_ef_panel (bool) – Whether to show the eigenfunction panel.

  • **kwargs – Additional keyword arguments to be passed to matplotlib.pyplot.imshow().

slicing_axis
update_colorbar = True
_u1
_u2
_u3
_time
_kwargs
_use_contour_plot = False
_contour_levels = None
_contour_recipe = None
vmin
vmax
_validate_slicing_axis(slicing_axis: str, allowed_axes: list[str]) → str

Validates the slicing axis.

Parameters:

  • slicing_axis (str) – The slicing axis.

  • allowed_axes (list[str]) – The list of allowed axes.

Returns:

The validated slicing axis.

Return type:

str

_validate_u2(u2: float, slicing_axis: str, axis: str) → float

Validates the combination of u2 and slicing axis.

Parameters:

  • u2 (float) – The \(u_2\) coordinate.

  • slicing_axis (str) – The slicing axis.

  • axis (str) – The coordinate axis corresponding to \(u_2\).

Returns:

The validated \(u_2\) coordinate.

Return type:

float

_validate_u3(u3: float, slicing_axis: str, axis: str) → float

Validates the combination of u3 and slicing axis.

Parameters:

  • u3 (float) – The \(u_3\) coordinate.

  • slicining_axis (str) – The slicing axis.

  • axis (str) – The coordinate axis corresponding to \(u_3\).

Returns:

The validated \(u_3\) coordinate.

Return type:

float

set_plot_arrays() → None
add_u2u3_txt(ax, **kwargs) → None
set_contours(levels=None, fill=False) → None

Sets up a contour plot instead of an image plot.

Parameters:

  • levels (int or list[float]) – The number of levels or the list of levels.

  • fill (bool) – Whether to fill the contour plot.

draw_solution() → None
_draw_image() → None
_draw_contours() → None
get_view_ylabel() → str
create_animation(times: numpy.ndarray, filename: str, fps: float = 10, dpi: int = 200) → None
_ensure_first_frame_is_drawn() → None
_set_t_txt(t)
_update_view(updated_solution: numpy.ndarray) → None

Updates the axes with the new solution. If a contour plot is used, the contour lines are cleared and redrawn. If an image plot is used, the image is updated.

Parameters:

updated_solution (np.ndarray) – The new solution.

_update_view_clims(solution: numpy.ndarray) → None
_clear_contours()
_update_contour_plot(updated_solution: numpy.ndarray) → None