CPointPDFGaussian.h

Go to the documentation of this file.

/* +---------------------------------------------------------------------------+
   |                     Mobile Robot Programming Toolkit (MRPT)               |
   |                          http://www.mrpt.org/                             |
   |                                                                           |
   | Copyright (c) 2005-2017, Individual contributors, see AUTHORS file        |
   | See: http://www.mrpt.org/Authors - All rights reserved.                   |
   | Released under BSD License. See details in http://www.mrpt.org/License    |
   +---------------------------------------------------------------------------+ */
#ifndef CPointPDFGaussian_H
#define CPointPDFGaussian_H

#include <mrpt/poses/CPointPDF.h>
#include <mrpt/math/CMatrix.h>

namespace mrpt
{
namespace poses
{
        DEFINE_SERIALIZABLE_PRE_CUSTOM_BASE( CPointPDFGaussian, CPointPDF )

        /** A gaussian distribution for 3D points. Also a method for bayesian fusion is provided.
         *
         * \sa CPointPDF
         * \ingroup poses_pdf_grp
         */
        class BASE_IMPEXP CPointPDFGaussian : public CPointPDF
        {
                // This must be added to any CSerializable derived class:
                DEFINE_SERIALIZABLE( CPointPDFGaussian )

         public:
                /** Default constructor
                  */
                CPointPDFGaussian();

                /** Constructor
                  */
                CPointPDFGaussian( const CPoint3D &init_Mean );

                /** Constructor
                  */
                CPointPDFGaussian( const CPoint3D &init_Mean, const mrpt::math::CMatrixDouble33 &init_Cov );

                CPoint3D                    mean; //!< The mean value
                mrpt::math::CMatrixDouble33 cov; //!< The 3x3 covariance matrix

                void getMean(CPoint3D &p) const MRPT_OVERRIDE; //!< Returns an estimate of the point, (the mean, or mathematical expectation of the PDF)

                /** Returns an estimate of the point covariance matrix (3x3 cov matrix) and the mean, both at once.  \sa getMean */
                void getCovarianceAndMean(mrpt::math::CMatrixDouble33 &cov,CPoint3D &mean_point) const MRPT_OVERRIDE;

                /** Copy operator, translating if necesary (for example, between particles and gaussian representations) */
                void  copyFrom(const CPointPDF &o) MRPT_OVERRIDE;

                /** Save PDF's particles to a text file, containing the 2D pose in the first line, then the covariance matrix in next 3 lines. */
                void  saveToTextFile(const std::string &file) const MRPT_OVERRIDE;

                /** 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. */
                void  changeCoordinatesReference( const CPose3D &newReferenceBase ) MRPT_OVERRIDE;

                /** Bayesian fusion of two points gauss. distributions, then save the result in this object.
                  *  The process is as follows:<br>
                  *             - (x1,S1): Mean and variance of the p1 distribution.
                  *             - (x2,S2): Mean and variance of the p2 distribution.
                  *             - (x,S): Mean and variance of the resulting distribution.
                  *
                  *    S = (S1<sup>-1</sup> + S2<sup>-1</sup>)<sup>-1</sup>;
                  *    x = S * ( S1<sup>-1</sup>*x1 + S2<sup>-1</sup>*x2 );
                  */
                void  bayesianFusion( const CPointPDFGaussian &p1, const CPointPDFGaussian &p2 );

                /** Computes the "correspondence likelihood" of this PDF with another one: This is implemented as the integral from -inf to +inf of the product of both PDF.
                  * The resulting number is >=0.
                  * \sa productIntegralNormalizedWith
                  * \exception std::exception On errors like covariance matrix with null determinant, etc...
                  */
                double  productIntegralWith( const CPointPDFGaussian &p) const;

                /** Computes the "correspondence likelihood" of this PDF with another one: This is implemented as the integral from -inf to +inf of the product of both PDF.
                  * The resulting number is >=0.
                  * NOTE: This version ignores the "z" coordinates!!
                  * \sa productIntegralNormalizedWith
                  * \exception std::exception On errors like covariance matrix with null determinant, etc...
                  */
                double  productIntegralWith2D( const CPointPDFGaussian &p) const;

                /** Computes the "correspondence likelihood" of this PDF with another one: This is implemented as the integral from -inf to +inf of the product of both PDF.
                  * The resulting number is in the range [0,1]
                  *  Note that the resulting value is in fact
                  *  \f[ exp( -\frac{1}{2} D^2 ) \f]
                  *  , with \f$ D^2 \f$ being the square Mahalanobis distance between the two pdfs.
                  * \sa productIntegralWith
                  * \exception std::exception On errors like covariance matrix with null determinant, etc...
                  */
                double  productIntegralNormalizedWith( const CPointPDFGaussian &p) const;

                /** Computes the "correspondence likelihood" of this PDF with another one: This is implemented as the integral from -inf to +inf of the product of both PDF.
                  * The resulting number is in the range [0,1]. This versions ignores the "z" coordinate.
                  *
                  *  Note that the resulting value is in fact
                  *  \f[ exp( -\frac{1}{2} D^2 ) \f]
                  *  , with \f$ D^2 \f$ being the square Mahalanobis distance between the two pdfs.
                  * \sa productIntegralWith
                  * \exception std::exception On errors like covariance matrix with null determinant, etc...
                  */
                double  productIntegralNormalizedWith2D( const CPointPDFGaussian &p) const;

                /** Draw a sample from the pdf */
                void drawSingleSample(CPoint3D  &outSample) const 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!)
                  * \param p1 The first distribution to fuse
                  * \param p2 The second distribution to fuse
                  * \param 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.
                  */
                void  bayesianFusion( const CPointPDF &p1,const  CPointPDF &p2, const double &minMahalanobisDistToDrop = 0) MRPT_OVERRIDE;


                /** Returns the Mahalanobis distance from this PDF to another PDF, that is, it's evaluation at (0,0,0) */
                double mahalanobisDistanceTo( const CPointPDFGaussian & other, bool only_2D = false ) const;


        }; // End of class def.
        DEFINE_SERIALIZABLE_POST_CUSTOM_BASE( CPointPDFGaussian, CPointPDF )


        } // End of namespace
} // End of namespace

#endif