BF-MATH-GEOMETRY - Geometric Figures

../../../../../../../_images/MLPro-BF-Math-Geometry_class_diagram.drawio.png

Ver. 1.4.1 (2024-05-07)

This module provides class for geometric objects like points, etc.

class mlpro.bf.math.geometry.Point(p_derivative_order_max: int = 0, p_visualize: bool = False)

Bases: Property

Implementation of a point in a hyper space. Current position, velocity and acceleration are managed.

Parameters:

  • derivative_order_max (DerivativeOrderMax) – Maximum order of auto-generated derivatives (numeric properties only).

  • p_visualize (bool) – Boolean switch for visualisation. Default = False.

C_PLOT_ACTIVE: bool = True
init_plot(p_figure: Figure = None, p_plot_settings: PlotSettings = None, **p_kwargs)

Initializes the plot functionalities of the class.

Parameters:

  • p_figure (Matplotlib.figure.Figure, optional) – Optional MatPlotLib host figure, where the plot shall be embedded. The default is None.

  • p_plot_settings (PlotSettings) – Optional plot settings. If None, the default view is plotted (see attribute C_PLOT_DEFAULT_VIEW).

_update_plot_2d(p_settings: PlotSettings, **p_kwargs)

Custom method to update the 2d plot. The related MatPlotLib Axes object is stored in p_settings.

Parameters:

  • p_settings (PlotSettings) – Object with further plot settings.

  • **p_kwargs – Implementation-specific data and parameters.

_update_plot_3d(p_settings: PlotSettings, **p_kwargs)

Custom method to update the 3d plot. The related MatPlotLib Axes object is stored in p_settings.

Parameters:

  • p_settings (PlotSettings) – Object with further plot settings.

  • **p_kwargs – Implementation-specific data and parameters.

_update_plot_nd(p_settings: PlotSettings, **p_kwargs)

Custom method to update the nd plot. The related MatPlotLib Axes object is stored in p_settings.

Parameters:

  • p_settings (PlotSettings) – Object with further plot settings.

  • **p_kwargs – Implementation-specific data and parameters.

_remove_plot_2d()

Custom method to remove 2D plot artifacts when object is destroyed.

_remove_plot_3d()

Custom method to remove 3D plot artifacts when object is destroyed.

_remove_plot_nd()

Custom method to remove nd plot artifacts when object is destroyed.

renormalize(p_normalizer: Normalizer)

Custom method to renormalize internally stored data.

Parameters:

p_normalizer (Normalizier) – Suitable normalizer object to be used for renormalization.