spectrochempy.RobustScaleTransformer

class RobustScaleTransformer(dim='y')[source]

Robust scaling transformer.

Learns the median and median absolute deviation (MAD) along a dimension during fit() and applies \((x - \mathrm{median}) / \mathrm{MAD}\) during transform().

Parameters:

dim (str or int, optional, default:’y’) – Dimension along which the median and MAD are computed.

median_[source]

Learned median.

Type:

ndarray

mad_[source]

Learned MAD, scaled by 1.4826 to estimate standard deviation.

Type:

ndarray

Examples

>>> scaler = scp.RobustScaleTransformer(dim="y")
>>> scaler.fit(train)
>>> test_scaled = scaler.transform(test)

See also

robust_scale

Procedural robust scaling function.

Methods Summary

fit(dataset)

Learn parameters from dataset.

fit_transform(dataset)

Fit to dataset, then transform it.

inverse_transform(dataset)

Reverse the learned transformation on dataset.

transform(dataset)

Apply the learned transformation to dataset.

Methods Documentation

fit(dataset)[source]

Learn parameters from dataset.

Parameters:

dataset (NDDataset) – Training data.

Returns:

self – The fitted instance.

fit_transform(dataset)[source]

Fit to dataset, then transform it.

Equivalent to self.fit(dataset).transform(dataset) but avoids an intermediate copy when possible.

Parameters:

dataset (NDDataset) – Training data.

Returns:

NDDataset – Transformed dataset.

inverse_transform(dataset)[source]

Reverse the learned transformation on dataset.

Parameters:

dataset (NDDataset) – Data to invert.

Returns:

NDDataset – Dataset in the original space.

Raises:

SpectroChemPyError – If fit() has not been called first.

transform(dataset)[source]

Apply the learned transformation to dataset.

Parameters:

dataset (NDDataset) – Data to transform.

Returns:

NDDataset – Transformed dataset.

Raises:

SpectroChemPyError – If fit() has not been called first.

Examples using spectrochempy.RobustScaleTransformer