xrscipy.signal.extra.bandpass

xrscipy.signal.extra.bandpass(darray: DataArray, f_low: _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes], f_high: _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes], *args, **kwargs) → DataArray

Applies bandpass filter to a darray.

This is a 1-d filter. If the darray is one dimensional, then the dimension along which the filter is applied is chosen automatically if not specified by an arg dim. If darray is multi dimensional then axis along which the filter is applied has to be specified by an additional argument dim string.

Parameters:

  • darray (DataArray) – An xarray type data to be filtered.

  • f_low (array_like) – A scalar specifying the lower cut-off frequency for the bandpass filter.

  • f_high (array_like) – A scalar specifying the higher cut-off frequency for the bandpass filter.

  • args – Additional arguments passed to frequency_filter function to further specify the filter. The following parameters can be passed: (order, irtype, filtfilt, apply_kwargs, in_nyq, dim)

  • kwargs – Arbitrary keyword arguments passed when the filter is being designed. See frequency_filter documentation for furhter information.