A probability distribution of a 2D/3D point, represented as a set of random samples (particles).
Definition at line 54 of file CPointPDFParticles.h.
#include <mrpt/poses/CPointPDFParticles.h>
Public Types | |
enum | { is_3D_val = 1 } |
enum | { is_PDF_val = 1 } |
typedef CPoint3D | type_value |
The type of the state the PDF represents. More... | |
typedef CProbabilityDensityFunction< CPoint3D, STATE_LEN > | self_t |
typedef TSimple3DPoint | CParticleDataContent |
This is the type inside the corresponding CParticleData class. More... | |
typedef CProbabilityParticle< TSimple3DPoint > | CParticleData |
Use this to refer to each element in the m_particles array. More... | |
typedef std::deque< CParticleData > | CParticleList |
Use this type to refer to the list of particles m_particles. More... | |
typedef double(* | TParticleProbabilityEvaluator) (const bayes::CParticleFilter::TParticleFilterOptions &PF_options, const CParticleFilterCapable *obj, size_t index, const void *action, const void *observation) |
A callback function type for evaluating the probability of m_particles of being selected, used in "fastDrawSample". More... | |
Public Member Functions | |
void * | operator new (size_t size) |
void * | operator new[] (size_t size) |
void | operator delete (void *ptr) throw () |
void | operator delete[] (void *ptr) throw () |
void | operator delete (void *memory, void *ptr) throw () |
void * | operator new (size_t size, const std::nothrow_t &) throw () |
void | operator delete (void *ptr, const std::nothrow_t &) throw () |
CPointPDFParticles (size_t numParticles=1) | |
Default constructor. More... | |
void | clear () |
Clear all the particles (free memory) More... | |
void | setSize (size_t numberParticles, const CPoint3D &defaultValue=CPoint3D(0, 0, 0)) |
Erase all the previous particles and change the number of particles, with a given initial value. More... | |
size_t | size () const |
Returns the number of particles. More... | |
void | getMean (CPoint3D &mean_point) const MRPT_OVERRIDE |
Returns an estimate of the point, (the mean, or mathematical expectation of the PDF) More... | |
void | getCovarianceAndMean (mrpt::math::CMatrixDouble33 &cov, CPoint3D &mean_point) const MRPT_OVERRIDE |
Returns an estimate of the point covariance matrix (3x3 cov matrix) and the mean, both at once. More... | |
void | copyFrom (const CPointPDF &o) MRPT_OVERRIDE |
Copy operator, translating if necesary (for example, between particles and gaussian representations) More... | |
void | saveToTextFile (const std::string &file) const MRPT_OVERRIDE |
Save PDF's particles to a text file, where each line is: X Y Z LOG_W. More... | |
void | changeCoordinatesReference (const CPose3D &newReferenceBase) MRPT_OVERRIDE |
this = p (+) this. More... | |
double | computeKurtosis () |
Compute the kurtosis of the distribution. More... | |
void | drawSingleSample (CPoint3D &outSample) const MRPT_OVERRIDE |
Draw a sample from the pdf. More... | |
void | bayesianFusion (const CPointPDF &p1, const CPointPDF &p2, const double &minMahalanobisDistToDrop=0) MRPT_OVERRIDE |
Bayesian fusion of two point distributions (product of two distributions->new distribution), then save the result in this object (WARNING: See implementing classes to see classes that can and cannot be mixtured!) More... | |
template<class OPENGL_SETOFOBJECTSPTR > | |
void | getAs3DObject (OPENGL_SETOFOBJECTSPTR &out_obj) const |
Returns a 3D representation of this PDF (it doesn't clear the current contents of out_obj, but append new OpenGL objects to that list) More... | |
template<class OPENGL_SETOFOBJECTSPTR , class OPENGL_SETOFOBJECTS > | |
OPENGL_SETOFOBJECTSPTR | getAs3DObject () const |
Returns a 3D representation of this PDF. More... | |
virtual mxArray * | writeToMatlab () const |
Introduces a pure virtual method responsible for writing to a mxArray Matlab object, typically a MATLAB struct whose contents are documented in each derived class. More... | |
CObject * | clone () const |
Cloning interface for smart pointers. More... | |
virtual void | getMean (CPoint3D &mean_point) const=0 |
Returns the mean, or mathematical expectation of the probability density distribution (PDF). More... | |
virtual void | getCovarianceAndMean (mrpt::math::CMatrixFixedNumeric< double, STATE_LEN, STATE_LEN > &cov, CPoint3D &mean_point) const=0 |
Returns an estimate of the pose covariance matrix (STATE_LENxSTATE_LEN cov matrix) and the mean, both at once. More... | |
void | getCovarianceDynAndMean (mrpt::math::CMatrixDouble &cov, CPoint3D &mean_point) const |
Returns an estimate of the pose covariance matrix (STATE_LENxSTATE_LEN cov matrix) and the mean, both at once. More... | |
CPoint3D | getMeanVal () const |
Returns the mean, or mathematical expectation of the probability density distribution (PDF). More... | |
void | getCovariance (mrpt::math::CMatrixDouble &cov) const |
Returns the estimate of the covariance matrix (STATE_LEN x STATE_LEN covariance matrix) More... | |
void | getCovariance (mrpt::math::CMatrixFixedNumeric< double, STATE_LEN, STATE_LEN > &cov) const |
Returns the estimate of the covariance matrix (STATE_LEN x STATE_LEN covariance matrix) More... | |
mrpt::math::CMatrixFixedNumeric< double, STATE_LEN, STATE_LEN > | getCovariance () const |
Returns the estimate of the covariance matrix (STATE_LEN x STATE_LEN covariance matrix) More... | |
virtual bool | isInfType () const |
Returns whether the class instance holds the uncertainty in covariance or information form. More... | |
virtual void | getInformationMatrix (mrpt::math::CMatrixFixedNumeric< double, STATE_LEN, STATE_LEN > &inf) const |
Returns the information (inverse covariance) matrix (a STATE_LEN x STATE_LEN matrix) Unless reimplemented in derived classes, this method first reads the covariance, then invert it. More... | |
virtual void | drawSingleSample (CPoint3D &outPart) const=0 |
Draws a single sample from the distribution. More... | |
virtual void | drawManySamples (size_t N, std::vector< mrpt::math::CVectorDouble > &outSamples) const |
Draws a number of samples from the distribution, and saves as a list of 1xSTATE_LEN vectors, where each row contains a (x,y,z,yaw,pitch,roll) datum. More... | |
double | getCovarianceEntropy () const |
Compute the entropy of the estimated covariance matrix. More... | |
void | clearParticles () |
Free the memory of all the particles and reset the array "m_particles" to length zero. More... | |
void | writeParticlesToStream (STREAM &out) const |
Dumps the sequence of particles and their weights to a stream (requires T implementing CSerializable). More... | |
void | readParticlesFromStream (STREAM &in) |
Reads the sequence of particles and their weights from a stream (requires T implementing CSerializable). More... | |
void | getWeights (std::vector< double > &out_logWeights) const |
Returns a vector with the sequence of the logaritmic weights of all the samples. More... | |
const CParticleData * | getMostLikelyParticle () const |
Returns the particle with the highest weight. More... | |
const CPointPDFParticles & | derived () const |
CRTP helper method. More... | |
CPointPDFParticles & | derived () |
CRTP helper method. More... | |
double | getW (size_t i) const MRPT_OVERRIDE |
Access to i'th particle (logarithm) weight, where first one is index 0. More... | |
void | setW (size_t i, double w) MRPT_OVERRIDE |
Modifies i'th particle (logarithm) weight, where first one is index 0. More... | |
size_t | particlesCount () const MRPT_OVERRIDE |
Get the m_particles count. More... | |
double | normalizeWeights (double *out_max_log_w=NULL) MRPT_OVERRIDE |
Normalize the (logarithmic) weights, such as the maximum weight is zero. More... | |
double | ESS () const MRPT_OVERRIDE |
Returns the normalized ESS (Estimated Sample Size), in the range [0,1]. More... | |
void | performSubstitution (const std::vector< size_t > &indx) MRPT_OVERRIDE |
Replaces the old particles by copies determined by the indexes in "indx", performing an efficient copy of the necesary particles only and allowing the number of particles to change. More... | |
void | prepareFastDrawSample (const bayes::CParticleFilter::TParticleFilterOptions &PF_options, TParticleProbabilityEvaluator partEvaluator=defaultEvaluator, const void *action=NULL, const void *observation=NULL) const |
Prepares data structures for calling fastDrawSample method next. More... | |
size_t | fastDrawSample (const bayes::CParticleFilter::TParticleFilterOptions &PF_options) const |
Draws a random sample from the particle filter, in such a way that each particle has a probability proportional to its weight (in the standard PF algorithm). More... | |
void | prediction_and_update (const mrpt::obs::CActionCollection *action, const mrpt::obs::CSensoryFrame *observation, const bayes::CParticleFilter::TParticleFilterOptions &PF_options) |
Performs the prediction stage of the Particle Filter. More... | |
void | performResampling (const bayes::CParticleFilter::TParticleFilterOptions &PF_options, size_t out_particle_count=0) |
Performs a resample of the m_particles, using the method selected in the constructor. More... | |
RTTI classes and functions | |
mrpt::utils::CObjectPtr | duplicateGetSmartPtr () const |
Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer). More... | |
Static Public Member Functions | |
static void * | operator new (size_t size, void *ptr) |
static bool | is_3D () |
static bool | is_PDF () |
static double | defaultEvaluator (const bayes::CParticleFilter::TParticleFilterOptions &PF_options, const CParticleFilterCapable *obj, size_t index, const void *action, const void *observation) |
The default evaluator function, which simply returns the particle weight. More... | |
static void | computeResampling (CParticleFilter::TParticleResamplingAlgorithm method, const std::vector< double > &in_logWeights, std::vector< size_t > &out_indexes, size_t out_particle_count=0) |
A static method to perform the computation of the samples resulting from resampling a given set of particles, given their logarithmic weights, and a resampling method. More... | |
static void | log2linearWeights (const std::vector< double > &in_logWeights, std::vector< double > &out_linWeights) |
A static method to compute the linear, normalized (the sum the unity) weights from log-weights. More... | |
Public Attributes | |
CParticleList | m_particles |
The array of particles. More... | |
Static Public Attributes | |
static const mrpt::utils::TRuntimeClassId | classCObject |
static const size_t | state_length |
The length of the variable, for example, 3 for a 3D point, 6 for a 3D pose (x y z yaw pitch roll). More... | |
RTTI stuff | |
static const mrpt::utils::TRuntimeClassId | classCPointPDF |
RTTI stuff | |
static const mrpt::utils::TRuntimeClassId | classCSerializable |
Protected Member Functions | |
virtual void | prediction_and_update_pfStandardProposal (const mrpt::obs::CActionCollection *action, const mrpt::obs::CSensoryFrame *observation, const bayes::CParticleFilter::TParticleFilterOptions &PF_options) |
Performs the particle filter prediction/update stages for the algorithm "pfStandardProposal" (if not implemented in heritated class, it will raise a 'non-implemented' exception). More... | |
virtual void | prediction_and_update_pfAuxiliaryPFStandard (const mrpt::obs::CActionCollection *action, const mrpt::obs::CSensoryFrame *observation, const bayes::CParticleFilter::TParticleFilterOptions &PF_options) |
Performs the particle filter prediction/update stages for the algorithm "pfAuxiliaryPFStandard" (if not implemented in heritated class, it will raise a 'non-implemented' exception). More... | |
virtual void | prediction_and_update_pfOptimalProposal (const mrpt::obs::CActionCollection *action, const mrpt::obs::CSensoryFrame *observation, const bayes::CParticleFilter::TParticleFilterOptions &PF_options) |
Performs the particle filter prediction/update stages for the algorithm "pfOptimalProposal" (if not implemented in heritated class, it will raise a 'non-implemented' exception). More... | |
virtual void | prediction_and_update_pfAuxiliaryPFOptimal (const mrpt::obs::CActionCollection *action, const mrpt::obs::CSensoryFrame *observation, const bayes::CParticleFilter::TParticleFilterOptions &PF_options) |
Performs the particle filter prediction/update stages for the algorithm "pfAuxiliaryPFOptimal" (if not implemented in heritated class, it will raise a 'non-implemented' exception). More... | |
CSerializable virtual methods | |
void | writeToStream (mrpt::utils::CStream &out, int *getVersion) const |
Introduces a pure virtual method responsible for writing to a CStream. More... | |
void | readFromStream (mrpt::utils::CStream &in, int version) |
Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori. More... | |
Protected Attributes | |
TFastDrawAuxVars | m_fastDrawAuxiliary |
Auxiliary vectors, see CParticleFilterCapable::prepareFastDrawSample for more information. More... | |
RTTI stuff | |
typedef CPointPDFParticlesPtr | Ptr |
typedef CPointPDFParticlesPtr | ConstPtr |
static mrpt::utils::CLASSINIT | _init_CPointPDFParticles |
static mrpt::utils::TRuntimeClassId | classCPointPDFParticles |
static const mrpt::utils::TRuntimeClassId * | classinfo |
static const mrpt::utils::TRuntimeClassId * | _GetBaseClass () |
virtual const mrpt::utils::TRuntimeClassId * | GetRuntimeClass () const |
Returns information about the class of an object in runtime. More... | |
virtual mrpt::utils::CObject * | duplicate () const |
Returns a copy of the object, indepently of its class. More... | |
static mrpt::utils::CObject * | CreateObject () |
static CPointPDFParticlesPtr | Create () |
typedef CPointPDFParticlesPtr mrpt::poses::CPointPDFParticles::ConstPtr |
Definition at line 60 of file CPointPDFParticles.h.
|
inherited |
Use this to refer to each element in the m_particles array.
Definition at line 174 of file CParticleFilterData.h.
|
inherited |
This is the type inside the corresponding CParticleData class.
Definition at line 173 of file CParticleFilterData.h.
|
inherited |
Use this type to refer to the list of particles m_particles.
Definition at line 175 of file CParticleFilterData.h.
typedef CPointPDFParticlesPtr mrpt::poses::CPointPDFParticles::Ptr |
A typedef for the associated smart pointer
Definition at line 60 of file CPointPDFParticles.h.
|
inherited |
Definition at line 33 of file CProbabilityDensityFunction.h.
|
inherited |
A callback function type for evaluating the probability of m_particles of being selected, used in "fastDrawSample".
The default evaluator function "defaultEvaluator" simply returns the particle weight.
index | This is the index of the particle its probability is being computed. |
action | The value of this is the parameter passed to "prepareFastDrawSample" |
observation | The value of this is the parameter passed to "prepareFastDrawSample" The action and the observation are declared as "void*" for a greater flexibility. |
Definition at line 54 of file CParticleFilterCapable.h.
|
inherited |
The type of the state the PDF represents.
Definition at line 32 of file CProbabilityDensityFunction.h.
|
inherited |
Enumerator | |
---|---|
is_3D_val |
Definition at line 55 of file CPointPDF.h.
|
inherited |
Enumerator | |
---|---|
is_PDF_val |
Definition at line 57 of file CPointPDF.h.
CPointPDFParticles::CPointPDFParticles | ( | size_t | numParticles = 1 | ) |
|
staticprotected |
|
virtual |
Bayesian fusion of two point distributions (product of two distributions->new distribution), then save the result in this object (WARNING: See implementing classes to see classes that can and cannot be mixtured!)
p1 | The first distribution to fuse |
p2 | The second distribution to fuse |
minMahalanobisDistToDrop | If set to different of 0, the result of very separate Gaussian modes (that will result in negligible components) in SOGs will be dropped to reduce the number of modes in the output. |
Implements mrpt::poses::CPointPDF.
Definition at line 285 of file CPointPDFParticles.cpp.
References MRPT_END, MRPT_START, MRPT_UNUSED_PARAM, and THROW_EXCEPTION.
this = p (+) this.
This can be used to convert a PDF from local coordinates to global, providing the point (newReferenceBase) from which "to project" the current pdf. Result PDF substituted the currently stored one in the object. Both the mean value and the covariance matrix are updated correctly.
Implements mrpt::utils::CProbabilityDensityFunction< CPoint3D, 3 >.
Definition at line 205 of file CPointPDFParticles.cpp.
References mrpt::poses::CPose3D::composePoint(), mrpt::math::TPoint3D::x, mrpt::math::TPoint3D::y, and mrpt::math::TPoint3D::z.
void CPointPDFParticles::clear | ( | ) |
Clear all the particles (free memory)
Definition at line 34 of file CPointPDFParticles.cpp.
References setSize().
Referenced by mrpt::maps::CBeaconMap::internal_insertObservation().
|
inlineinherited |
Free the memory of all the particles and reset the array "m_particles" to length zero.
Definition at line 183 of file CParticleFilterData.h.
|
inlineinherited |
double CPointPDFParticles::computeKurtosis | ( | ) |
Compute the kurtosis of the distribution.
Definition at line 223 of file CPointPDFParticles.cpp.
References mrpt::math::maximum(), MRPT_END, MRPT_START, and mrpt::math::square().
|
staticinherited |
A static method to perform the computation of the samples resulting from resampling a given set of particles, given their logarithmic weights, and a resampling method.
It returns the sequence of indexes from the resampling. The number of output samples is the same than the input population. This generic method just computes these indexes, to actually perform a resampling in a particle filter object, call performResampling
[in] | out_particle_count | The desired number of output particles after resampling; 0 means don't modify the current number. |
Definition at line 64 of file CParticleFilterCapable.cpp.
References ASSERT_, mrpt::random::CRandomGenerator::drawUniform(), mrpt::random::CRandomGenerator::drawUniformVector(), mrpt::format(), mrpt::math::maximum(), MRPT_END, MRPT_START, R, mrpt::random::randomGenerator, and THROW_EXCEPTION.
Copy operator, translating if necesary (for example, between particles and gaussian representations)
Implements mrpt::poses::CPointPDF.
Definition at line 175 of file CPointPDFParticles.cpp.
References THROW_EXCEPTION.
|
static |
|
static |
|
inlinestaticinherited |
The default evaluator function, which simply returns the particle weight.
The action and the observation are declared as "void*" for a greater flexibility.
Definition at line 65 of file CParticleFilterCapable.h.
References MRPT_UNUSED_PARAM.
|
inlineinherited |
CRTP helper method.
Definition at line 34 of file CParticleFilterData.h.
|
inlineinherited |
CRTP helper method.
Definition at line 36 of file CParticleFilterData.h.
|
inlinevirtualinherited |
Draws a number of samples from the distribution, and saves as a list of 1xSTATE_LEN vectors, where each row contains a (x,y,z,yaw,pitch,roll) datum.
This base method just call N times to drawSingleSample, but derived classes should implemented optimized method for each particular PDF.
Definition at line 125 of file CProbabilityDensityFunction.h.
Draw a sample from the pdf.
Definition at line 276 of file CPointPDFParticles.cpp.
References MRPT_UNUSED_PARAM, and THROW_EXCEPTION.
|
pure virtualinherited |
Draws a single sample from the distribution.
|
virtual |
Returns a copy of the object, indepently of its class.
Implements mrpt::utils::CObject.
|
inlineinherited |
Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer).
Definition at line 162 of file CObject.h.
References mrpt::utils::CObjectPtr.
Referenced by mrpt::obs::CRawlog::addActions(), mrpt::slam::CIncrementalMapPartitioner::addMapFrame(), and mrpt::obs::CRawlog::addObservations().
|
inlinevirtualinherited |
Returns the normalized ESS (Estimated Sample Size), in the range [0,1].
Note that you do NOT need to normalize the weights before calling this.
Implements mrpt::bayes::CParticleFilterCapable.
Definition at line 78 of file CParticleFilterData.h.
|
inherited |
Draws a random sample from the particle filter, in such a way that each particle has a probability proportional to its weight (in the standard PF algorithm).
This method can be used to generate a variable number of m_particles when resampling: to vary the number of m_particles in the filter. See prepareFastDrawSample for more information, or the Particle Filter tutorial.
NOTES:
Definition at line 454 of file CParticleFilterCapable.cpp.
References mrpt::bayes::CParticleFilter::TParticleFilterOptions::adaptiveSampleSize, mrpt::random::CRandomGenerator::drawUniform(), MRPT_END, MRPT_END_WITH_CLEAN_UP, MRPT_START, mrpt::random::randomGenerator, mrpt::bayes::CParticleFilter::TParticleFilterOptions::resamplingMethod, and THROW_EXCEPTION.
Referenced by mrpt::hmtslam::CLSLAM_RBPF_2DLASER::prediction_and_update_pfAuxiliaryPFOptimal().
|
inlineinherited |
Returns a 3D representation of this PDF (it doesn't clear the current contents of out_obj, but append new OpenGL objects to that list)
Definition at line 65 of file CPointPDF.h.
References mrpt::opengl::posePDF2opengl().
|
inlineinherited |
Returns a 3D representation of this PDF.
Definition at line 74 of file CPointPDF.h.
References mrpt::opengl::posePDF2opengl().
|
inlineinherited |
Returns the estimate of the covariance matrix (STATE_LEN x STATE_LEN covariance matrix)
Definition at line 68 of file CProbabilityDensityFunction.h.
|
inlineinherited |
Returns the estimate of the covariance matrix (STATE_LEN x STATE_LEN covariance matrix)
Definition at line 77 of file CProbabilityDensityFunction.h.
|
inlineinherited |
Returns the estimate of the covariance matrix (STATE_LEN x STATE_LEN covariance matrix)
Definition at line 86 of file CProbabilityDensityFunction.h.
|
pure virtualinherited |
Returns an estimate of the pose covariance matrix (STATE_LENxSTATE_LEN cov matrix) and the mean, both at once.
void CPointPDFParticles::getCovarianceAndMean | ( | mrpt::math::CMatrixDouble33 & | cov, |
CPoint3D & | mean_point | ||
) | const |
Returns an estimate of the point covariance matrix (3x3 cov matrix) and the mean, both at once.
Definition at line 90 of file CPointPDFParticles.cpp.
References mrpt::math::cov(), mean(), MRPT_END, MRPT_START, and mrpt::math::square().
Referenced by mrpt::maps::CBeaconMap::internal_insertObservation().
|
inlineinherited |
Returns an estimate of the pose covariance matrix (STATE_LENxSTATE_LEN cov matrix) and the mean, both at once.
Definition at line 48 of file CProbabilityDensityFunction.h.
|
inlineinherited |
Compute the entropy of the estimated covariance matrix.
Definition at line 144 of file CProbabilityDensityFunction.h.
|
inlinevirtualinherited |
Returns the information (inverse covariance) matrix (a STATE_LEN x STATE_LEN matrix) Unless reimplemented in derived classes, this method first reads the covariance, then invert it.
Definition at line 106 of file CProbabilityDensityFunction.h.
|
pure virtualinherited |
Returns the mean, or mathematical expectation of the probability density distribution (PDF).
Returns an estimate of the point, (the mean, or mathematical expectation of the PDF)
Definition at line 58 of file CPointPDFParticles.cpp.
References ASSERT_, MRPT_END, MRPT_START, and THROW_EXCEPTION.
|
inlineinherited |
Returns the mean, or mathematical expectation of the probability density distribution (PDF).
Definition at line 58 of file CProbabilityDensityFunction.h.
|
inlineinherited |
Returns the particle with the highest weight.
Definition at line 240 of file CParticleFilterData.h.
|
virtual |
Returns information about the class of an object in runtime.
Reimplemented from mrpt::poses::CPointPDF.
|
inlinevirtualinherited |
Access to i'th particle (logarithm) weight, where first one is index 0.
Implements mrpt::bayes::CParticleFilterCapable.
Definition at line 38 of file CParticleFilterData.h.
|
inlineinherited |
Returns a vector with the sequence of the logaritmic weights of all the samples.
Definition at line 227 of file CParticleFilterData.h.
|
inlinestaticinherited |
Definition at line 56 of file CPointPDF.h.
|
inlinestaticinherited |
Definition at line 58 of file CPointPDF.h.
|
inlinevirtualinherited |
Returns whether the class instance holds the uncertainty in covariance or information form.
Definition at line 100 of file CProbabilityDensityFunction.h.
|
staticinherited |
A static method to compute the linear, normalized (the sum the unity) weights from log-weights.
Definition at line 509 of file CParticleFilterCapable.cpp.
References ASSERT_, MRPT_END, and MRPT_START.
|
inlinevirtualinherited |
Normalize the (logarithmic) weights, such as the maximum weight is zero.
out_max_log_w | If provided, will return with the maximum log_w before normalizing, such as new_weights = old_weights - max_log_w. |
Implements mrpt::bayes::CParticleFilterCapable.
Definition at line 55 of file CParticleFilterData.h.
|
inline |
Definition at line 60 of file CPointPDFParticles.h.
|
inline |
Definition at line 60 of file CPointPDFParticles.h.
Definition at line 60 of file CPointPDFParticles.h.
Definition at line 60 of file CPointPDFParticles.h.
Definition at line 60 of file CPointPDFParticles.h.
|
inline |
Definition at line 60 of file CPointPDFParticles.h.
|
inline |
Definition at line 60 of file CPointPDFParticles.h.
|
inline |
Definition at line 60 of file CPointPDFParticles.h.
|
inlinevirtualinherited |
Get the m_particles count.
Implements mrpt::bayes::CParticleFilterCapable.
Definition at line 50 of file CParticleFilterData.h.
|
inherited |
Performs a resample of the m_particles, using the method selected in the constructor.
After computing the surviving samples, this method internally calls "performSubstitution" to actually perform the particle replacement. This method is called automatically by CParticleFilter::execute, andshould not be invoked manually normally. To just obtaining the sequence of resampled indexes from a sequence of weights, use "resample"
[in] | out_particle_count | The desired number of output particles after resampling; 0 means don't modify the current number. |
Definition at line 29 of file CParticleFilterCapable.cpp.
References ASSERT_, MRPT_END, MRPT_START, and mrpt::bayes::CParticleFilter::TParticleFilterOptions::resamplingMethod.
|
inlinevirtualinherited |
Replaces the old particles by copies determined by the indexes in "indx", performing an efficient copy of the necesary particles only and allowing the number of particles to change.
Implements mrpt::bayes::CParticleFilterCapable.
Definition at line 98 of file CParticleFilterData.h.
|
inherited |
Performs the prediction stage of the Particle Filter.
This method simply selects the appropiate protected method according to the particle filter algorithm to run.
Definition at line 272 of file CParticleFilterCapable.cpp.
References mrpt::bayes::CParticleFilter::TParticleFilterOptions::PF_algorithm, and THROW_EXCEPTION.
|
protectedvirtualinherited |
Performs the particle filter prediction/update stages for the algorithm "pfAuxiliaryPFOptimal" (if not implemented in heritated class, it will raise a 'non-implemented' exception).
Reimplemented in mrpt::hmtslam::CLocalMetricHypothesis, mrpt::slam::CMonteCarloLocalization2D, mrpt::maps::CMultiMetricMapPDF, and mrpt::slam::CMonteCarloLocalization3D.
Definition at line 336 of file CParticleFilterCapable.cpp.
References MRPT_UNUSED_PARAM, and THROW_EXCEPTION.
|
protectedvirtualinherited |
Performs the particle filter prediction/update stages for the algorithm "pfAuxiliaryPFStandard" (if not implemented in heritated class, it will raise a 'non-implemented' exception).
Reimplemented in mrpt::slam::CMonteCarloLocalization2D, mrpt::maps::CMultiMetricMapPDF, and mrpt::slam::CMonteCarloLocalization3D.
Definition at line 314 of file CParticleFilterCapable.cpp.
References MRPT_UNUSED_PARAM, and THROW_EXCEPTION.
|
protectedvirtualinherited |
Performs the particle filter prediction/update stages for the algorithm "pfOptimalProposal" (if not implemented in heritated class, it will raise a 'non-implemented' exception).
Reimplemented in mrpt::hmtslam::CLocalMetricHypothesis, and mrpt::maps::CMultiMetricMapPDF.
Definition at line 325 of file CParticleFilterCapable.cpp.
References MRPT_UNUSED_PARAM, and THROW_EXCEPTION.
|
protectedvirtualinherited |
Performs the particle filter prediction/update stages for the algorithm "pfStandardProposal" (if not implemented in heritated class, it will raise a 'non-implemented' exception).
Reimplemented in mrpt::slam::CMonteCarloLocalization2D, mrpt::maps::CMultiMetricMapPDF, and mrpt::slam::CMonteCarloLocalization3D.
Definition at line 303 of file CParticleFilterCapable.cpp.
References MRPT_UNUSED_PARAM, and THROW_EXCEPTION.
|
inherited |
Prepares data structures for calling fastDrawSample method next.
This method must be called once before using "fastDrawSample" (calling this more than once has no effect, but it takes time for nothing!) The behavior depends on the configuration of the PF (see CParticleFilter::TParticleFilterOptions):
The function pointed by "partEvaluator" should take into account the particle filter algorithm selected in "m_PFAlgorithm". If called without arguments (defaultEvaluator), the default behavior is to draw samples with a probability proportional to their current weights. The action and the observation are declared as "void*" for a greater flexibility. For a more detailed information see the Particle Filter tutorial. Custom supplied "partEvaluator" functions must take into account the previous particle weight, i.e. multiplying the current observation likelihood by the weights.
Definition at line 348 of file CParticleFilterCapable.cpp.
References mrpt::bayes::CParticleFilter::TParticleFilterOptions::adaptiveSampleSize, ASSERT_, mrpt::math::maximum(), MRPT_CHECK_NORMAL_NUMBER, MRPT_END, MRPT_END_WITH_CLEAN_UP, MRPT_START, mrpt::bayes::CParticleFilter::TParticleFilterOptions::resamplingMethod, and THROW_EXCEPTION.
Referenced by mrpt::hmtslam::CLSLAM_RBPF_2DLASER::prediction_and_update_pfAuxiliaryPFOptimal().
|
protectedvirtual |
Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori.
in | The input binary stream where the object data must read from. |
version | The version of the object stored in the stream: use this version number in your code to know how to read the incoming data. |
std::exception | On any error, see CStream::ReadBuffer |
Implements mrpt::utils::CSerializable.
Definition at line 156 of file CPointPDFParticles.cpp.
References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, setSize(), and version.
|
inlineinherited |
Reads the sequence of particles and their weights from a stream (requires T implementing CSerializable).
Definition at line 207 of file CParticleFilterData.h.
|
virtual |
Save PDF's particles to a text file, where each line is: X Y Z LOG_W.
Implements mrpt::utils::CProbabilityDensityFunction< CPoint3D, 3 >.
Definition at line 186 of file CPointPDFParticles.cpp.
References mrpt::system::os::fclose(), mrpt::system::os::fopen(), mrpt::system::os::fprintf(), MRPT_END, and MRPT_START.
void CPointPDFParticles::setSize | ( | size_t | numberParticles, |
const CPoint3D & | defaultValue = CPoint3D(0,0,0) |
||
) |
Erase all the previous particles and change the number of particles, with a given initial value.
Definition at line 41 of file CPointPDFParticles.cpp.
Referenced by mrpt::maps::CBeaconMap::internal_insertObservation().
|
inlinevirtualinherited |
Modifies i'th particle (logarithm) weight, where first one is index 0.
Implements mrpt::bayes::CParticleFilterCapable.
Definition at line 44 of file CParticleFilterData.h.
|
inline |
Returns the number of particles.
Definition at line 73 of file CPointPDFParticles.h.
|
inlineinherited |
Dumps the sequence of particles and their weights to a stream (requires T implementing CSerializable).
Definition at line 192 of file CParticleFilterData.h.
|
inlinevirtualinherited |
Introduces a pure virtual method responsible for writing to a mxArray
Matlab object, typically a MATLAB struct
whose contents are documented in each derived class.
mxArray
(caller is responsible of memory freeing) or NULL is class does not support conversion to MATLAB. Definition at line 79 of file CSerializable.h.
|
protectedvirtual |
Introduces a pure virtual method responsible for writing to a CStream.
This can not be used directly be users, instead use "stream << object;" for writing it to a stream.
out | The output binary stream where object must be dumped. |
getVersion | If NULL, the object must be dumped. If not, only the version of the object dump must be returned in this pointer. This enables the versioning of objects dumping and backward compatibility with previously stored data. |
std::exception | On any error, see CStream::WriteBuffer |
Implements mrpt::utils::CSerializable.
Definition at line 139 of file CPointPDFParticles.cpp.
References version.
|
staticprotected |
Definition at line 60 of file CPointPDFParticles.h.
|
staticinherited |
|
staticinherited |
Definition at line 40 of file CPointPDF.h.
|
static |
Definition at line 60 of file CPointPDFParticles.h.
|
staticinherited |
Definition at line 42 of file CSerializable.h.
|
static |
Definition at line 60 of file CPointPDFParticles.h.
|
mutableprotectedinherited |
Auxiliary vectors, see CParticleFilterCapable::prepareFastDrawSample for more information.
Definition at line 233 of file CParticleFilterCapable.h.
|
inherited |
The array of particles.
Definition at line 177 of file CParticleFilterData.h.
|
staticinherited |
The length of the variable, for example, 3 for a 3D point, 6 for a 3D pose (x y z yaw pitch roll).
Definition at line 31 of file CProbabilityDensityFunction.h.
Referenced by mrpt::poses::CPointPDFGaussian::productIntegralWith(), and mrpt::poses::CPointPDFGaussian::productIntegralWith2D().
Page generated by Doxygen 1.8.14 for MRPT 1.5.7 Git: 5902e14cc Wed Apr 24 15:04:01 2019 +0200 at lun oct 28 01:39:17 CET 2019 |