Main MRPT website > C++ reference for MRPT 1.9.9
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Attributes
mrpt::poses::CPose3DPDFParticles Class Referenceabstract

Detailed Description

Declares a class that represents a Probability Density function (PDF) of a 3D pose.

This class is also the base for the implementation of Monte-Carlo Localization (MCL), in mrpt::slam::CMonteCarloLocalization2D.

See the application "app/pf-localization" for an example of usage.

See also
CPose3D, CPose3DPDF, CPoseGaussianPDF

Definition at line 31 of file CPose3DPDFParticles.h.

#include <mrpt/poses/CPose3DPDFParticles.h>

Inheritance diagram for mrpt::poses::CPose3DPDFParticles:
Inheritance graph

Public Types

enum  { is_3D_val = 1 }
 
enum  { is_PDF_val = 1 }
 
typedef CPose3D type_value
 The type of the state the PDF represents. More...
 
typedef CProbabilityDensityFunction< CPose3D, STATE_LEN > self_t
 
typedef CPose3D CParticleDataContent
 This is the type inside the corresponding CParticleData class. More...
 
typedef CProbabilityParticle< CPose3DCParticleData
 Use this to refer to each element in the m_particles array. More...
 
typedef std::deque< CParticleDataCParticleList
 Use this type to refer to the list of particles m_particles. More...
 
using TParticleProbabilityEvaluator = std::function< double(size_t index)>
 A callback function type for evaluating the probability of m_particles of being selected, used in "fastDrawSample". More...
 

Public Member Functions

voidoperator new (size_t size)
 
voidoperator new[] (size_t size)
 
void operator delete (void *ptr) noexcept
 
void operator delete[] (void *ptr) noexcept
 
void operator delete (void *memory, void *ptr) noexcept
 
voidoperator new (size_t size, const std::nothrow_t &) noexcept
 
void operator delete (void *ptr, const std::nothrow_t &) noexcept
 
 CPose3DPDFParticles (size_t M=1)
 Constructor. More...
 
void copyFrom (const CPose3DPDF &o) override
 Copy operator, translating if necesary (for example, between m_particles and gaussian representations) More...
 
void resetDeterministic (const CPose3D &location, size_t particlesCount=0)
 Reset the PDF to a single point: All m_particles will be set exactly to the supplied pose. More...
 
void getMean (CPose3D &mean_pose) const override
 Returns an estimate of the pose, (the mean, or mathematical expectation of the PDF), computed as a weighted average over all m_particles. More...
 
void getCovarianceAndMean (mrpt::math::CMatrixDouble66 &cov, CPose3D &mean_point) const override
 Returns an estimate of the pose covariance matrix (6x6 cov matrix) and the mean, both at once. More...
 
CPose3D getParticlePose (int i) const
 Returns the pose of the i'th particle. More...
 
void saveToTextFile (const std::string &file) const override
 Save PDF's m_particles to a text file. More...
 
size_t size () const
 Get the m_particles count (equivalent to "particlesCount") More...
 
void changeCoordinatesReference (const CPose3D &newReferenceBase) override
 this = p (+) this. More...
 
void drawSingleSample (CPose3D &outPart) const override
 Draws a single sample from the distribution (WARNING: weights are assumed to be normalized!) More...
 
void drawManySamples (size_t N, std::vector< mrpt::math::CVectorDouble > &outSamples) const override
 Draws a number of samples from the distribution, and saves as a list of 1x6 vectors, where each row contains a (x,y,phi) datum. More...
 
void operator+= (const CPose3D &Ap)
 Appends (pose-composition) a given pose "p" to each particle. More...
 
void append (CPose3DPDFParticles &o)
 Appends (add to the list) a set of m_particles to the existing ones, and then normalize weights. More...
 
void inverse (CPose3DPDF &o) const override
 Returns a new PDF such as: NEW_PDF = (0,0,0) - THIS_PDF. More...
 
CPose3D getMostLikelyParticle () const
 Returns the particle with the highest weight. More...
 
void bayesianFusion (const CPose3DPDF &p1, const CPose3DPDF &p2) override
 Bayesian fusion. 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 >
OPENGL_SETOFOBJECTSPTR getAs3DObject () const
 Returns a 3D representation of this PDF. More...
 
virtual mxArraywriteToMatlab () 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...
 
virtual void getMean (CPose3D &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, CPose3D &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, CPose3D &mean_point) const
 Returns an estimate of the pose covariance matrix (STATE_LENxSTATE_LEN cov matrix) and the mean, both at once. More...
 
CPose3D 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 (CPose3D &outPart) const=0
 Draws a single sample from the distribution. 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 CPose3DPDFParticlesderived () const
 CRTP helper method. More...
 
CPose3DPDFParticlesderived ()
 CRTP helper method. More...
 
