concepts.math.interpolation_utils.SplineInterface#

class SplineInterface[source]#

Bases: object

Methods

derivative([n, x])

get_max_x()

get_min_x()

get_next(y, step_size[, minimum_x])

Get the next target point on a spline interpolation.

project_to(y[, minimum_x])

__call__(x)[source]#

Call self as a function.

Parameters:

x (float)

Return type:

ndarray | Tuple[ndarray, …]

__init__()#
__new__(**kwargs)#
derivative(n=1, x=None)[source]#
Parameters:
Return type:

SplineInterface | Tuple[SplineInterface, …]

get_max_x()[source]#
Return type:

float

get_min_x()[source]#
Return type:

float

get_next(y, step_size, minimum_x=None)[source]#

Get the next target point on a spline interpolation.

Parameters:
  • y (ndarray | Tuple[ndarray, ...]) – the current point.

  • step_size (float) – the step size.

  • minimum_x (float | None) – the minimum x value to be considered.

Returns:

the next x-value and the next target point.

Return type:

Tuple[float, ndarray | Tuple[ndarray, …]]

project_to(y, minimum_x=None)[source]#
Parameters:
Return type:

float