Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Private Attributes | List of all members
dynamicgraph::sot::FIRFilter< sigT, coefT > Class Template Reference

#include <fir-filter.hh>

Public Member Functions

virtual sigT & compute (sigT &res, sigtime_t time)
 
 FIRFilter (const std::string &name)
 
std::size_t getBufferSize () const
 
virtual const std::string & getClassName () const
 
std::string getDocString () const
 
coefT getElement (const std::size_t &rank) const
 
void reset_signal (Vector &res, const Vector &sample)
 
void resizeBuffer (const std::size_t &size)
 
void setElement (const std::size_t &rank, const coefT &coef)
 
virtual ~FIRFilter ()
 

Static Public Member Functions

static std::string getTypeName (void)
 
static void reset_signal (sigT &, const sigT &)
 

Public Attributes

SignalPtr< sigT, sigtime_tSIN
 
SignalTimeDependent< sigT, sigtime_tSOUT
 

Static Public Attributes

static const std::string CLASS_NAME
 

Private Attributes

std::vector< coefT > coefs
 
detail::circular_buffer< sigT > data
 

Detailed Description

template<class sigT, class coefT>
class dynamicgraph::sot::FIRFilter< sigT, coefT >

Definition at line 72 of file fir-filter.hh.

Constructor & Destructor Documentation

◆ FIRFilter()

template<class sigT , class coefT >
dynamicgraph::sot::FIRFilter< sigT, coefT >::FIRFilter ( const std::string &  name)
inline

Definition at line 122 of file fir-filter.hh.

◆ ~FIRFilter()

template<class sigT , class coefT >
virtual dynamicgraph::sot::FIRFilter< sigT, coefT >::~FIRFilter ( )
inlinevirtual

Definition at line 162 of file fir-filter.hh.

Member Function Documentation

◆ compute()

template<class sigT , class coefT >
virtual sigT& dynamicgraph::sot::FIRFilter< sigT, coefT >::compute ( sigT &  res,
sigtime_t  time 
)
inlinevirtual

Definition at line 164 of file fir-filter.hh.

◆ getBufferSize()

template<class sigT , class coefT >
std::size_t dynamicgraph::sot::FIRFilter< sigT, coefT >::getBufferSize ( ) const
inline

Definition at line 183 of file fir-filter.hh.

◆ getClassName()

template<class sigT , class coefT >
virtual const std::string& dynamicgraph::sot::FIRFilter< sigT, coefT >::getClassName ( ) const
inlinevirtual

Definition at line 99 of file fir-filter.hh.

◆ getDocString()

template<class sigT , class coefT >
std::string dynamicgraph::sot::FIRFilter< sigT, coefT >::getDocString ( ) const
inline

Definition at line 105 of file fir-filter.hh.

◆ getElement()

template<class sigT , class coefT >
coefT dynamicgraph::sot::FIRFilter< sigT, coefT >::getElement ( const std::size_t &  rank) const
inline

Definition at line 191 of file fir-filter.hh.

◆ getTypeName()

template<class sigT , class coefT >
static std::string dynamicgraph::sot::FIRFilter< sigT, coefT >::getTypeName ( void  )
inlinestatic

Definition at line 102 of file fir-filter.hh.

◆ reset_signal() [1/2]

template<class sigT , class coefT >
static void dynamicgraph::sot::FIRFilter< sigT, coefT >::reset_signal ( sigT &  ,
const sigT &   
)
inlinestatic

Definition at line 193 of file fir-filter.hh.

◆ reset_signal() [2/2]

void dynamicgraph::sot::FIRFilter< Vector, Matrix >::reset_signal ( Vector res,
const Vector sample 
)

Definition at line 62 of file fir-filter.cpp.

◆ resizeBuffer()

template<class sigT , class coefT >
void dynamicgraph::sot::FIRFilter< sigT, coefT >::resizeBuffer ( const std::size_t &  size)
inline

Definition at line 177 of file fir-filter.hh.

◆ setElement()

template<class sigT , class coefT >
void dynamicgraph::sot::FIRFilter< sigT, coefT >::setElement ( const std::size_t &  rank,
const coefT &  coef 
)
inline

Definition at line 187 of file fir-filter.hh.

Member Data Documentation

◆ CLASS_NAME

template<class sigT , class coefT >
const std::string dynamicgraph::sot::FIRFilter< sigT, coefT >::CLASS_NAME
static

Definition at line 103 of file fir-filter.hh.

◆ coefs

template<class sigT , class coefT >
std::vector<coefT> dynamicgraph::sot::FIRFilter< sigT, coefT >::coefs
private

Definition at line 200 of file fir-filter.hh.

◆ data

template<class sigT , class coefT >
detail::circular_buffer<sigT> dynamicgraph::sot::FIRFilter< sigT, coefT >::data
private

Definition at line 201 of file fir-filter.hh.

◆ SIN

template<class sigT , class coefT >
SignalPtr<sigT, sigtime_t> dynamicgraph::sot::FIRFilter< sigT, coefT >::SIN

Definition at line 196 of file fir-filter.hh.

◆ SOUT

template<class sigT , class coefT >
SignalTimeDependent<sigT, sigtime_t> dynamicgraph::sot::FIRFilter< sigT, coefT >::SOUT

Definition at line 197 of file fir-filter.hh.


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


sot-core
Author(s): Olivier Stasse, ostasse@laas.fr
autogenerated on Tue Oct 24 2023 02:26:32