double getW (size_t i) const override
 Access to i'th particle (logarithm) weight, where first one is index 0. More...
 
void setW (size_t i, double w) override
 Modifies i'th particle (logarithm) weight, where first one is index 0. More...
 
size_t particlesCount () const override
 Get the m_particles count. More...
 
double normalizeWeights (double *out_max_log_w=nullptr) override
 Normalize the (logarithmic) weights, such as the maximum weight is zero. More...
 
double ESS () const override
 Returns the normalized ESS (Estimated Sample Size), in the range [0,1]. More...
 
void performSubstitution (const std::vector< size_t > &indx) 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) const
 The default evaluator function, which simply returns the particle weight. More...
 
void prepareFastDrawSample (const bayes::CParticleFilter::TParticleFilterOptions &PF_options, TParticleProbabilityEvaluator partEvaluator) 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 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::CObject::Ptr 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 voidoperator new (size_t size, void *ptr)
 
static CPose3DPDFcreateFrom2D (const CPosePDF &o)
 This is a static transformation method from 2D poses to 3D PDFs, preserving the representation type (particles->particles, Gaussians->Gaussians,etc) It returns a new object of any of the derived classes of CPose3DPDF. More...
 
static void jacobiansPoseComposition (const CPose3D &x, const CPose3D &u, mrpt::math::CMatrixDouble66 &df_dx, mrpt::math::CMatrixDouble66 &df_du)
 This static method computes the pose composition Jacobians. More...
 
static bool is_3D ()
 
static bool is_PDF ()
 
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 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...
 

Protected Member Functions

CSerializable virtual methods
void writeToStream (mrpt::utils::CStream &out, int *getVersion) const override
 Introduces a pure virtual method responsible for writing to a CStream. More...
 
void readFromStream (mrpt::utils::CStream &in, int version) override
 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

using Ptr = std::shared_ptr< CPose3DPDFParticles >
 
using ConstPtr = std::shared_ptr< const CPose3DPDFParticles >
 
static mrpt::utils::CLASSINIT _init_CPose3DPDFParticles
 
static const mrpt::utils::TRuntimeClassId runtimeClassId
 
static constexpr const char * className = "CPose3DPDFParticles"
 
static const mrpt::utils::TRuntimeClassId_GetBaseClass ()
 
static const mrpt::utils::TRuntimeClassIdGetRuntimeClassIdStatic ()
 
static mrpt::utils::CObjectCreateObject ()
 
template<typename... Args>
static Ptr Create (Args &&... args)
 
virtual const mrpt::utils::TRuntimeClassIdGetRuntimeClass () const override
 Returns information about the class of an object in runtime. More...
 
virtual mrpt::utils::CObjectclone () const override
 Returns a deep copy (clone) of the object, indepently of its class. More...
 

Member Typedef Documentation

◆ ConstPtr

Definition at line 38 of file CPose3DPDFParticles.h.

◆ CParticleData

typedef CProbabilityParticle<CPose3D > mrpt::bayes::CParticleFilterData< CPose3D >::CParticleData
inherited

Use this to refer to each element in the m_particles array.

Definition at line 203 of file CParticleFilterData.h.

◆ CParticleDataContent

This is the type inside the corresponding CParticleData class.

Definition at line 201 of file CParticleFilterData.h.

◆ CParticleList

Use this type to refer to the list of particles m_particles.

Definition at line 205 of file CParticleFilterData.h.

◆ Ptr

A typedef for the associated smart pointer

Definition at line 38 of file CPose3DPDFParticles.h.

◆ self_t

typedef CProbabilityDensityFunction<CPose3D , STATE_LEN> mrpt::utils::CProbabilityDensityFunction< CPose3D , STATE_LEN >::self_t
inherited

Definition at line 37 of file CProbabilityDensityFunction.h.

◆ TParticleProbabilityEvaluator

using mrpt::bayes::CParticleFilterCapable::TParticleProbabilityEvaluator = std::function<double(size_t index)>
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.

Parameters
indexThis is the index of the particle its probability is being computed.
actionThe value of this is the parameter passed to "prepareFastDrawSample"
observationThe value of this is the parameter passed to "prepareFastDrawSample" The action and the observation are declared as "void*" for a greater flexibility.
See also
prepareFastDrawSample

Definition at line 60 of file CParticleFilterCapable.h.

◆ type_value

The type of the state the PDF represents.

Definition at line 36 of file CProbabilityDensityFunction.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited
Enumerator
is_3D_val 

Definition at line 98 of file CPose3DPDF.h.

◆ anonymous enum

anonymous enum
inherited
Enumerator
is_PDF_val 

Definition at line 103 of file CPose3DPDF.h.

Constructor & Destructor Documentation

◆ CPose3DPDFParticles()

CPose3DPDFParticles::CPose3DPDFParticles ( size_t  M = 1)

Constructor.

