utils::StationaryOffsetFilter Struct Reference

Remove stationary offset from an input signal. More...

#include <lipm_walking/utils/StationaryOffsetFilter.h>

Public Member Functions

EIGEN_MAKE_ALIGNED_OPERATOR_NEW StationaryOffsetFilter (double dt, double timeConstant, const Eigen::Vector3d &initValue=Eigen::Vector3d::Zero())
 Constructor. More...
 
void update (const Eigen::Vector3d &value)
 Update input signal value. More...
 
const Eigen::Vector3d & eval () const
 Get output value where the stationary offset has been filtered. More...
 
const Eigen::Vector3d & raw () const
 Get raw value of input signal. More...
 
void setZero ()
 Reset everything to zero. More...
 
double timeConstant () const
 Get time constant of the filter. More...
 
void timeConstant (double T)
 Update time constant. More...
 

Detailed Description

Remove stationary offset from an input signal.

Definition at line 39 of file StationaryOffsetFilter.h.

Constructor & Destructor Documentation

EIGEN_MAKE_ALIGNED_OPERATOR_NEW utils::StationaryOffsetFilter::StationaryOffsetFilter ( double  dt,
double  timeConstant,
const Eigen::Vector3d &  initValue = Eigen::Vector3d::Zero() 
)
inline

Constructor.

Parameters
dtTime in [s] between two readings.
timeConstantLength of recent-past window used to evaluate the stationary offset.
initValueInitial value of the input signal.

Definition at line 53 of file StationaryOffsetFilter.h.

Member Function Documentation

const Eigen::Vector3d& utils::StationaryOffsetFilter::eval ( ) const
inline

Get output value where the stationary offset has been filtered.

Definition at line 75 of file StationaryOffsetFilter.h.

const Eigen::Vector3d& utils::StationaryOffsetFilter::raw ( ) const
inline

Get raw value of input signal.

Definition at line 83 of file StationaryOffsetFilter.h.

void utils::StationaryOffsetFilter::setZero ( )
inline

Reset everything to zero.

Definition at line 91 of file StationaryOffsetFilter.h.

double utils::StationaryOffsetFilter::timeConstant ( ) const
inline

Get time constant of the filter.

Definition at line 101 of file StationaryOffsetFilter.h.

void utils::StationaryOffsetFilter::timeConstant ( double  T)
inline

Update time constant.

Parameters
TNew time constant of the filter.

Definition at line 111 of file StationaryOffsetFilter.h.

void utils::StationaryOffsetFilter::update ( const Eigen::Vector3d &  value)
inline

Update input signal value.

Parameters
valueNew value.

Definition at line 65 of file StationaryOffsetFilter.h.