A class used to store a 2D pose.
A class used to store a 2D pose, including the 2D coordinate point and a heading (phi) angle.
For a complete description of Points/Poses, see mrpt::poses::CPoseOrPoint, or refer to the 2D/3D Geometry tutorial in the wiki.
#include <mrpt/poses/CPose2D.h>

Public Types | |
| enum | { is_3D_val = 0 } |
| enum | { rotation_dimensions = 2 } |
| enum | { is_PDF_val = 0 } |
| typedef CPose2D | type_value |
| Used to emulate CPosePDF types, for example, in mrpt::graphs::CNetworkOfPoses. | |
Public Member Functions | |
| CPose2D () | |
| Default constructor (all coordinates to 0) | |
| CPose2D (const double x, const double y, const double phi) | |
| Constructor from an initial value of the pose. | |
| CPose2D (const CPoint2D &) | |
| Constructor from a CPoint2D object. | |
| CPose2D (const CPose3D &) | |
| Aproximation!! Avoid its use, since information is lost. | |
| CPose2D (const mrpt::math::TPose2D &) | |
| Constructor from lightweight object. | |
| CPose2D (const CPoint3D &) | |
| Constructor from CPoint3D with information loss. | |
| CPose2D (TConstructorFlags_Poses constructor_dummy_param) | |
| Fast constructor that leaves all the data uninitialized - call with UNINITIALIZED_POSE as argument. | |
| const double & | phi () const |
| Get the phi angle of the 2D pose (in radians) | |
| double & | phi () |
| void | phi (double angle) |
| Set the phi angle of the 2D pose (in radians) | |
| void | phi_incr (const double Aphi) |
| Increment the PHI angle (without checking the 2 PI range, call normalizePhi is needed) | |
| void | getAsVector (vector_double &v) const |
| Returns a 1x3 vector with [x y phi]. | |
| void | getAsVector (mrpt::math::CArrayDouble< 3 > &v) const |
| void | getHomogeneousMatrix (CMatrixDouble44 &out_HM) const |
| Returns the corresponding 4x4 homogeneous transformation matrix for the point(translation) or pose (translation+orientation). | |
| CPose2D | operator+ (const CPose2D &D) const |
The operator is the pose compounding operator. | |
| void | composeFrom (const CPose2D &A, const CPose2D &B) |
Makes . | |
| CPose3D | operator+ (const CPose3D &D) const |
The operator is the pose compounding operator. | |
| CPoint2D | operator+ (const CPoint2D &u) const |
The operator is the pose/point compounding operator. | |
| void | composePoint (double lx, double ly, double &gx, double &gy) const |
An alternative, slightly more efficient way of doing with G and L being 2D points and P this 2D pose. | |
| CPoint3D | operator+ (const CPoint3D &u) const |
The operator is the pose/point compounding operator. | |
| void | inverseComposeFrom (const CPose2D &A, const CPose2D &B) |
Makes this method is slightly more efficient than "this= A - B;" since it avoids the temporary object. | |
| CPose2D | operator- (const CPose2D &b) const |
Compute . | |
| void | AddComponents (CPose2D &p) |
| Scalar sum of components: This is diferent from poses composition, which is implemented as "+" operators in "CPose" derived classes. | |
| void | operator*= (const double s) |
| Scalar multiplication. | |
| CPose2D & | operator+= (const CPose2D &b) |
Make . | |
| void | normalizePhi () |
| Forces "phi" to be in the range [-pi,pi];. | |
| void | asString (std::string &s) const |
| Returns a human-readable textual representation of the object (eg: "[x y yaw]", yaw in degrees) | |
| std::string | asString () const |
| void | fromString (const std::string &s) |
| Set the current object value from a string generated by 'asString' (eg: "[0.02 1.04 -0.8]" ) | |
| const double & | operator[] (unsigned int i) const |
| double & | operator[] (unsigned int i) |
| void | changeCoordinatesReference (const CPose2D &p) |
| makes: this = p (+) this | |
| const type_value & | getPoseMean () const |
| type_value & | getPoseMean () |
| CPose3D | operator- (const CPose3D &b) const |
The operator is the pose inverse compounding operator. | |
| 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). | |
| CObject * | clone () const |
| Cloning interface for smart pointers. | |
Static Public Member Functions | |
| static bool | is_3D () |
| static bool | is_PDF () |
Public Attributes | |
| mrpt::math::CArrayDouble< 2 > | m_coords |
| [x,y] | |
Static Public Attributes | |
| static const mrpt::utils::TRuntimeClassId | classCObject |
Protected Member Functions | |
| virtual void | writeToStream (mrpt::utils::CStream &out, int *getVersion) const =0 |
| Introduces a pure virtual method responsible for writing to a CStream. | |
| virtual void | readFromStream (mrpt::utils::CStream &in, int version)=0 |
| 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. | |
Protected Attributes | |
| double | m_phi |
| The orientation of the pose, in radians. | |
RTTI stuff | |
| typedef CPose2DPtr | SmartPtr |
| static mrpt::utils::CLASSINIT | _init_CPose2D |
| static mrpt::utils::TRuntimeClassId | classCPose2D |
| 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. | |
| virtual mrpt::utils::CObject * | duplicate () const |
| Returns a copy of the object, indepently of its class. | |
| static mrpt::utils::CObject * | CreateObject () |
| static CPose2DPtr | Create () |
STL-like methods and typedefs | |
| enum | { static_size = 3 } |
| typedef double | value_type |
| The type of the elements. | |
| typedef double & | reference |
| typedef const double & | const_reference |
| typedef std::size_t | size_type |
| typedef std::ptrdiff_t | difference_type |
| static size_type | size () |
| static bool | empty () |
| static size_type | max_size () |
| static void | resize (const size_t n) |
| double | x () const |
| Common members of all points & poses classes. | |
| double & | x () |
| void | x (const double v) |
| double | y () const |
| double & | y () |
| void | y (const double v) |
| void | x_incr (const double v) |
| void | y_incr (const double v) |
| double | sqrDistanceTo (const CPoseOrPoint< OTHERCLASS > &b) const |
| Returns the squared euclidean distance to another pose/point: | |
| double | distanceTo (const CPoseOrPoint< OTHERCLASS > &b) const |
| Returns the Euclidean distance to another pose/point: | |
| double | distanceTo (const mrpt::math::TPoint3D &b) const |
| Returns the euclidean distance to a 3D point: | |
| double | distance2DToSquare (double ax, double ay) const |
| Returns the squared 2D distance from this pose/point to a 2D point (ignores Z, if it exists). | |
| double | distance3DToSquare (double ax, double ay, double az) const |
| Returns the squared 3D distance from this pose/point to a 3D point. | |
| double | distance2DTo (double ax, double ay) const |
| Returns the 2D distance from this pose/point to a 2D point (ignores Z, if it exists). | |
| double | distance3DTo (double ax, double ay, double az) const |
| Returns the 3D distance from this pose/point to a 3D point. | |
| double | norm () const |
Returns the euclidean norm of vector: . | |
| vector_double | getAsVectorVal () const |
| Return the pose or point as a 1xN vector with all the components (see derived classes for each implementation) | |
| CMatrixDouble44 | getHomogeneousMatrixVal () const |
| Returns the corresponding 4x4 homogeneous transformation matrix for the point(translation) or pose (translation+orientation). | |
| void | getInverseHomogeneousMatrix (math::CMatrixDouble44 &out_HM) const |
| Returns the corresponding 4x4 inverse homogeneous transformation matrix for this point or pose. | |
| mrpt::math::CMatrixDouble44 | getInverseHomogeneousMatrix () const |
| static bool | is3DPoseOrPoint () |
| Return true for poses or points with a Z component, false otherwise. | |
RTTI stuff | |
| static const mrpt::utils::TRuntimeClassId | classCSerializable |
| class | mrpt::utils::CStream |
| typedef const double& mrpt::poses::CPose2D::const_reference |
| typedef std::ptrdiff_t mrpt::poses::CPose2D::difference_type |
| typedef double& mrpt::poses::CPose2D::reference |
| typedef std::size_t mrpt::poses::CPose2D::size_type |
Used to emulate CPosePDF types, for example, in mrpt::graphs::CNetworkOfPoses.
| typedef double mrpt::poses::CPose2D::value_type |
| mrpt::poses::CPose2D::CPose2D | ( | ) |
Default constructor (all coordinates to 0)
| mrpt::poses::CPose2D::CPose2D | ( | const double | x, |
| const double | y, | ||
| const double | phi | ||
| ) |
Constructor from an initial value of the pose.
| mrpt::poses::CPose2D::CPose2D | ( | const CPose3D & | ) | [explicit] |
Aproximation!! Avoid its use, since information is lost.
| mrpt::poses::CPose2D::CPose2D | ( | const mrpt::math::TPose2D & | ) |
Constructor from lightweight object.
| mrpt::poses::CPose2D::CPose2D | ( | const CPoint3D & | ) | [explicit] |
Constructor from CPoint3D with information loss.
| mrpt::poses::CPose2D::CPose2D | ( | TConstructorFlags_Poses | constructor_dummy_param | ) | [inline] |
| static const mrpt::utils::TRuntimeClassId* mrpt::poses::CPose2D::_GetBaseClass | ( | ) | [static, protected] |
Reimplemented from mrpt::utils::CSerializable.
| void mrpt::poses::CPose2D::AddComponents | ( | CPose2D & | p | ) |
Scalar sum of components: This is diferent from poses composition, which is implemented as "+" operators in "CPose" derived classes.
| void mrpt::poses::CPose2D::asString | ( | std::string & | s | ) | const [inline] |
Returns a human-readable textual representation of the object (eg: "[x y yaw]", yaw in degrees)
Definition at line 168 of file CPose2D.h.
References mrpt::format(), mrpt::utils::RAD2DEG(), and Eigen::internal::y.
| std::string mrpt::poses::CPose2D::asString | ( | ) | const [inline] |
| void mrpt::poses::CPose2D::changeCoordinatesReference | ( | const CPose2D & | p | ) | [inline] |
| CObject* mrpt::utils::CObject::clone | ( | ) | const [inline, inherited] |
Cloning interface for smart pointers.
Reimplemented in mrpt::opengl::CRenderizable, and mrpt::opengl::CRenderizableDisplayList.
Makes
.
| void mrpt::poses::CPose2D::composePoint | ( | double | lx, |
| double | ly, | ||
| double & | gx, | ||
| double & | gy | ||
| ) | const |
An alternative, slightly more efficient way of doing
with G and L being 2D points and P this 2D pose.
| static CPose2DPtr mrpt::poses::CPose2D::Create | ( | ) | [static] |
| static mrpt::utils::CObject* mrpt::poses::CPose2D::CreateObject | ( | ) | [static] |
| double mrpt::poses::CPoseOrPoint< CPose2D >::distance2DTo | ( | double | ax, |
| double | ay | ||
| ) | const [inline, inherited] |
Returns the 2D distance from this pose/point to a 2D point (ignores Z, if it exists).
Definition at line 184 of file CPoseOrPoint.h.
| double mrpt::poses::CPoseOrPoint< CPose2D >::distance2DToSquare | ( | double | ax, |
| double | ay | ||
| ) | const [inline, inherited] |
Returns the squared 2D distance from this pose/point to a 2D point (ignores Z, if it exists).
Definition at line 176 of file CPoseOrPoint.h.
| double mrpt::poses::CPoseOrPoint< CPose2D >::distance3DTo | ( | double | ax, |
| double | ay, | ||
| double | az | ||
| ) | const [inline, inherited] |
Returns the 3D distance from this pose/point to a 3D point.
Definition at line 187 of file CPoseOrPoint.h.
| double mrpt::poses::CPoseOrPoint< CPose2D >::distance3DToSquare | ( | double | ax, |
| double | ay, | ||
| double | az | ||
| ) | const [inline, inherited] |
Returns the squared 3D distance from this pose/point to a 3D point.
Definition at line 179 of file CPoseOrPoint.h.
| double mrpt::poses::CPoseOrPoint< CPose2D >::distanceTo | ( | const CPoseOrPoint< OTHERCLASS > & | b | ) | const [inline, inherited] |
Returns the Euclidean distance to another pose/point:
Definition at line 170 of file CPoseOrPoint.h.
| double mrpt::poses::CPoseOrPoint< CPose2D >::distanceTo | ( | const mrpt::math::TPoint3D & | b | ) | const [inline, inherited] |
Returns the euclidean distance to a 3D point:
Definition at line 190 of file CPoseOrPoint.h.
| virtual mrpt::utils::CObject* mrpt::poses::CPose2D::duplicate | ( | ) | const [virtual] |
Returns a copy of the object, indepently of its class.
Implements mrpt::utils::CObject.
| mrpt::utils::CObjectPtr mrpt::utils::CObject::duplicateGetSmartPtr | ( | ) | const [inline, inherited] |
| static bool mrpt::poses::CPose2D::empty | ( | ) | [inline, static] |
| void mrpt::poses::CPose2D::fromString | ( | const std::string & | s | ) | [inline] |
Set the current object value from a string generated by 'asString' (eg: "[0.02 1.04 -0.8]" )
| std::exception | On invalid format |
Definition at line 175 of file CPose2D.h.
References ASSERTMSG_, mrpt::utils::DEG2RAD(), mrpt::mrpt::math::size(), THROW_EXCEPTION, and Eigen::internal::y.
| void mrpt::poses::CPose2D::getAsVector | ( | vector_double & | v | ) | const |
Returns a 1x3 vector with [x y phi].
| void mrpt::poses::CPose2D::getAsVector | ( | mrpt::math::CArrayDouble< 3 > & | v | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
| vector_double mrpt::poses::CPoseOrPoint< CPose2D >::getAsVectorVal | ( | ) | const [inline, inherited] |
Return the pose or point as a 1xN vector with all the components (see derived classes for each implementation)
Definition at line 199 of file CPoseOrPoint.h.
| void mrpt::poses::CPose2D::getHomogeneousMatrix | ( | CMatrixDouble44 & | out_HM | ) | const |
Returns the corresponding 4x4 homogeneous transformation matrix for the point(translation) or pose (translation+orientation).
| CMatrixDouble44 mrpt::poses::CPoseOrPoint< CPose2D >::getHomogeneousMatrixVal | ( | ) | const [inline, inherited] |
Returns the corresponding 4x4 homogeneous transformation matrix for the point(translation) or pose (translation+orientation).
Definition at line 209 of file CPoseOrPoint.h.
| void mrpt::poses::CPoseOrPoint< CPose2D >::getInverseHomogeneousMatrix | ( | math::CMatrixDouble44 & | out_HM | ) | const [inline, inherited] |
Returns the corresponding 4x4 inverse homogeneous transformation matrix for this point or pose.
Definition at line 219 of file CPoseOrPoint.h.
| mrpt::math::CMatrixDouble44 mrpt::poses::CPoseOrPoint< CPose2D >::getInverseHomogeneousMatrix | ( | ) | const [inline, inherited] |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 226 of file CPoseOrPoint.h.
| const type_value& mrpt::poses::CPose2D::getPoseMean | ( | ) | const [inline] |
| type_value& mrpt::poses::CPose2D::getPoseMean | ( | ) | [inline] |
| virtual const mrpt::utils::TRuntimeClassId* mrpt::poses::CPose2D::GetRuntimeClass | ( | ) | const [virtual] |
Returns information about the class of an object in runtime.
Reimplemented from mrpt::utils::CSerializable.
Makes
this method is slightly more efficient than "this= A - B;" since it avoids the temporary object.
Referenced by operator-().
| static bool mrpt::poses::CPoseOrPoint< CPose2D >::is3DPoseOrPoint | ( | ) | [inline, static, inherited] |
Return true for poses or points with a Z component, false otherwise.
Definition at line 149 of file CPoseOrPoint.h.
| static bool mrpt::poses::CPose2D::is_3D | ( | ) | [inline, static] |
| static bool mrpt::poses::CPose2D::is_PDF | ( | ) | [inline, static] |
| static size_type mrpt::poses::CPose2D::max_size | ( | ) | [inline, static] |
Definition at line 232 of file CPose2D.h.
References static_size.
| double mrpt::poses::CPoseOrPoint< CPose2D >::norm | ( | ) | const [inline, inherited] |
Returns the euclidean norm of vector:
.
Definition at line 193 of file CPoseOrPoint.h.
| void mrpt::poses::CPose2D::normalizePhi | ( | ) |
Forces "phi" to be in the range [-pi,pi];.
| void mrpt::poses::CPose2D::operator*= | ( | const double | s | ) |
Scalar multiplication.
The operator
is the pose/point compounding operator.
The operator
is the pose/point compounding operator.
The operator
is the pose compounding operator.
The operator
is the pose compounding operator.
Compute
.
Definition at line 138 of file CPose2D.h.
References inverseComposeFrom(), and mrpt::poses::UNINITIALIZED_POSE.
| CPose3D mrpt::poses::CPose< CPose2D >::operator- | ( | const CPose3D & | b | ) | const [inherited] |
The operator
is the pose inverse compounding operator.
| double& mrpt::poses::CPose2D::operator[] | ( | unsigned int | i | ) | [inline] |
| const double& mrpt::poses::CPose2D::operator[] | ( | unsigned int | i | ) | const [inline] |
| void mrpt::poses::CPose2D::phi | ( | double | angle | ) | [inline] |
| const double& mrpt::poses::CPose2D::phi | ( | ) | const [inline] |
Get the phi angle of the 2D pose (in radians)
Definition at line 88 of file CPose2D.h.
Referenced by mrpt::graphs::detail::graph_ops< graph_t >::auxEuclid2Dist(), mrpt::poses::SE_traits< 2 >::exp(), mrpt::poses::CRobot2DPoseEstimator::getLatestRobotPose(), mrpt::poses::SE_traits< 2 >::ln(), mrpt::graphs::detail::graph_ops< graph_t >::write_EDGE_line(), and mrpt::graphs::detail::graph_ops< graph_t >::write_VERTEX_line().
| double& mrpt::poses::CPose2D::phi | ( | ) | [inline] |
| void mrpt::poses::CPose2D::phi_incr | ( | const double | Aphi | ) | [inline] |
| virtual void mrpt::utils::CSerializable::readFromStream | ( | mrpt::utils::CStream & | in, |
| int | version | ||
| ) | [protected, pure virtual, inherited] |
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 |
Implemented in mrpt::math::CMatrix, and mrpt::math::CMatrixD.
| static void mrpt::poses::CPose2D::resize | ( | const size_t | n | ) | [inline, static] |
Definition at line 233 of file CPose2D.h.
References mrpt::format(), and static_size.
| static size_type mrpt::poses::CPose2D::size | ( | ) | [inline, static] |
Definition at line 230 of file CPose2D.h.
References static_size.
| double mrpt::poses::CPoseOrPoint< CPose2D >::sqrDistanceTo | ( | const CPoseOrPoint< OTHERCLASS > & | b | ) | const [inline, inherited] |
Returns the squared euclidean distance to another pose/point:
Definition at line 152 of file CPoseOrPoint.h.
| virtual void mrpt::utils::CSerializable::writeToStream | ( | mrpt::utils::CStream & | out, |
| int * | getVersion | ||
| ) | const [protected, pure virtual, inherited] |
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 |
Implemented in mrpt::math::CMatrix, and mrpt::math::CMatrixD.
| void mrpt::poses::CPoseOrPoint< CPose2D >::x | ( | const double | v | ) | [inline, inherited] |
| v | Set X coord. |
Definition at line 141 of file CPoseOrPoint.h.
| double& mrpt::poses::CPoseOrPoint< CPose2D >::x | ( | ) | [inline, inherited] |
Definition at line 138 of file CPoseOrPoint.h.
| double mrpt::poses::CPoseOrPoint< CPose2D >::x | ( | ) | const [inline, inherited] |
Common members of all points & poses classes.
< Get X coord.
Definition at line 135 of file CPoseOrPoint.h.
| void mrpt::poses::CPoseOrPoint< CPose2D >::x_incr | ( | const double | v | ) | [inline, inherited] |
| v | X+=v |
Definition at line 144 of file CPoseOrPoint.h.
| double mrpt::poses::CPoseOrPoint< CPose2D >::y | ( | ) | const [inline, inherited] |
< Get Y coord.
Definition at line 136 of file CPoseOrPoint.h.
| double& mrpt::poses::CPoseOrPoint< CPose2D >::y | ( | ) | [inline, inherited] |
Definition at line 139 of file CPoseOrPoint.h.
| void mrpt::poses::CPoseOrPoint< CPose2D >::y | ( | const double | v | ) | [inline, inherited] |
| v | Set Y coord. |
Definition at line 142 of file CPoseOrPoint.h.
| void mrpt::poses::CPoseOrPoint< CPose2D >::y_incr | ( | const double | v | ) | [inline, inherited] |
| v | Y+=v |
Definition at line 145 of file CPoseOrPoint.h.
friend class mrpt::utils::CStream [friend, inherited] |
Reimplemented in mrpt::poses::CPoint2DPDF, mrpt::poses::CPointPDF, mrpt::poses::CPose3DPDF, mrpt::poses::CPose3DQuatPDF, mrpt::poses::CPosePDF, mrpt::detectors::CDetectableObject, mrpt::slam::CPointsMap, mrpt::slam::CRandomFieldGridMap2D, mrpt::slam::CAction, mrpt::slam::CMetricMap, mrpt::slam::CObservation, mrpt::opengl::CRenderizable, mrpt::opengl::CRenderizableDisplayList, mrpt::opengl::CTexturedObject, and mrpt::reactivenav::CHolonomicLogFileRecord.
Definition at line 56 of file CSerializable.h.
mrpt::utils::CLASSINIT mrpt::poses::CPose2D::_init_CPose2D [static, protected] |
const mrpt::utils::TRuntimeClassId mrpt::utils::CObject::classCObject [static, inherited] |
const mrpt::utils::TRuntimeClassId mrpt::utils::CSerializable::classCSerializable [static, inherited] |
Definition at line 56 of file CSerializable.h.
const mrpt::utils::TRuntimeClassId* mrpt::poses::CPose2D::classinfo [static] |
double mrpt::poses::CPose2D::m_phi [protected] |
| Page generated by Doxygen 1.7.4 for MRPT 0.9.5 SVN:2717 at Sun Oct 16 16:08:03 PDT 2011 | Hosted on: |