Parameters
MThe number of m_particles.

Definition at line 30 of file CPose3DPDFParticles.cpp.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId* mrpt::poses::CPose3DPDFParticles::_GetBaseClass ( )
staticprotected

◆ append()

void CPose3DPDFParticles::append ( CPose3DPDFParticles o)

Appends (add to the list) a set of m_particles to the existing ones, and then normalize weights.

Definition at line 318 of file CPose3DPDFParticles.cpp.

References MRPT_UNUSED_PARAM, and THROW_EXCEPTION.

◆ bayesianFusion()

void CPose3DPDFParticles::bayesianFusion ( const CPose3DPDF p1,
const CPose3DPDF p2 
)
overridevirtual

Bayesian fusion.

Implements mrpt::poses::CPose3DPDF.

Definition at line 369 of file CPose3DPDFParticles.cpp.

References MRPT_UNUSED_PARAM, and THROW_EXCEPTION.

◆ changeCoordinatesReference()

void CPose3DPDFParticles::changeCoordinatesReference ( const CPose3D newReferenceBase)
overridevirtual

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.

Implements mrpt::utils::CProbabilityDensityFunction< CPose3D, 6 >.

Definition at line 278 of file CPose3DPDFParticles.cpp.

◆ clearParticles()

void mrpt::bayes::CParticleFilterData< CPose3D >::clearParticles ( )
inlineinherited

Free the memory of all the particles and reset the array "m_particles" to length zero.

Definition at line 214 of file CParticleFilterData.h.

◆ clone()

virtual mrpt::utils::CObject* mrpt::poses::CPose3DPDFParticles::clone ( ) const
overridevirtual

Returns a deep copy (clone) of the object, indepently of its class.

Implements mrpt::utils::CObject.

◆ computeResampling()

void CParticleFilterCapable::computeResampling ( CParticleFilter::TParticleResamplingAlgorithm  method,
const std::vector< double > &  in_logWeights,
std::vector< size_t > &  out_indexes,
size_t  out_particle_count = 0 
)
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

Parameters
[in]out_particle_countThe desired number of output particles after resampling; 0 means don't modify the current number.
See also
performResampling

Definition at line 61 of file CParticleFilterCapable.cpp.

References ASSERT_, mrpt::random::CRandomGenerator::drawUniform(), mrpt::random::CRandomGenerator::drawUniformVector(), mrpt::format(), mrpt::random::getRandomGenerator(), mrpt::math::maximum(), MRPT_END, MRPT_START, R, and THROW_EXCEPTION.

Here is the call graph for this function:

◆ copyFrom()

void CPose3DPDFParticles::copyFrom ( const CPose3DPDF o)
overridevirtual

Copy operator, translating if necesary (for example, between m_particles and gaussian representations)

Implements mrpt::poses::CPose3DPDF.

Definition at line 44 of file CPose3DPDFParticles.cpp.

References ASSERT_, CLASS_ID, mrpt::poses::CPose3DPDF::GetRuntimeClass(), mrpt::bayes::CParticleFilterData< T >::m_particles, MRPT_END, MRPT_START, and THROW_EXCEPTION.

Referenced by inverse(), and mrpt::hmtslam::CLocalMetricHypothesis::updateAreaFromLMH().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Create()

template<typename... Args>
static Ptr mrpt::poses::CPose3DPDFParticles::Create ( Args &&...  args)
inlinestatic

Definition at line 38 of file CPose3DPDFParticles.h.

◆ createFrom2D()

CPose3DPDF * CPose3DPDF::createFrom2D ( const CPosePDF o)
staticinherited

This is a static transformation method from 2D poses to 3D PDFs, preserving the representation type (particles->particles, Gaussians->Gaussians,etc) It returns a new object of any of the derived classes of CPose3DPDF.

This object must be deleted by the user when not required anymore.

See also
copyFrom

Definition at line 34 of file CPose3DPDF.cpp.

References mrpt::poses::CPose3DPDFSOG::begin(), CLASS_ID, mrpt::poses::CPose3DPDFGaussian::cov, mrpt::poses::CPose3DPDFGaussianInf::cov_inv, mrpt::bayes::CParticleFilterData< T >::m_particles, mrpt::poses::CPose3DPDFGaussianInf::mean, mrpt::poses::CPose3DPDFGaussian::mean, MRPT_END, MRPT_START, and THROW_EXCEPTION.

Here is the call graph for this function:

◆ CreateObject()

static mrpt::utils::CObject* mrpt::poses::CPose3DPDFParticles::CreateObject ( )
static

◆ derived() [1/2]

CRTP helper method.

Definition at line 35 of file CParticleFilterData.h.

◆ derived() [2/2]

CRTP helper method.

Definition at line 40 of file CParticleFilterData.h.

◆ drawManySamples()

