set_filter

Configure the infinite impulse response filter with one of available filter shape and type

To use customer coefficients see `set_custom_filter`

Parameters

channel integer required

Target channel

allowed values:

Moku:Lab	1, 2
Moku:Go	1, 2
Moku:Pro	1, 2, 3, 4
Moku:Delta	1, 2, 3, 4

sample_rate number required

Sampling rate for the filter

allowed values:

Moku:Lab	15.6MSa/s, 1.95MSa/s, 122kSa/s
Moku:Go	3.91MSa/s, 488kSa/s, 61kSa/s
Moku:Pro	39.1MSa/s, 4.88MSa/s, 305kSa/s
Moku:Delta	39.1MSa/s, 4.88MSa/s, 305kSa/s

units: Hz

shape string

IIR Filter shape

default: Lowpass

allowed values:Lowpass, Highpass, Bandpass, Bandstop

type string

IIR Filter type

default: Butterworth

allowed values:Butterworth, ChebyshevI, ChebyshevII, Elliptic, Cascaded, Bessel, Gaussian, Legendre

low_corner number

Low corner frequency

default: undefined

units: Hz

high_corner number

High corner frequency

default: undefined

units: Hz

pass_band_ripple number

Pass band ripple

default: undefined

units: dB

stop_band_attenuation number

Stopband attenuation

default: undefined

units: dB

order integer required

Number of coefficients for the filter

allowed values:

Moku:Lab	2, 4, 6, 8, 10, 12
Moku:Go	2, 4, 6, 8, 10, 12
Moku:Pro	2, 4, 6, 8, 10, 12, 14, 16
Moku:Delta	2, 4, 6, 8, 10, 12, 14, 16

strict boolean

Disable all implicit conversions and coercions.

default: true

Examples

Sample response

{
    "low_pass_corner": 99999.99999999999,
    "order": 8,
    "pass_band_ripple": 3.0,
    "sample_rate": "39.1MSa/s",
    "shape": "Lowpass",
    "type": "ChebyshevI"
}