LinearWhiteningFilter.__call__#
- LinearWhiteningFilter.__call__(shape, data=None, data_rfft=None, n_bins=None, batch_dimension=None, order=1, return_real_fourier=True, **kwargs)[source]#
Apply linear whitening to the data and return the result.
- Parameters:
- shapetuple of ints
Shape of the returned whitening filter.
- dataBackendArray, optional
The input data, defaults to None.
- data_rfftBackendArray, optional
The Fourier transform of the input data, defaults to None.
- n_binsint, optional
The number of bins for computing the spectrum, defaults to None.
- batch_dimensionint, optional
Batch dimension to average over.
- return_real_fouriertuple of int
Return a shape compliant with rfft, i.e., omit the negative frequencies terms resulting in a return shape (*shape[:-1], shape[-1]//2+1)
- **kwargsDict
Additional keyword arguments.
- Returns:
- dict
- data: BackendArray
The filter mask.
- shape: tuple of ints
The requested filter shape
- return_real_fourier: bool
Whether data is compliant with rfftn.
- is_multiplicative_filter: bool
Whether the filter is multiplicative in Fourier space.