void CPose3DPDFParticles::drawManySamples ( size_t  N,
std::vector< mrpt::math::CVectorDouble > &  outSamples 
) const
overridevirtual

Draws a number of samples from the distribution, and saves as a list of 1x6 vectors, where each row contains a (x,y,phi) datum.

Reimplemented from mrpt::utils::CProbabilityDensityFunction< CPose3D, 6 >.

Definition at line 298 of file CPose3DPDFParticles.cpp.

References MRPT_UNUSED_PARAM, and THROW_EXCEPTION.

◆ drawSingleSample() [1/2]

void CPose3DPDFParticles::drawSingleSample ( CPose3D outPart) const
override

Draws a single sample from the distribution (WARNING: weights are assumed to be normalized!)

Definition at line 289 of file CPose3DPDFParticles.cpp.

References MRPT_UNUSED_PARAM, and THROW_EXCEPTION.

Referenced by mrpt::poses::CPoseRandomSampler::do_sample_3D().

Here is the caller graph for this function:

◆ drawSingleSample() [2/2]

virtual void mrpt::utils::CProbabilityDensityFunction< CPose3D , STATE_LEN >::drawSingleSample ( CPose3D &  outPart) const
pure virtualinherited

Draws a single sample from the distribution.

◆ ESS()

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 87 of file CParticleFilterData.h.

◆ fastDrawSample()

size_t CParticleFilterCapable::fastDrawSample ( const bayes::CParticleFilter::TParticleFilterOptions PF_options) const
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:

  • You MUST call "prepareFastDrawSample" ONCE before calling this method. That method must be called after modifying the particle filter (executing one step, resampling, etc...)
  • This method returns ONE index for the selected ("drawn") particle, in the range [0,M-1]
  • You do not need to call "normalizeWeights" before calling this.
    See also
    prepareFastDrawSample

Definition at line 389 of file CParticleFilterCapable.cpp.

References mrpt::bayes::CParticleFilter::TParticleFilterOptions::adaptiveSampleSize, mrpt::random::CRandomGenerator::drawUniform(), mrpt::random::getRandomGenerator(), MRPT_END, MRPT_END_WITH_CLEAN_UP, MRPT_START, mrpt::bayes::CParticleFilter::TParticleFilterOptions::resamplingMethod, and THROW_EXCEPTION.

Here is the call graph for this function:

◆ getAs3DObject() [1/2]

template<class OPENGL_SETOFOBJECTSPTR >
void mrpt::poses::CPose3DPDF::getAs3DObject ( OPENGL_SETOFOBJECTSPTR &  out_obj) const
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)

Note
Needs the mrpt-opengl library, and using mrpt::opengl::CSetOfObjects::Ptr as template argument.
By default, ellipsoids for the confidence intervals of "q=3" are drawn; for more mathematical details, see CGeneralizedEllipsoidTemplate::setQuantiles()
See also
mrpt::opengl::CSetOfObjects::posePDF2opengl() for details on pose-to-opengl conversion

Definition at line 119 of file CPose3DPDF.h.

References mrpt::opengl::posePDF2opengl().

Here is the call graph for this function:

◆ getAs3DObject() [2/2]

template<class OPENGL_SETOFOBJECTSPTR >
OPENGL_SETOFOBJECTSPTR mrpt::poses::CPose3DPDF::getAs3DObject ( ) const
inlineinherited

Returns a 3D representation of this PDF.

Note
Needs the mrpt-opengl library, and using mrpt::opengl::CSetOfObjects::Ptr as template argument.

Definition at line 130 of file CPose3DPDF.h.

References mrpt::opengl::posePDF2opengl().

Here is the call graph for this function:

◆ getCovariance() [1/3]

void mrpt::utils::CProbabilityDensityFunction< CPose3D , STATE_LEN >::getCovariance ( mrpt::math::CMatrixDouble cov) const
inlineinherited

Returns the estimate of the covariance matrix (STATE_LEN x STATE_LEN covariance matrix)

See also
getMean, getCovarianceAndMean, getInformationMatrix

Definition at line 81 of file CProbabilityDensityFunction.h.

◆ getCovariance() [2/3]

void mrpt::utils::CProbabilityDensityFunction< CPose3D , STATE_LEN >::getCovariance ( mrpt::math::CMatrixFixedNumeric< double, STATE_LEN, STATE_LEN > &  cov) const
inlineinherited

Returns the estimate of the covariance matrix (STATE_LEN x STATE_LEN covariance matrix)

See also
getMean, getCovarianceAndMean, getInformationMatrix

Definition at line 91 of file CProbabilityDensityFunction.h.

◆ getCovariance() [3/3]

mrpt::math::CMatrixFixedNumeric<double, STATE_LEN, STATE_LEN> mrpt::utils::CProbabilityDensityFunction< CPose3D , STATE_LEN >::getCovariance ( ) const
inlineinherited

