{ } Raw JSON

bundles / scipy 1.17.1 / scipy / signal / _spline_filters / symiirorder1

function

scipy.signal._spline_filters:symiirorder1

source: /scipy/signal/_spline_filters.py :690

Signature

def   symiirorder1 ( signal c0 z1 precision = -1.0 )

Summary

Implement a smoothing IIR filter with mirror-symmetric boundary conditions using a cascade of first-order sections.

Extended Summary

The second section uses a reversed sequence. This implements a system with the following transfer function and mirror-symmetric boundary conditions

                c0
H(z) = ---------------------
        (1-z1/z) (1 - z1 z)

The resulting signal will have mirror symmetric boundary conditions as well.

Parameters

signal : ndarray

The input signal. If 2D, then the filter will be applied in a batched fashion across the last axis.

c0, z1 : scalar

Parameters in the transfer function.

precision

Specifies the precision for calculating initial conditions of the recursive filter based on mirror-symmetric input.

Returns

output : ndarray

The filtered signal.

Notes

Array API Standard Support

symiirorder1 has experimental support for Python Array API Standard compatible backends in addition to NumPy. Please consider testing these features by setting an environment variable SCIPY_ARRAY_API=1 and providing CuPy, PyTorch, JAX, or Dask arrays as array arguments. The following combinations of backend and device (or other capability) are supported.

====================  ====================  ====================
Library               CPU                   GPU
====================  ====================  ====================
NumPy                 ✅                     n/a                 
CuPy                  n/a                   ⛔                   
PyTorch               ⛔                     ⛔                   
JAX                   ⛔                     ⛔                   
Dask                  ⛔                     n/a                 
====================  ====================  ====================

See dev-arrayapi for more information.

Aliases

  • scipy.signal.symiirorder1