iCub-main
Public Member Functions | List of all members
iCub::ctrl::IFilter Class Referenceabstract

Interface for the filters implemented in iCub::crtl. More...

#include <filters.h>

+ Inheritance diagram for iCub::ctrl::IFilter:

Public Member Functions

virtual ~IFilter ()
 Destructor. More...
 
virtual void init (const yarp::sig::Vector &y0)=0
 Internal state reset. More...
 
virtual const yarp::sig::Vector & filt (const yarp::sig::Vector &u)=0
 Performs filtering on the actual input. More...
 
virtual const yarp::sig::Vector & output () const =0
 Return current filter output. More...
 

Detailed Description

Interface for the filters implemented in iCub::crtl.

Definition at line 42 of file filters.h.

Constructor & Destructor Documentation

◆ ~IFilter()

virtual iCub::ctrl::IFilter::~IFilter ( )
inlinevirtual

Destructor.

Definition at line 48 of file filters.h.

Member Function Documentation

◆ filt()

virtual const yarp::sig::Vector& iCub::ctrl::IFilter::filt ( const yarp::sig::Vector &  u)
pure virtual

Performs filtering on the actual input.

Parameters
ureference to the actual input.
Returns
the corresponding output.

Implemented in iCub::ctrl::MedianFilter, iCub::ctrl::FirstOrderLowPassFilter, iCub::ctrl::RateLimiter, and iCub::ctrl::Filter.

◆ init()

virtual void iCub::ctrl::IFilter::init ( const yarp::sig::Vector &  y0)
pure virtual

Internal state reset.

Parameters
y0new internal state.

Implemented in iCub::ctrl::MedianFilter, iCub::ctrl::FirstOrderLowPassFilter, iCub::ctrl::RateLimiter, and iCub::ctrl::Filter.

◆ output()

virtual const yarp::sig::Vector& iCub::ctrl::IFilter::output ( ) const
pure virtual

Return current filter output.

Returns
the filter output.

Implemented in iCub::ctrl::MedianFilter, iCub::ctrl::FirstOrderLowPassFilter, iCub::ctrl::RateLimiter, and iCub::ctrl::Filter.


The documentation for this class was generated from the following file: