skcyto.CompensationTransformer

class skcyto.CompensationTransformer(C: ndarray[Any, dtype[ScalarType]])[source]
__init__(C: ndarray[Any, dtype[ScalarType]])[source]
fit(X: ndarray[Any, dtype[ScalarType]], y: ndarray[Any, dtype[ScalarType]] | None = None)[source]

Fit only checky compatibility between input data and compensation matrix.

XNDArray

Input data

yIgnored.

Not used, only present for API conventions.

fit_transform(X: ndarray[Any, dtype[ScalarType]], y=None) ndarray[Any, dtype[ScalarType]][source]

Fit and transform data

As fit does not doo anything, this is identical to just running transform and is only implemented for API conventions.

Parameters:
XNDArray

Input data

yIgnored.

Not used, only present for API conventions.

Returns:
NDArray

Compensated data

inverse_transform(X: ndarray[Any, dtype[ScalarType]]) ndarray[Any, dtype[ScalarType]][source]

Decompensate data

Parameters:
XNDArray

Input data

Returns:
NDArray

Decompensated data

transform(X: ndarray[Any, dtype[ScalarType]]) ndarray[Any, dtype[ScalarType]][source]

Compensate data with specified compensation matrix

Parameters:
XNDArray

Data

Returns:
NDArray

Compensated data