Digital Filter
Keywords
electrical, unidirectional
Ports
Name | Type |
---|---|
input | Electrical Signal |
output | Electrical Signal |
Properties
General Properties
Name | Default value | Default unit | Range |
---|---|---|---|
name Defines the name of the element. |
Digital Filter | - | - |
annotate Defines whether or not to display annotations on the schematic editor. |
true | - | [true, false] |
enabled Defines whether or not the element is enabled. |
true | - | [true, false] |
type Defines the element unique type (read only). |
Digital Filter | - | - |
description A brief description of the elements functionality. |
Digital Filter | - | - |
prefix Defines the element name prefix. |
IIR | - | - |
model Defines the element model name. |
- | - | - |
library Defines the element location or source in the library (custom or design kit). |
- | - | - |
local path Defines the local path or working folder $LOCAL for the element. |
- | - | - |
url An optional URL address pointing to the element online help. |
- | - | - |
Standard Properties
Name | Default value | Default unit | Range |
---|---|---|---|
delay The time delay value for each filter tap (tapped delay line). |
1.0/%bitrate% | s | (0, +∞) |
digital filter type Defines the digital filter type used to fit the element transfer function in time domain. |
FIR | - | [FIR, IIR |
Standard/Coefficients Properties
Name | Default value | Default unit | Range |
---|---|---|---|
load feedforward filter coefficients from file Defines whether or not to load filter coefficients from an input file or to use the currently stored values. |
false | - | [true, false] |
feedforward filter coefficients filename The file containing the filter coefficient values. Refer to the Implementation Details section for the format expected. |
- | - | - |
feedforward filter coefficients table The table containing the filter coefficient values |
<2,2> [0, 0, 0,...] | - | - |
load feedback filter coefficients from file Defines whether or not to load filter coefficients from an input file or to use the currently stored values. |
false | - | [true, false] |
feedback filter coefficients filename The file containing the filter coefficient values. Refer to the Implementation Details section for the format expected. |
- | - | - |
feedback filter coefficients table The table containing the filter coefficient values |
<2,2> [0, 0, 0,...] | - | - |
Numerical/Digital Filter Properties
Name | Default value | Default unit | Range |
---|---|---|---|
fractional delay Defines whether to use a fractional delay filter or force the delay to be an integer multiple of the sample period. |
true | - | [true, false] |
====================================
Implementation Details
The Digital Filter element can load in filter coefficient data files. The coefficients can be used to represent the digital filter and the fractional delay option can be enabled to model waveguide elements. Both feedforward and feedback filter coefficients can be defined/loaded at the same time.
Following is the circuit in the example file digital_filter_example.icp.
Following is the filter output result overlaid with its input square wave signal.