Returns the estimate of the covariance matrix (STATE_LEN x STATE_LEN covariance matrix)

See also
getMean, getInformationMatrix

Definition at line 104 of file CProbabilityDensityFunction.h.

◆ getCovarianceAndMean() [1/2]

virtual void mrpt::utils::CProbabilityDensityFunction< CPose3D , STATE_LEN >::getCovarianceAndMean ( mrpt::math::CMatrixFixedNumeric< double, STATE_LEN, STATE_LEN > &  cov,
CPose3D &  mean_point 
) const
pure virtualinherited

Returns an estimate of the pose covariance matrix (STATE_LENxSTATE_LEN cov matrix) and the mean, both at once.

See also
getMean, getInformationMatrix

◆ getCovarianceAndMean() [2/2]

void CPose3DPDFParticles::getCovarianceAndMean ( mrpt::math::CMatrixDouble66 cov,
CPose3D mean_point 
) const
override

Returns an estimate of the pose covariance matrix (6x6 cov matrix) and the mean, both at once.

See also
getMean

Definition at line 100 of file CPose3DPDFParticles.cpp.

References ASSERT_, mrpt::math::cov(), M_2PI, mean(), MRPT_END, MRPT_START, mrpt::math::square(), and mrpt::math::wrapToPi().

Referenced by mrpt::slam::CMetricMapBuilderRBPF::processActionObservation().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getCovarianceDynAndMean()

void mrpt::utils::CProbabilityDensityFunction< CPose3D , STATE_LEN >::getCovarianceDynAndMean ( mrpt::math::CMatrixDouble cov,
CPose3D &  mean_point 
) const
inlineinherited

Returns an estimate of the pose covariance matrix (STATE_LENxSTATE_LEN cov matrix) and the mean, both at once.

See also
getMean, getInformationMatrix

Definition at line 57 of file CProbabilityDensityFunction.h.

◆ getCovarianceEntropy()

double mrpt::utils::CProbabilityDensityFunction< CPose3D , STATE_LEN >::getCovarianceEntropy ( ) const
inlineinherited

Compute the entropy of the estimated covariance matrix.

See also
http://en.wikipedia.org/wiki/Multivariate_normal_distribution#Entropy

Definition at line 178 of file CProbabilityDensityFunction.h.

◆ getInformationMatrix()

virtual void mrpt::utils::CProbabilityDensityFunction< CPose3D , STATE_LEN >::getInformationMatrix ( mrpt::math::CMatrixFixedNumeric< double, STATE_LEN, STATE_LEN > &  inf) const
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.

See also
getMean, getCovarianceAndMean

Definition at line 127 of file CProbabilityDensityFunction.h.

◆ getMean() [1/2]

virtual void mrpt::utils::CProbabilityDensityFunction< CPose3D , STATE_LEN >::getMean ( CPose3D &  mean_point) const
pure virtualinherited

Returns the mean, or mathematical expectation of the probability density distribution (PDF).

See also
getCovarianceAndMean, getInformationMatrix

◆ getMean() [2/2]

void CPose3DPDFParticles::getMean ( CPose3D mean_pose) const
override

Returns an estimate of the pose, (the mean, or mathematical expectation of the PDF), computed as a weighted average over all m_particles.

See also
getCovariance

Definition at line 75 of file CPose3DPDFParticles.cpp.

References mrpt::poses::SE_average< 3 >::append(), mrpt::poses::SE_average< 3 >::get_average(), MRPT_END, and MRPT_START.

Referenced by mrpt::hmtslam::CHierarchicalMapMHPartition::dumpAsText(), mrpt::poses::CPoseInterpolatorBase< 3 >::filter(), mrpt::hmtslam::CHMTSLAM::perform_TLC(), and mrpt::slam::CMetricMapBuilderRBPF::processActionObservation().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getMeanVal()

CPose3D mrpt::utils::CProbabilityDensityFunction< CPose3D , STATE_LEN >::getMeanVal ( ) const
inlineinherited

Returns the mean, or mathematical expectation of the probability density distribution (PDF).

See also
getCovariance, getInformationMatrix

Definition at line 70 of file CProbabilityDensityFunction.h.

◆ getMostLikelyParticle()

CPose3D CPose3DPDFParticles::getMostLikelyParticle ( ) const

Returns the particle with the highest weight.

Definition at line 348 of file CPose3DPDFParticles.cpp.

◆ getParticlePose()

CPose3D CPose3DPDFParticles::getParticlePose ( int  i) const

Returns the pose of the i'th particle.

Definition at line 270 of file CPose3DPDFParticles.cpp.

◆ GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId* mrpt::poses::CPose3DPDFParticles::GetRuntimeClass ( ) const
overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::poses::CPose3DPDF.

◆ GetRuntimeClassIdStatic()

