Public Member Functions | Protected Attributes | List of all members
mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE > Class Template Reference

#include <pf.h>

Public Member Functions

template<typename GEN >
void addNoiseUsingNoiseGenerator (const GEN &generator)
 
std::vector< Particle< T, FLT_TYPE > >::iterator appendParticle (const size_t num)
 
std::vector< Particle< T, FLT_TYPE > >::iterator begin ()
 
void bias (std::function< void(const T &, float &p_bias)> prob)
 
std::vector< T > covariance (const FLT_TYPE pass_ratio=1.0, const FLT_TYPE random_sample_ratio=1.0)
 
std::vector< Particle< T, FLT_TYPE > >::iterator end ()
 
T expectation (const FLT_TYPE pass_ratio=1.0)
 
T expectationBiased ()
 
T getParticle (const size_t i) const
 
size_t getParticleSize () const
 
void init (T mean, T sigma)
 
template<typename GEN >
void initUsingNoiseGenerator (const GEN &generator)
 
T max ()
 
T maxBiased ()
 
void measure (std::function< FLT_TYPE(const T &)> likelihood)
 
void noise (T sigma)
 
 ParticleFilter (const int num_particles, const unsigned int random_seed=std::random_device()())
 
void predict (std::function< void(T &)> model)
 
void resample (T sigma)
 
template<typename GEN >
void resampleUsingNoiseGenerator (const GEN &generator)
 
void resizeParticle (const size_t num)
 

Protected Attributes

RANDOM_ENGINE engine_
 
T ie_
 
std::vector< Particle< T, FLT_TYPE > > particles_
 
std::vector< Particle< T, FLT_TYPE > > particles_dup_
 

Detailed Description

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
class mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >

Definition at line 156 of file pf.h.

Constructor & Destructor Documentation

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::ParticleFilter ( const int  num_particles,
const unsigned int  random_seed = std::random_device()() 
)
inlineexplicit

Definition at line 160 of file pf.h.

Member Function Documentation

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
template<typename GEN >
void mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::addNoiseUsingNoiseGenerator ( const GEN &  generator)
inline

Definition at line 227 of file pf.h.

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
std::vector<Particle<T, FLT_TYPE> >::iterator mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::appendParticle ( const size_t  num)
inline

Definition at line 426 of file pf.h.

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
std::vector<Particle<T, FLT_TYPE> >::iterator mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::begin ( )
inline

Definition at line 432 of file pf.h.

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
void mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::bias ( std::function< void(const T &, float &p_bias)>  prob)
inline

Definition at line 241 of file pf.h.

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
std::vector<T> mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::covariance ( const FLT_TYPE  pass_ratio = 1.0,
const FLT_TYPE  random_sample_ratio = 1.0 
)
inline

Definition at line 294 of file pf.h.

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
std::vector<Particle<T, FLT_TYPE> >::iterator mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::end ( )
inline

Definition at line 436 of file pf.h.

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
T mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::expectation ( const FLT_TYPE  pass_ratio = 1.0)
inline

Definition at line 270 of file pf.h.

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
T mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::expectationBiased ( )
inline

Definition at line 284 of file pf.h.

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
T mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::getParticle ( const size_t  i) const
inline

Definition at line 380 of file pf.h.

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
size_t mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::getParticleSize ( ) const
inline

Definition at line 384 of file pf.h.

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
void mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::init ( T  mean,
T  sigma 
)
inline

Definition at line 165 of file pf.h.

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
template<typename GEN >
void mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::initUsingNoiseGenerator ( const GEN &  generator)
inline

Definition at line 170 of file pf.h.

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
T mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::max ( )
inline

Definition at line 350 of file pf.h.

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
T mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::maxBiased ( )
inline

Definition at line 364 of file pf.h.

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
void mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::measure ( std::function< FLT_TYPE(const T &)>  likelihood)
inline

Definition at line 248 of file pf.h.

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
void mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::noise ( T  sigma)
inline

Definition at line 222 of file pf.h.

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
void mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::predict ( std::function< void(T &)>  model)
inline

Definition at line 234 of file pf.h.

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
void mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::resample ( T  sigma)
inline

Definition at line 178 of file pf.h.

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
template<typename GEN >
void mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::resampleUsingNoiseGenerator ( const GEN &  generator)
inline

Definition at line 183 of file pf.h.

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
void mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::resizeParticle ( const size_t  num)
inline

Definition at line 388 of file pf.h.

Member Data Documentation

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
RANDOM_ENGINE mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::engine_
protected

Definition at line 444 of file pf.h.

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
T mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::ie_
protected

Definition at line 445 of file pf.h.

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
std::vector<Particle<T, FLT_TYPE> > mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::particles_
protected

Definition at line 442 of file pf.h.

template<typename T, typename FLT_TYPE = float, typename MEAN = ParticleWeightedMean<T, FLT_TYPE>, typename RANDOM_ENGINE = std::default_random_engine>
std::vector<Particle<T, FLT_TYPE> > mcl_3dl::pf::ParticleFilter< T, FLT_TYPE, MEAN, RANDOM_ENGINE >::particles_dup_
protected

Definition at line 443 of file pf.h.

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

mcl_3dl
Author(s): Atsushi Watanabe
autogenerated on Wed May 12 2021 02:16:29