IIRFilter Class
(Automation::IIRFilter)An infinite impulse response (IIR) low-pass filter operator. More...
| Header: | #include <IIRFilter> |
| Inherits: | CDPOperator<T> |
Public Functions
| IIRFilter(const CDPPropertyBase &in) | |
| virtual | ~IIRFilter() |
Reimplemented Public Functions
| virtual void | Configure(XMLPrimitive *operatorXML) override |
| virtual void | Create(const char *shortName, CDPBaseObject *pParent) override |
| virtual void | FillNodeChildren(CDP::StudioAPI::NodeStream &stream) const override |
| virtual void | Init() override |
| virtual unsigned int | Process() override |
- 18 public functions inherited from CDPOperator
- 17 public functions inherited from CDPOperatorBase
- 46 public functions inherited from CDPBaseObject
- 26 public functions inherited from CDP::StudioAPI::CDPNode
- 22 public functions inherited from CDP::StudioAPI::ICDPNode
Additional Inherited Members
- 1 public variable inherited from CDPOperatorBase
- 1 static public member inherited from CDPBaseObject
- 1 protected function inherited from CDP::StudioAPI::CDPNode
- 8 protected variables inherited from CDPOperator
- 5 protected variables inherited from CDPOperatorBase
- 11 protected variables inherited from CDPBaseObject
Detailed Description
An infinite impulse response (IIR) low-pass filter operator.
This CDP operator can be used to limit (truncate) input signal using 1st order IIR filter.
Properties
| Property | Description |
|---|---|
| f3dB | -3dB cut-off frequency for IIR filter |
| Reset | Resets IIRFilter calculation. When toggled from 0 to 1 IIRFilter signal history is cleared and calculation reset. |
When operator is used inside a signal its default input is automatically tied to signal's InternalValue or previous operator's output. Its default output is automatically tied to next operator's input or to signal's Value. See also CDP Operator Usage In CDP Signals.
Example
Below is an example plot of 1Hz Sine signal (cyan) and the same signal with IIRFilter operator with property f3dB=1 applied (orange):
Actual Processing Code of the IIRFilter
unsigned int IIRFilter<T>::Process() { if (d->reset) Init(); m_output = d->filter.Calculate((T)m_input); return STATUS_OK; }
See also Argument.
Member Function Documentation
IIRFilter::IIRFilter(const CDPPropertyBase &in)
Constructs a IIRFilter with input in.
[virtual] IIRFilter::~IIRFilter()
Destructs the IIRFilter operator
[override virtual] void IIRFilter::Configure(XMLPrimitive *operatorXML)
Reimplemented from CDPBaseObject::Configure().
[override virtual] void IIRFilter::Create(const char *shortName, CDPBaseObject *pParent)
Reimplemented from CDPBaseObject::Create().
[override virtual] void IIRFilter::FillNodeChildren(CDP::StudioAPI::NodeStream &stream) const
Reimplemented from CDPNode::FillNodeChildren().
Exposes himself and Arguments to Studio
[override virtual] void IIRFilter::Init()
Reimplemented from CDPOperatorBase::Init().
Will initialize/reset the filter. Is called when Reset is performed, and also if parentFs has changed.
[override virtual] unsigned int IIRFilter::Process()
Reimplemented from CDPOperatorBase::Process().
Does actual Ramp Filter output calculation.
Get started with CDP Studio today
Let us help you take your great ideas and turn them into the products your customer will love.