Declares a class that represents a Probability Density function (PDF) of a 3D(6D) pose .
This class implements that PDF as the following multi-modal Gaussian distribution:
Where the number of modes N is the size of CPose3DPDFSOG::m_modes. Angles are always in radians.
See mrpt::poses::CPose3DPDF for more details.
Definition at line 34 of file CPose3DPDFSOG.h.
#include <mrpt/poses/CPose3DPDFSOG.h>
Classes | |
struct | TGaussianMode |
The struct for each mode: More... | |
Public Types | |
typedef mrpt::aligned_containers< TGaussianMode >::vector_t | TModesList |
typedef TModesList::const_iterator | const_iterator |
typedef TModesList::iterator | iterator |
enum | { is_3D_val = 1 } |
enum | { is_PDF_val = 1 } |
typedef CPose3D | type_value |
The type of the state the PDF represents. 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 () |
CPose3DPDFSOG (size_t nModes=1) | |
Default constructor. More... | |
void | clear () |
Clear all the gaussian modes. More... | |
void | resize (const size_t N) |
Set the number of SOG modes. More... | |
size_t | size () const |
Return the number of Gaussian modes. More... | |
bool | empty () const |
Return whether there is any Gaussian mode. More... | |
iterator | begin () |
iterator | end () |
const_iterator | begin () const |
const_iterator | end () const |
void | getMean (CPose3D &mean_pose) const MRPT_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 MRPT_OVERRIDE |
Returns an estimate of the pose covariance matrix (6x6 cov matrix) and the mean, both at once. More... | |
void | normalizeWeights () |
Normalize the weights in m_modes such as the maximum log-weight is 0. More... | |
void | getMostLikelyMode (CPose3DPDFGaussian &outVal) const |
Return the Gaussian mode with the highest likelihood (or an empty Gaussian if there are no modes in this SOG) More... | |
void | copyFrom (const CPose3DPDF &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 the density to a text file, with the following format: There is one row per Gaussian "mode", and each row contains 10 elements: More... | |
void | changeCoordinatesReference (const CPose3D &newReferenceBase) MRPT_OVERRIDE |
this = p (+) this. More... | |
void | bayesianFusion (const CPose3DPDF &p1, const CPose3DPDF &p2) MRPT_OVERRIDE |
Bayesian fusion of two pose distributions, then save the result in this object (WARNING: Currently p1 must be a mrpt::poses::CPose3DPDFSOG object and p2 a mrpt::poses::CPose3DPDFSOG object) More... | |
void | drawSingleSample (CPose3D &outPart) const MRPT_OVERRIDE |
Draws a single sample from the distribution. More... | |
void | drawManySamples (size_t N, std::vector< mrpt::math::CVectorDouble > &outSamples) const MRPT_OVERRIDE |
Draws a number of samples from the distribution, and saves as a list of 1x6 vectors, where each row contains a (x,y,z,yaw,pitch,roll) datum. More... | |
void | inverse (CPose3DPDF &o) const MRPT_OVERRIDE |
Returns a new PDF such as: NEW_PDF = (0,0,0) - THIS_PDF. More... | |
void | appendFrom (const CPose3DPDFSOG &o) |
Append the Gaussian modes from "o" to the current set of modes of "this" density. 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 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... | |
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... | |
CObject * | clone () const |
Cloning interface for smart pointers. 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 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... | |
Static Public Member Functions | |
static void * | operator new (size_t size, void *ptr) |
static CPose3DPDF * | createFrom2D (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 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 | classCPose3DPDF |
RTTI stuff | |
static const mrpt::utils::TRuntimeClassId | classCSerializable |
Protected Member Functions | |
void | assureSymmetry () |
Assures the symmetry of the covariance matrix (eventually certain operations in the math-coprocessor lead to non-symmetric matrixes!) 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 | |
TModesList | m_modes |
Access directly to this array for modify the modes as desired. More... | |
RTTI stuff | |
typedef CPose3DPDFSOGPtr | SmartPtr |
static mrpt::utils::CLASSINIT | _init_CPose3DPDFSOG |
static mrpt::utils::TRuntimeClassId | classCPose3DPDFSOG |
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 CPose3DPDFSOGPtr | Create () |
typedef TModesList::const_iterator mrpt::poses::CPose3DPDFSOG::const_iterator |
Definition at line 57 of file CPose3DPDFSOG.h.
typedef TModesList::iterator mrpt::poses::CPose3DPDFSOG::iterator |
Definition at line 58 of file CPose3DPDFSOG.h.
typedef CPose3DPDFSOGPtr mrpt::poses::CPose3DPDFSOG::SmartPtr |
A typedef for the associated smart pointer
Definition at line 37 of file CPose3DPDFSOG.h.
typedef mrpt::aligned_containers<TGaussianMode>::vector_t mrpt::poses::CPose3DPDFSOG::TModesList |
Definition at line 56 of file CPose3DPDFSOG.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 91 of file CPose3DPDF.h.
|
inherited |
Enumerator | |
---|---|
is_PDF_val |
Definition at line 93 of file CPose3DPDF.h.
mrpt::poses::CPose3DPDFSOG::CPose3DPDFSOG | ( | size_t | nModes = 1 | ) |
Default constructor.
nModes | The initial size of CPose3DPDFSOG::m_modes |
|
staticprotected |
void mrpt::poses::CPose3DPDFSOG::appendFrom | ( | const CPose3DPDFSOG & | o | ) |
Append the Gaussian modes from "o" to the current set of modes of "this" density.
|
protected |
Assures the symmetry of the covariance matrix (eventually certain operations in the math-coprocessor lead to non-symmetric matrixes!)
|
virtual |
Bayesian fusion of two pose distributions, then save the result in this object (WARNING: Currently p1 must be a mrpt::poses::CPose3DPDFSOG object and p2 a mrpt::poses::CPose3DPDFSOG object)
Implements mrpt::poses::CPose3DPDF.
|
inline |
Definition at line 82 of file CPose3DPDFSOG.h.
|
inline |
Definition at line 84 of file CPose3DPDFSOG.h.
|
virtual |
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 >.
void mrpt::poses::CPose3DPDFSOG::clear | ( | ) |
Clear all the gaussian modes.
|
inlineinherited |
|
virtual |
Copy operator, translating if necesary (for example, between particles and gaussian representations)
Implements mrpt::poses::CPose3DPDF.
|
static |
|
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.
|
static |
|
virtual |
Draws a number of samples from the distribution, and saves as a list of 1x6 vectors, where each row contains a (x,y,z,yaw,pitch,roll) datum.
Reimplemented from mrpt::utils::CProbabilityDensityFunction< CPose3D, 6 >.
|
pure virtualinherited |
Draws a single sample from the distribution.
void mrpt::poses::CPose3DPDFSOG::drawSingleSample | ( | CPose3D & | outPart | ) | const |
Draws a single sample from the distribution.
|
virtual |
Returns a copy of the object, indepently of its class.
Implements mrpt::utils::CObject.
|
inlineinherited |
|
inline |
Return whether there is any Gaussian mode.
Definition at line 80 of file CPose3DPDFSOG.h.
|
inline |
Definition at line 83 of file CPose3DPDFSOG.h.
|
inline |
Definition at line 85 of file CPose3DPDFSOG.h.
References mrpt::math::cov(), DEFINE_SERIALIZABLE_POST_CUSTOM_BASE, mrpt::pbmap::inverse(), MRPT_OVERRIDE, and saveToTextFile().
|
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 100 of file CPose3DPDF.h.
References mrpt::opengl::posePDF2opengl().
|
inlineinherited |
Returns a 3D representation of this PDF.
Definition at line 109 of file CPose3DPDF.h.
References DEFINE_SERIALIZABLE_POST_CUSTOM_BASE, and mrpt::opengl::posePDF2opengl().
|
inlineinherited |
Returns the estimate of the covariance matrix (STATE_LEN x STATE_LEN covariance matrix)
Definition at line 67 of file CProbabilityDensityFunction.h.
|
inlineinherited |
Returns the estimate of the covariance matrix (STATE_LEN x STATE_LEN covariance matrix)
Definition at line 76 of file CProbabilityDensityFunction.h.
|
inlineinherited |
Returns the estimate of the covariance matrix (STATE_LEN x STATE_LEN covariance matrix)
Definition at line 85 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 mrpt::poses::CPose3DPDFSOG::getCovarianceAndMean | ( | mrpt::math::CMatrixDouble66 & | cov, |
CPose3D & | mean_point | ||
) | const |
Returns an estimate of the pose covariance matrix (6x6 cov matrix) and the mean, both at once.
|
inlineinherited |
Returns an estimate of the pose covariance matrix (STATE_LENxSTATE_LEN cov matrix) and the mean, both at once.
Definition at line 47 of file CProbabilityDensityFunction.h.
|
inlineinherited |
Compute the entropy of the estimated covariance matrix.
Definition at line 136 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 98 of file CProbabilityDensityFunction.h.
|
pure virtualinherited |
Returns the mean, or mathematical expectation of the probability density distribution (PDF).
void mrpt::poses::CPose3DPDFSOG::getMean | ( | CPose3D & | mean_pose | ) | const |
Returns an estimate of the pose, (the mean, or mathematical expectation of the PDF), computed as a weighted average over all m_particles.
|
inlineinherited |
Returns the mean, or mathematical expectation of the probability density distribution (PDF).
Definition at line 57 of file CProbabilityDensityFunction.h.
void mrpt::poses::CPose3DPDFSOG::getMostLikelyMode | ( | CPose3DPDFGaussian & | outVal | ) | const |
Return the Gaussian mode with the highest likelihood (or an empty Gaussian if there are no modes in this SOG)
|
virtual |
Returns information about the class of an object in runtime.
Reimplemented from mrpt::poses::CPose3DPDF.
|
virtual |
Returns a new PDF such as: NEW_PDF = (0,0,0) - THIS_PDF.
Implements mrpt::poses::CPose3DPDF.
|
inlinestaticinherited |
Definition at line 92 of file CPose3DPDF.h.
|
inlinestaticinherited |
Definition at line 94 of file CPose3DPDF.h.
|
staticinherited |
This static method computes the pose composition Jacobians.
See this techical report: http:///www.mrpt.org/6D_poses:equivalences_compositions_and_uncertainty
Direct equations (for the covariances) in yaw-pitch-roll are too complex. Make a way around them and consider instead this path:
Referenced by mrpt::math::jacobians::jacobs_6D_pose_comp().
void mrpt::poses::CPose3DPDFSOG::normalizeWeights | ( | ) |
Normalize the weights in m_modes such as the maximum log-weight is 0.
|
inline |
Definition at line 37 of file CPose3DPDFSOG.h.
|
inline |
Definition at line 37 of file CPose3DPDFSOG.h.
|
inline |
Definition at line 37 of file CPose3DPDFSOG.h.
|
inline |
Definition at line 37 of file CPose3DPDFSOG.h.
|
inlinestatic |
Definition at line 37 of file CPose3DPDFSOG.h.
|
inline |
Definition at line 37 of file CPose3DPDFSOG.h.
|
inline |
Definition at line 37 of file CPose3DPDFSOG.h.
|
inline |
Definition at line 37 of file CPose3DPDFSOG.h.
|
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.
void mrpt::poses::CPose3DPDFSOG::resize | ( | const size_t | N | ) |
Set the number of SOG modes.
|
virtual |
Save the density to a text file, with the following format: There is one row per Gaussian "mode", and each row contains 10 elements:
Implements mrpt::utils::CProbabilityDensityFunction< CPose3D, 6 >.
|
inline |
Return the number of Gaussian modes.
Definition at line 79 of file CPose3DPDFSOG.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.
References BASE_IMPEXP, DEFINE_MRPT_OBJECT_POST, mrpt::utils::ObjectToOctetVector(), mrpt::utils::ObjectToRawString(), mrpt::utils::ObjectToString(), mrpt::utils::OctetVectorToObject(), mrpt::utils::RawStringToObject(), and mrpt::utils::StringToObject().
|
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.
|
staticprotected |
Definition at line 37 of file CPose3DPDFSOG.h.
|
staticinherited |
|
staticinherited |
Definition at line 42 of file CPose3DPDF.h.
|
static |
Definition at line 37 of file CPose3DPDFSOG.h.
|
staticinherited |
Definition at line 42 of file CSerializable.h.
|
static |
Definition at line 37 of file CPose3DPDFSOG.h.
|
protected |
Access directly to this array for modify the modes as desired.
Note that no weight can be zero!! We must use pointers to satisfy the mem-alignment of the matrixes
Definition at line 69 of file CPose3DPDFSOG.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.
Page generated by Doxygen 1.8.13 for MRPT 1.4.0 SVN: at Wed Mar 15 00:43:31 UTC 2017 |