rcatool.stats.convolve.filtering

rcatool.stats.convolve.filtering(data, wgts, mode='valid', dim=1, axis=None, fft=False, fftn=<function fftn>, ifftn=<function ifftn>)

1D and 2D filtering procedures.

Filters input data, both 1D and 2D, with user defined weights. Set fft to True for fast fourier transform to speed things up when data is large.

Parameters:

• data (array) – Data to be filtered.

• wgts (array/list) – The weights (kernel) to be used in the filtering.

• mode (str) – String indicating the size of output (see https://docs.scipy.org/doc/scipy/reference/signal.html)

• dim (int) – If 1 one-dimensional filtering is performed and if ‘axis’ is also set, 1D-filtering is applied along this axis. If dim=2 two-dimensional filtering is applied.

• fft (boolean) – Set True to use fast fourier transform in the 2D filtering.

Returns:

data_conv – Convoluted data

Return type:

array