BF-MATH-GEOMETRY - Geometric Figures

Ver. 0.0.0 (2023-04-18)

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

class mlpro.bf.math.geometry.Point(p_visualize: bool = False)

Bases: Element, Plottable

Implementation of a point in a hyper space. Properties like the current position, velocity and acceleration are managed.

Parameters:

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

C_PLOT_ACTIVE: bool = True

get_velocity() → ndarray

Returns current velocity of the point.

Returns:

point_vel – Current velocity of the point in unit/sec for each dimension.

Return type:

np.ndarray

get_acceleration() → ndarray

Returns current acceleration of the point.

Returns:

point_acc – Current accelation of the point in unit/sec² for each dimension.

Return type:

np.ndarray

set_values(p_values: list | ndarray, p_time_stamp: datetime = None)

Set/updates the point position and computes the resulting velocity and acceleration.

Parameters:

• p_values (Union[ list, np.ndarray ]) – New position of the point.

• p_time_stamp (datetime = None) – Optional time stamp.

_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.