static const mrpt::utils::TRuntimeClassId& mrpt::poses::CPose3DPDFParticles::GetRuntimeClassIdStatic ( )
static

◆ getW()

double mrpt::bayes::CParticleFilterDataImpl< CPose3DPDFParticles , mrpt::bayes::CParticleFilterData< CPose3D >::CParticleList >::getW ( size_t  i) const
inlineoverridevirtualinherited

Access to i'th particle (logarithm) weight, where first one is index 0.

Implements mrpt::bayes::CParticleFilterCapable.

Definition at line 41 of file CParticleFilterData.h.

◆ getWeights()

void mrpt::bayes::CParticleFilterData< CPose3D >::getWeights ( std::vector< double > &  out_logWeights) const
inlineinherited

Returns a vector with the sequence of the logaritmic weights of all the samples.

Definition at line 256 of file CParticleFilterData.h.

◆ inverse()

void CPose3DPDFParticles::inverse ( CPose3DPDF o) const
overridevirtual

Returns a new PDF such as: NEW_PDF = (0,0,0) - THIS_PDF.

Implements mrpt::poses::CPose3DPDF.

Definition at line 327 of file CPose3DPDFParticles.cpp.

References ASSERT_, CLASS_ID, copyFrom(), mrpt::poses::CPose3DPDF::GetRuntimeClass(), MRPT_END, and MRPT_START.

Referenced by mrpt::hmtslam::CLocalMetricHypothesis::updateAreaFromLMH().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ is_3D()

static bool mrpt::poses::CPose3DPDF::is_3D ( )
inlinestaticinherited

Definition at line 102 of file CPose3DPDF.h.

References mrpt::poses::CPose3DPDF::is_3D_val.

◆ is_PDF()

static bool mrpt::poses::CPose3DPDF::is_PDF ( )
inlinestaticinherited

Definition at line 107 of file CPose3DPDF.h.

References mrpt::poses::CPose3DPDF::is_PDF_val.

◆ isInfType()

virtual bool mrpt::utils::CProbabilityDensityFunction< CPose3D , STATE_LEN >::isInfType ( ) const
inlinevirtualinherited

Returns whether the class instance holds the uncertainty in covariance or information form.

Note
By default this is going to be covariance form. *Inf classes (e.g. CPosePDFGaussianInf) store it in information form.
See also
mrpt::traits::is_inf_type

Reimplemented in mrpt::poses::CPose3DPDFGaussianInf.

Definition at line 120 of file CProbabilityDensityFunction.h.

◆ jacobiansPoseComposition()

void CPose3DPDF::jacobiansPoseComposition ( const CPose3D x,
const CPose3D u,
mrpt::math::CMatrixDouble66 df_dx,
mrpt::math::CMatrixDouble66 df_du 
)
staticinherited

◆ log2linearWeights()

void CParticleFilterCapable::log2linearWeights ( const std::vector< double > &  in_logWeights,
std::vector< double > &  out_linWeights 
)
staticinherited

A static method to compute the linear, normalized (the sum the unity) weights from log-weights.

See also
performResampling

Definition at line 455 of file CParticleFilterCapable.cpp.

References ASSERT_, MRPT_END, and MRPT_START.

◆ normalizeWeights()

double mrpt::bayes::CParticleFilterDataImpl< CPose3DPDFParticles , mrpt::bayes::CParticleFilterData< CPose3D >::CParticleList >::normalizeWeights ( double *  out_max_log_w = nullptr)
inlineoverridevirtualinherited

Normalize the (logarithmic) weights, such as the maximum weight is zero.

Parameters
out_max_log_wIf provided, will return with the maximum log_w before normalizing, such as new_weights = old_weights - max_log_w.
Returns
The max/min ratio of weights ("dynamic range")

Implements mrpt::bayes::CParticleFilterCapable.

Definition at line 60 of file CParticleFilterData.h.

◆ operator delete() [1/3]

void mrpt::poses::CPose3DPDFParticles::operator delete ( void ptr)
inlinenoexcept

Definition at line 38 of file CPose3DPDFParticles.h.

◆ operator delete() [2/3]

void mrpt::poses::CPose3DPDFParticles::operator delete ( void memory,
void ptr 
)
inlinenoexcept

Definition at line 38 of file CPose3DPDFParticles.h.

◆ operator delete() [3/3]

void mrpt::poses::CPose3DPDFParticles::operator delete ( void ptr,
const std::nothrow_t &   
)
inlinenoexcept

Definition at line 38 of file CPose3DPDFParticles.h.

◆ operator delete[]()

void mrpt::poses::CPose3DPDFParticles::operator delete[] ( void ptr)
inlinenoexcept

Definition at line 38 of file CPose3DPDFParticles.h.

◆ operator new() [1/3]

static void* mrpt::poses::CPose3DPDFParticles::operator new ( size_t  size,
void ptr 
)
inlinestatic

