gemseo / mlearning / transform / sensor

jameson module

A 1D Jameson sensor.

class gemseo.mlearning.transform.sensor.jameson.JamesonSensor(name='JamesonSensor', threshold=0.3, removing_part=0.01, dimension=1)[source]

Bases: Transformer

A 1D Jameson Sensor.

Parameters:

  • name (str) –

    A name for this transformer.

    By default it is set to “JamesonSensor”.

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

compute_jacobian(data)

Compute Jacobian of transformer.transform().

Parameters:

data (ndarray) – The data where the Jacobian is to be computed.

Returns:

The Jacobian matrix.

Return type:

NoReturn

compute_jacobian_inverse(data)

Compute Jacobian of the transformer.inverse_transform().

Parameters:

data (ndarray) – The data where the Jacobian is to be computed.

Returns:

The Jacobian matrix.

Return type:

NoReturn

duplicate()

Duplicate the current object.

Returns:

A deepcopy of the current instance.

Return type:

Transformer

fit(data, *args)

Fit the transformer to the data.

Parameters:
Return type:

NoReturn

fit_transform(data, *args)

Fit the transformer to the data and transform the data.

Parameters:
Returns:

The transformed data.

Return type:

ndarray

inverse_transform(data)

Perform an inverse transform on the data.

Parameters:

data (ndarray) – The data to be inverse transformed.

Returns:

The inverse transformed data.

Return type:

NoReturn

transform(data)[source]

Transform the data.

Parameters:

data (ndarray) – The data to be transformed.

Returns:

The transformed data.

Return type:

ndarray

CROSSED = False
name: str

The name of the transformer.

parameters: str

The parameters of the transformer.