# FIR Filter Builder
The FIR Filter Builder, allows design and implementation of lowpass, highpass, bandpass, and bandstop finite impulse response (FIR) filters.
If using the REST API directly, the instrument group name is firfilter
.
Functions
Core
- Multi-instrument: FIR Filter Builder in multi-instrument context
- enable_output: Enable or disable the FIR channel output(s)
- getters: FIR Filter - getter functions
- set_by_frequency: Configure the FIR filter frequency response.
- set_by_time: Configure the FIR filter impulse response.
- set_control_matrix: Set the linear combination of ADC input signals for a given FIR channel.
- set_custom_kernel_coefficients: Set FIR filter sample rate and kernel coefficients for the specified filter channel. This will enable the specified channel output.
- set_defaults: Set the the FIR filter to its default state.
- set_frontend: Configures the input impedance, coupling, and range for each channel.
- set_input_gain: Set input signal gain
- set_input_offset: Set input signal offset
- set_output_gain: Set output signal gain
- set_output_offset: Set output signal offset
- summary: Returns a short summary of current instrument state
Data Logger
- logging_progress: Returns current logging state.
- start_logging: Start the data logging session to file.
- stop_logging: Stops the current instrument data logging session.
Data Streaming
- get_stream_data: Get the converted data stream
- getters: FIR Filter Builder - Streaming - getter functions
- start_streaming: Start a streaming session
- stop_streaming: Stops the current instrument data streaming session.
- stream_to_file: Save the streaming session to a file
- get_chunk: Get a single chunk out of data stream
Oscilloscope
- enable_rollmode: Enables and disables Roll Mode X-axis behaviour
- get_data: Get a frame of the data from the instrument
- Osc Getters: Getters
- save_high_res_buffer: Save the high resolution channel buffer data to a file on the Moku's internal storage
- set_acquisition_mode: Set acquisition mode
- set_hysteresis: Configures the hysteresis around trigger point.
- set_timebase: Set the left- and right-hand span for the time axis. Units are seconds relative to the trigger point.
- set_trigger: Sets trigger source and parameters.
- set_monitor: Configures the specified monitor channel to view the desired filter signal.