Definition at line 38 of file CPose3DPDFParticles.h.

◆ operator new() [2/3]

void* mrpt::poses::CPose3DPDFParticles::operator new ( size_t  size)
inline

Definition at line 38 of file CPose3DPDFParticles.h.

◆ operator new() [3/3]

void* mrpt::poses::CPose3DPDFParticles::operator new ( size_t  size,
const std::nothrow_t &   
)
inlinenoexcept

Definition at line 38 of file CPose3DPDFParticles.h.

◆ operator new[]()

void* mrpt::poses::CPose3DPDFParticles::operator new[] ( size_t  size)
inline

Definition at line 38 of file CPose3DPDFParticles.h.

◆ operator+=()

void CPose3DPDFParticles::operator+= ( const CPose3D Ap)

Appends (pose-composition) a given pose "p" to each particle.

Definition at line 309 of file CPose3DPDFParticles.cpp.

References MRPT_UNUSED_PARAM, and THROW_EXCEPTION.

◆ particlesCount()

size_t mrpt::bayes::CParticleFilterDataImpl< CPose3DPDFParticles , mrpt::bayes::CParticleFilterData< CPose3D >::CParticleList >::particlesCount ( ) const
inlineoverridevirtualinherited

Get the m_particles count.

Implements mrpt::bayes::CParticleFilterCapable.

Definition at line 55 of file CParticleFilterData.h.

◆ performResampling()

void CParticleFilterCapable::performResampling ( const bayes::CParticleFilter::TParticleFilterOptions PF_options,
size_t  out_particle_count = 0 
)
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"

Parameters
[in]out_particle_countThe desired number of output particles after resampling; 0 means don't modify the current number.
See also
resample

Definition at line 29 of file CParticleFilterCapable.cpp.

References ASSERT_, MRPT_END, MRPT_START, and mrpt::bayes::CParticleFilter::TParticleFilterOptions::resamplingMethod.

◆ performSubstitution()

void mrpt::bayes::CParticleFilterDataImpl< CPose3DPDFParticles , mrpt::bayes::CParticleFilterData< CPose3D >::CParticleList >::performSubstitution ( const std::vector< size_t > &  indx)
inlineoverridevirtualinherited

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 114 of file CParticleFilterData.h.

◆ prepareFastDrawSample() [1/2]

void mrpt::bayes::CParticleFilterCapable::prepareFastDrawSample ( const bayes::CParticleFilter::TParticleFilterOptions PF_options) const
inlineinherited

The default evaluator function, which simply returns the particle weight.

The action and the observation are declared as "void*" for a greater flexibility.

See also
prepareFastDrawSample

Definition at line 68 of file CParticleFilterCapable.h.

References mrpt::bayes::CParticleFilterCapable::getW().

Here is the call graph for this function:

◆ prepareFastDrawSample() [2/2]

void CParticleFilterCapable::prepareFastDrawSample ( const bayes::CParticleFilter::TParticleFilterOptions PF_options,
TParticleProbabilityEvaluator  partEvaluator 
) const
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):

  • DYNAMIC SAMPLE SIZE=NO: In this case this method fills out an internal array (m_fastDrawAuxiliary.alreadyDrawnIndexes) with the random indexes generated according to the selected resample scheme in TParticleFilterOptions. Those indexes are read sequentially by subsequent calls to fastDrawSample.
  • DYNAMIC SAMPLE SIZE=YES: Then:
    • If TParticleFilterOptions.resamplingMethod = prMultinomial, the internal buffers will be filled out (m_fastDrawAuxiliary.CDF, CDF_indexes & PDF) and then fastDrawSample can be called an arbitrary number of times to generate random indexes.
    • For the rest of resampling algorithms, an exception will be raised since they are not appropriate for a dynamic (unknown in advance) number of particles.

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.

See also
fastDrawSample

Definition at line 276 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.

Here is the call graph for this function:

◆ readFromStream()

void CPose3DPDFParticles::readFromStream ( mrpt::utils::CStream in,
int  version 
)
overrideprotectedvirtual

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.

Parameters
inThe input binary stream where the object data must read from.
versionThe version of the object stored in the stream: use this version number in your code to know how to read the incoming data.
Exceptions
std::exceptionOn any error, see CStream::ReadBuffer
See also
CStream

Implements mrpt::utils::CSerializable.

Definition at line 231 of file CPose3DPDFParticles.cpp.

References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION.

◆ readParticlesFromStream()

void mrpt::bayes::CParticleFilterData< CPose3D >::readParticlesFromStream ( STREAM &  in)
inlineinherited

Reads the sequence of particles and their weights from a stream (requires T implementing CSerializable).

See also
writeParticlesToStream

Definition at line 236 of file CParticleFilterData.h.

◆ resetDeterministic()

