gemseo.mlearning.transformers.sensor.jameson module#

A 1D Jameson sensor.

class JamesonSensor(name='', threshold=0.3, removing_part=0.01, dimension=1)[source]#

Bases: BaseTransformer

A 1D Jameson Sensor.

Parameters:

  • name (str) --

    A name for this transformer.

    By default it is set to "".

  • threshold (float) --

    The value to add to the denominator to avoid zero division.

    By default it is set to 0.3.

  • removing_part (float) --

    The level of the signal to remove in order to avoid leading and trailing edge effects.

    By default it is set to 0.01.

  • dimension (int) --

    The dimension of the mesh.

    By default it is set to 1.

transform(data, *args, **kwargs)#

Force a NumPy array to be at least 2D and evaluate the function f.

f expects a 2D array shaped as (n_points, input_dimension) and returns a nD arrays shaped as (..., n_points, output_dimension) or (..., n_points, output_dimension, input_dimension).

If the original data is a 1D array shaped as (input_dimension,), then this wrapper returns a (n-1)D array shaped as (..., output_dimension) or (..., output_dimension, intput_dimension).

Parameters:

  • data (ndarray) -- A NumPy array.

  • *args (Any) -- The positional arguments.

  • **kwargs (Any) -- The optional arguments.

Returns:

Any kind of output; if a NumPy array, its dimension is made consistent with the shape of data.

Return type:

Any