Flair
Framework Libre Air
flair::filter::ButterworthLowPass Class Reference

Class defining a Butterworth low pass filter. More...

#include <ButterworthLowPass.h>

+ Inheritance diagram for flair::filter::ButterworthLowPass:

Public Member Functions

 ButterworthLowPass (const IODevice *parent, const gui::LayoutPosition *position, std::string name, int order)
 Constructor. More...
 
 ButterworthLowPass (const gui::LayoutPosition *position, std::string name, int order)
 Constructor. More...
 
 ~ButterworthLowPass ()
 Destructor. More...
 
float Output (void) const
 Output value. More...
 
core::cvmatrixMatrix (void) const
 Output matrix. More...
 
void UpdateFrom (const core::io_data *data)
 Update using provided datas. More...
 
- Public Member Functions inherited from flair::core::IODevice
 IODevice (const Object *parent, std::string name)
 Constructor. More...
 
virtual ~IODevice ()
 Destructor. More...
 
void AddDeviceToLog (const IODevice *device)
 Add an IODevice to the logs. More...
 
void AddDataToLog (const io_data *data)
 Add an io_data to the log. More...
 
void OutputToShMem (bool enabled)
 Send the output to a shared memory. More...
 
virtual DataType const & GetInputDataType () const
 
virtual DataType const & GetOutputDataType () const
 
- Public Member Functions inherited from flair::core::Object
 Object (const Object *parent=NULL, std::string name="", std::string type="")
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
std::string ObjectName (void) const
 Name. More...
 
std::string ObjectType (void) const
 Type. More...
 
const ObjectParent (void) const
 Parent. More...
 
std::vector< const Object * > * TypeChilds (void) const
 Childs of the same type. More...
 
std::vector< const Object * > * Childs (void) const
 Childs. More...
 
void Information (const char *function, int line, const char *format,...) const
 Formatted information. More...
 
void Warning (const char *function, const char *format,...) const
 Formatted warning. More...
 
void Error (const char *function, const char *format,...) const
 Formatted error. More...
 
bool ErrorOccured (bool recursive=true) const
 Has an errror occured? More...
 

Additional Inherited Members

- Public Types inherited from flair::core::Object
enum  color_t { Auto = 0, Red = 31, Green = 32, Orange = 33 }
 
- Protected Member Functions inherited from flair::core::IODevice
void ProcessUpdate (io_data *data)
 Process the childs of type IODevice, and log if needed. More...
 

Detailed Description

Class defining a Butterworth low pass filter.

Constructor & Destructor Documentation

flair::filter::ButterworthLowPass::ButterworthLowPass ( const IODevice parent,
const gui::LayoutPosition position,
std::string  name,
int  order 
)

Constructor.

Construct a ButterworthLowPass at position.
After calling this function, position will be deleted as it is no longer usefull.
The filter is automatically updated when parent's IODevice::ProcessUpdate is called.

Parameters
parentparent
positionposition to display settings
namename
orderorder of the filter
flair::filter::ButterworthLowPass::ButterworthLowPass ( const gui::LayoutPosition position,
std::string  name,
int  order 
)

Constructor.

Construct a ButterworthLowPass at position.
The ButterworthLowPass will automatically be child of position->getLayout() Layout. After calling this function, position will be deleted as it is no longer usefull.
The filter is updated manually with UpdateFrom method.

Parameters
positionposition to display settings
namename
orderorder of the filter
flair::filter::ButterworthLowPass::~ButterworthLowPass ( )

Destructor.

Member Function Documentation

float flair::filter::ButterworthLowPass::Output ( void  ) const

Output value.

Returns
filtered output
core::cvmatrix* flair::filter::ButterworthLowPass::Matrix ( void  ) const

Output matrix.

Returns
filtered output
void flair::filter::ButterworthLowPass::UpdateFrom ( const core::io_data data)
virtual

Update using provided datas.

Reimplemented from IODevice.

Parameters
datadata from the parent to process

Implements flair::core::IODevice.