void CPose3DPDFParticles::resetDeterministic ( const CPose3D location,
size_t  particlesCount = 0 
)

Reset the PDF to a single point: All m_particles will be set exactly to the supplied pose.

Parameters
locationThe location to set all the m_particles.
particlesCountIf this is set to 0 the number of m_particles remains unchanged.
See also
resetUniform, resetUniformFreeSpace

Definition at line 381 of file CPose3DPDFParticles.cpp.

Referenced by mrpt::hmtslam::CHierarchicalMapMHPartition::computeCoordinatesTransformationBetweenNodes(), mrpt::obs::CActionRobotMovement3D::computeFromOdometry_model6DOF(), mrpt::hmtslam::CLocalMetricHypothesis::getPoseParticles(), and mrpt::hmtslam::CLocalMetricHypothesis::getRelativePose().

Here is the caller graph for this function:

◆ saveToTextFile()

void CPose3DPDFParticles::saveToTextFile ( const std::string file) const
overridevirtual

Save PDF's m_particles to a text file.

In each line it will go: "x y z"

Implements mrpt::utils::CProbabilityDensityFunction< CPose3D, 6 >.

Definition at line 250 of file CPose3DPDFParticles.cpp.

References mrpt::system::os::fclose(), mrpt::system::os::fopen(), and mrpt::system::os::fprintf().

Here is the call graph for this function:

◆ setW()

void mrpt::bayes::CParticleFilterDataImpl< CPose3DPDFParticles , mrpt::bayes::CParticleFilterData< CPose3D >::CParticleList >::setW ( size_t  i,
double  w 
)
inlineoverridevirtualinherited

Modifies i'th particle (logarithm) weight, where first one is index 0.

Implements mrpt::bayes::CParticleFilterCapable.

Definition at line 48 of file CParticleFilterData.h.

◆ size()

size_t mrpt::poses::CPose3DPDFParticles::size ( ) const
inline

Get the m_particles count (equivalent to "particlesCount")

Definition at line 75 of file CPose3DPDFParticles.h.

References mrpt::bayes::CParticleFilterData< CPose3D >::m_particles.

Referenced by mrpt::hmtslam::CHMTSLAM::perform_TLC(), and mrpt::hmtslam::CLocalMetricHypothesis::updateAreaFromLMH().

Here is the caller graph for this function:

◆ writeParticlesToStream()

void mrpt::bayes::CParticleFilterData< CPose3D >::writeParticlesToStream ( STREAM &  out) const
inlineinherited

Dumps the sequence of particles and their weights to a stream (requires T implementing CSerializable).

See also
readParticlesFromStream

Definition at line 220 of file CParticleFilterData.h.

◆ writeToMatlab()

virtual mxArray* mrpt::utils::CSerializable::writeToMatlab ( ) const
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.

Returns
A new mxArray (caller is responsible of memory freeing) or nullptr is class does not support conversion to MATLAB.

Definition at line 89 of file CSerializable.h.

◆ writeToStream()

void CPose3DPDFParticles::writeToStream ( mrpt::utils::CStream out,
int *  getVersion 
) const
overrideprotectedvirtual

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.

Parameters
outThe output binary stream where object must be dumped.
getVersionIf nullptr, 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.
Exceptions
std::exceptionOn any error, see CStream::WriteBuffer
See also
CStream

Implements mrpt::utils::CSerializable.

Definition at line 217 of file CPose3DPDFParticles.cpp.

Member Data Documentation

◆ _init_CPose3DPDFParticles

mrpt::utils::CLASSINIT mrpt::poses::CPose3DPDFParticles::_init_CPose3DPDFParticles
staticprotected

Definition at line 38 of file CPose3DPDFParticles.h.

◆ className

constexpr const char* mrpt::poses::CPose3DPDFParticles::className = "CPose3DPDFParticles"
static

Definition at line 38 of file CPose3DPDFParticles.h.

◆ m_fastDrawAuxiliary

TFastDrawAuxVars mrpt::bayes::CParticleFilterCapable::m_fastDrawAuxiliary
mutableprotectedinherited

Auxiliary vectors, see CParticleFilterCapable::prepareFastDrawSample for more information.

Definition at line 237 of file CParticleFilterCapable.h.

◆ m_particles

The array of particles.

Definition at line 208 of file CParticleFilterData.h.

Referenced by size().

◆ runtimeClassId

const mrpt::utils::TRuntimeClassId mrpt::poses::CPose3DPDFParticles::runtimeClassId
staticprotected

Definition at line 38 of file CPose3DPDFParticles.h.

◆ state_length

const size_t mrpt::utils::CProbabilityDensityFunction< CPose3D , STATE_LEN >::state_length
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 34 of file CProbabilityDensityFunction.h.




Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: ae4571287 Thu Nov 23 00:06:53 2017 +0100 at dom oct 27 23:51:55 CET 2019