WhitenTransform๏ƒ

Stability: Stable

What it is๏ƒ

Use WhitenTransform as a ready-made preprocessing step inside direct analysis code or a Pipeline.

Representative Signatures๏ƒ

WhitenTransform(fftlength=1.0, overlap=0.5, **kwargs)
WhitenTransform.transform(x)

Minimal Example๏ƒ

from gwexpy.timeseries import WhitenTransform

whitened = WhitenTransform(fftlength=1.0, overlap=0.5).fit_transform(ts)

API Reference๏ƒ

The detailed generated API continues below on this page.

Inherits from: Transform

Whitening using PCA or ZCA on TimeSeriesMatrix-like data.

Methods๏ƒ

__init__๏ƒ

__init__(self, method: str = 'pca', eps: float = 1e-12, n_components: Optional[int] = None, *, multivariate: bool = True, align: str = 'intersection')

Initialize self. See help(type(self)) for accurate signature.

(Inherited from Transform)

fit๏ƒ

fit(self, x)

Fit the transform to the data. Returns self.

(Inherited from Transform)

fit_transform๏ƒ

fit_transform(self, x)

Fit and transform in one step.

inverse_transform๏ƒ

inverse_transform(self, y)

Reverse the transform. Not all transforms support this.

(Inherited from Transform)

transform๏ƒ

transform(self, x)

Apply the transform to data. Must be implemented by subclasses.

(Inherited from Transform)