gemseo / mlearning / transform / sensor

jameson module

A 1D Jameson sensor.

Classes:

JamesonSensor([name, threshold, ...])

A 1D Jameson Sensor.

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

Bases: gemseo.mlearning.transform.transformer.Transformer

A 1D Jameson Sensor.

name

The name of the transformer.

Type

str

parameters

The parameters of the transformer.

Type

str

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.

Return type

None

Attributes:

CROSSED

Methods:

compute_jacobian(data)	Compute Jacobian of transformer.transform().
compute_jacobian_inverse(data)	Compute Jacobian of the transformer.inverse_transform().
duplicate()	Duplicate the current object.
fit(data, *args)	Fit the transformer to the data.
fit_transform(data, *args)	Fit the transformer to the data and transform the data.
inverse_transform(data)	Perform an inverse transform on the data.
transform(data)	Transform the data.

CROSSED = False

compute_jacobian(data)

Compute Jacobian of transformer.transform().

Parameters

data (numpy.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 (numpy.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

gemseo.mlearning.transform.transformer.Transformer

fit(data, *args)

Fit the transformer to the data.

Parameters

• data (numpy.ndarray) – The data to be fitted.

• *args (Union[float, int, str]) –

Return type

None

fit_transform(data, *args)

Fit the transformer to the data and transform the data.

Parameters

• data (numpy.ndarray) – The data to be transformed.

• *args (Union[float, int, str]) –

Returns

The transformed data.

Return type

numpy.ndarray

inverse_transform(data)

Perform an inverse transform on the data.

Parameters

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

Returns

The inverse transformed data.

Return type

NoReturn

transform(data)

Transform the data.

Parameters

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

Returns

The transformed data.

Return type

numpy.ndarray