Skip to content

radiens_core.models.dsp

Digital Signal Processing (DSP) domain models and enums.

Classes

DSPGroup

Bases: BaseModel

Group of DSP filter stages, organized by hardware/software layers.

Attributes:

Name Type Description
hardware list[DSPParams]

List of hardware filter stages.

software_stage1 list[DSPParams]

List of software stage 1 filters.

software_stage2 list[DSPParams]

List of software stage 2 filters.

spike_sorter list[DSPParams]

List of spike sorter filters.

DSPParams

Bases: BaseModel

Configuration parameters for a single DSP filter stage.

Attributes:

Name Type Description
type DSPType

DSP filter type. References DSPType.

stage FilterStage

DSP filter stage. References FilterStage.

freq float | None

Filter frequency. Defaults to None.

freq_spec_band FreqSpecBand | None

Frequency band specification. Defaults to None.

ref_ntv_chan_idx int | None

Reference native channel index. Defaults to None.

notch_bandwidth float | None

Notch filter bandwidth. Defaults to None.

user_label str

User-defined label for the filter. Defaults to "".

port Port | None

Port configuration. References Port. Defaults to None.

target_ntv_chan_idx float | None

Target native channel index. Defaults to None.

is_aux bool

Whether this is an auxiliary filter. Defaults to False.

aux_chan_idx int | None

Auxiliary channel index. Defaults to None.

filter_order int | None

Filter order. Defaults to None.

zero_phase bool

Whether to use zero-phase filtering. Defaults to False.

force_sos bool

Whether to force Second-Order Sections. Defaults to False.

DSPType

Bases: IntEnum

Digital Signal Processing filter type. Values match proto common.DSPType.

FilterStage

Bases: IntEnum

Digital Signal Processing filter stage. Values match proto common.FilterStage.

FreqSpecBand

Bases: BaseModel

Frequency band specification for filters.

Attributes:

Name Type Description
low_freq float

Low frequency in Hertz.

high_freq float

High frequency in Hertz.