swectral.denoiser.FourierFilter

class swectral.denoiser.FourierFilter(sampling_rate=-1.0, cutoff=0.5, axis=0)

Fourier filter to 2D array-like of 1D series data.

Attributes:

sampling_ratefloat, optional

Sampling rate. The default uses the number of samples.

cutofffloat, optional

Percentage frequency cutoffs, must be a number between 0 and 1. The default is 0.1.

axisint, optional

Axis of 1D signal. If 0, each row of 2D array represents an 1D signal. The default is 0.

Methods

apply(data_array)

Apply Fourier filter to 2D array-like of 1D series data.

__init__(sampling_rate=-1.0, cutoff=0.5, axis=0)

Methods

__init__([sampling_rate, cutoff, axis])
apply(data_array)	Apply Fourier filter to 2D array-like of 1D series data.

apply(data_array)

Apply Fourier filter to 2D array-like of 1D series data.

Parameters:

data_array1D array_like or 2D array_like

1D data array or 2D data array of 1D series data.

Returns:

numpy.ndarray

Array of filtered signals.

Return type:

ndarray

Examples

>>> ff = FourierFilter()
>>> ff.apply([1, 2, 3, 4, 5, 6, 77, 88, 9, 10])
>>> ff.apply([[1, 2, 3, 4, 5, 6, 77, 88, 9, 10], [1, 22, 33, 4, 5, 6, 7, 8, 9, 10]])

Add to prepared SpecPipe instance pipe for ROI pixel spectrum processing:

>>> pipe.add_process(6, 6, 0, FourierFilter().apply)

Add to prepared SpecPipe instance pipe for the processing of 1D sample data:

>>> pipe.add_process(7, 7, 0, FourierFilter().apply)