pysteps.cascade.bandpass_filters.filter_gaussian

pysteps.cascade.bandpass_filters.filter_gaussian

pysteps.cascade.bandpass_filters.filter_gaussian(shape, n, l_0=3, gauss_scale=0.5, gauss_scale_0=0.5, d=1.0, normalize=True)

Implements a set of Gaussian bandpass filters in logarithmic frequency scale.

Parameters
shape: int or tuple

The dimensions (height, width) of the input field. If shape is an int, the domain is assumed to have square shape.

n: int

The number of frequency bands to use. Must be greater than 2.

l_0: int

Central frequency of the second band (the first band is always centered at zero).

gauss_scale: float

Optional scaling prameter. Proportional to the standard deviation of the Gaussian weight functions.

gauss_scale_0: float

Optional scaling parameter for the Gaussian function corresponding to the first frequency band.

d: scalar, optional

Sample spacing (inverse of the sampling rate). Defaults to 1.

normalize: bool

If True, normalize the weights so that for any given wavenumber they sum to one.

Returns
out: dict

A dictionary containing the bandpass filters corresponding to the specified frequency bands.

References

[PCH18b]