A finite impulse response (FIR) filter.
static
readonly
OcaClassID ClassID
= 1.1.1.12
Level: 1 Index: 1
Number that uniquely identifies the class. Note that this differs from the object number, which identifies the instantiated object. This property is an override of the OcaRoot property.
Level: 1 Index: 2
Identifies the interface version of the class. Any change to the class definition leads to a higher class version. This property is an override of the OcaRoot property.
Level: 4 Index: 1
Length of the filter, in samples. Readonly. Value is set when SetCoefficients(...) method executes.
Level: 4 Index: 2
Array of FIR Coefficients. The size of the array (number of entries) is equal to the Order property plus 1.
Level: 4 Index: 3
Sample rate inside the filter. We can't assume it's the same as the device input or output rate.
Properties inherited from OcaWorker
Properties inherited from OcaRoot
OcaFilterFIR::GetLength (
)
→ (
OcaUint32 Length, OcaUint32 minLength, OcaUint32 maxLength)
Level: 4 Index: 1
Gets the length of the FIR filter. The return value indicates whether the value was successfully retrieved.
OcaFilterFIR::GetCoefficients (
)
→ (
OcaList<OcaFloat32> Coefficients)
Level: 4 Index: 2
Gets the coefficients of the FIR filter. The return value indicates whether the coefficients were successfully retrieved.
OcaFilterFIR::SetCoefficients (
OcaList<OcaFloat32> Coefficients )
Level: 4 Index: 3
Sets the value of the properties of the FIR filter. The return value indicates whether the properties were successfully set.
Level: 4 Index: 4
Gets the sample rate of the FIR filter. The return value indicates whether the data was successfully retrieved.
OcaFilterFIR::SetSampleRate (
OcaFrequency Rate )
Level: 4 Index: 5
Sets the sample rate of the FIR filter. The return value indicates whether the rate was successfully set.