Main MRPT website > C++ reference
MRPT logo
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes
mrpt::poses::CPose3DRotVec Class Reference
2D/3D points and poses

Detailed Description

A 3D pose (a 3D translation + a rotation in 3D).

The 6D transformation in SE(3) stored in this class is kept in two separate containers: a 3-array for the translation, and a 3-array for a rotation vector.

CPose3DRotVec pose;
pose.m_coords[{0:2}]=... // Translation
pose.m_rotvec[{0:2}]=... // Rotation vector

For a complete descriptionan of Points/Poses, see mrpt::poses::CPoseOrPoint, or refer to the 2D/3D Geometry tutorial online.

There are Lie algebra methods: exp and ln (see the methods for documentation).

See Also
CPose3DRotVec, CPoseOrPoint,CPoint3D, mrpt::math::CQuaternion

Definition at line 64 of file CPose3DRotVec.h.

#include <mrpt/poses/CPose3DRotVec.h>

Inheritance diagram for mrpt::poses::CPose3DRotVec:
Inheritance graph
[legend]

Public Types

enum  { is_3D_val = 1 }
 
enum  { rotation_dimensions = 3 }
 
enum  { is_PDF_val = 0 }
 
typedef CPose3DRotVec type_value
 Used to emulate CPosePDF types, for example, in mrpt::graphs::CNetworkOfPoses.
 

Public Member Functions

const type_value & getPoseMean () const
 
type_value & getPoseMean ()
 
CPose3D operator- (const CPose3D &b) const
 The operator $ a \ominus b $ 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.
 
Constructors
 CPose3DRotVec ()
 Default constructor, with all the coordinates set to zero.
 
 CPose3DRotVec (TConstructorFlags_Poses constructor_dummy_param)
 Fast constructor that leaves all the data uninitialized - call with UNINITIALIZED_POSE as argument.
 
 CPose3DRotVec (const double x, const double y, const double z, const double vx, const double vy, const double vz)
 Constructor with initilization of the pose.
 
 CPose3DRotVec (const CArrayDouble< 6 > &v)
 Constructor with initilization of the pose from a vector [x y z rx ry rz].
 
 CPose3DRotVec (const math::CMatrixDouble44 &m)
 Constructor from a 4x4 homogeneous matrix:
 
 CPose3DRotVec (const CPose3D &)
 Constructor from a CPose3D object.
 
 CPose3DRotVec (const mrpt::math::CQuaternionDouble &q, const double x, const double y, const double z)
 Constructor from a quaternion (which only represents the 3D rotation part) and a 3D displacement.
 
 CPose3DRotVec (const double *vec6)
 Constructor from an array with these 6 elements: [x y z vx vy vz] where r{ij} are the entries of the 3x3 rotation matrix and t{x,y,z} are the 3D translation of the pose.
 
Access 3x3 rotation and 4x4 homogeneous matrices
void getHomogeneousMatrix (CMatrixDouble44 &out_HM) const
 Returns the corresponding 4x4 homogeneous transformation matrix for the point(translation) or pose (translation+orientation).
 
CMatrixDouble44 getHomogeneousMatrixVal () const
 
void getRotationMatrix (mrpt::math::CMatrixDouble33 &ROT) const
 Get the 3x3 rotation matrix.
 
const mrpt::math::CMatrixDouble33 getRotationMatrix () const
 
Pose-pose and pose-point compositions and operators
CPose3DRotVec operator+ (const CPose3DRotVec &b) const
 The operator $ a \oplus b $ is the pose compounding operator.
 
CPoint3D operator+ (const CPoint3D &b) const
 The operator $ a \oplus b $ is the pose compounding operator.
 
CPoint3D operator+ (const CPoint2D &b) const
 The operator $ a \oplus b $ is the pose compounding operator.
 
void sphericalCoordinates (const TPoint3D &point, double &out_range, double &out_yaw, double &out_pitch) const
 Computes the spherical coordinates of a 3D point as seen from the 6D pose specified by this object.
 
void composePoint (double lx, double ly, double lz, double &gx, double &gy, double &gz, mrpt::math::CMatrixFixedNumeric< double, 3, 3 > *out_jacobian_df_dpoint=NULL, mrpt::math::CMatrixFixedNumeric< double, 3, 6 > *out_jacobian_df_dpose=NULL) const
 An alternative, slightly more efficient way of doing $ G = P \oplus L $ with G and L being 3D points and P this 6D pose.
 
void composePoint (const TPoint3D local_point, TPoint3D &global_point) const
 An alternative, slightly more efficient way of doing $ G = P \oplus L $ with G and L being 3D points and P this 6D pose.
 
void inverseComposePoint (const double gx, const double gy, const double gz, double &lx, double &ly, double &lz, mrpt::math::CMatrixFixedNumeric< double, 3, 3 > *out_jacobian_df_dpoint=NULL, mrpt::math::CMatrixFixedNumeric< double, 3, 6 > *out_jacobian_df_dpose=NULL) const
 Computes the 3D point L such as $ L = G \ominus this $.
 
void composeFrom (const CPose3DRotVec &A, const CPose3DRotVec &B)
 Makes "this = A (+) B"; this method is slightly more efficient than "this= A + B;" since it avoids the temporary object.
 
CPose3DRotVec & operator+= (const CPose3DRotVec &b)
 Make $ this = this \oplus b $ (b can be "this" without problems)
 
void inverseComposeFrom (const CPose3DRotVec &A, const CPose3DRotVec &B)
 Makes $ this = A \ominus B $ this method is slightly more efficient than "this= A - B;" since it avoids the temporary object.
 
CPose3DRotVec operator- (const CPose3DRotVec &b) const
 Compute $ RET = this \oplus b $.
 
void inverse ()
 Convert this pose into its inverse, saving the result in itself.
 
void changeCoordinatesReference (const CPose3DRotVec &p)
 makes: this = p (+) this
 
Access and modify contents
double rx () const
 
double ry () const
 
double rz () const
 
double & rx ()
 
double & ry ()
 
double & rz ()
 
void addComponents (const CPose3DRotVec &p)
 Scalar sum of all 6 components: This is diferent from poses composition, which is implemented as "+" operators.
 
void operator*= (const double s)
 Scalar multiplication of x,y,z,vx,vy,vz.
 
void setFromValues (const double x0, const double y0, const double z0, const double vx, const double vy, const double vz)
 Set the pose from a 3D position (meters) and yaw/pitch/roll angles (radians) - This method recomputes the internal rotation matrix.
 
template<class ARRAYORVECTOR >
void setFrom6Vector (const ARRAYORVECTOR &vec6)
 Set pose from an array with these 6 elements: [x y z vx vy vz] where v{xyz} is the rotation vector and {xyz} the 3D translation of the pose.
 
template<class ARRAYORVECTOR >
void getAs6Vector (ARRAYORVECTOR &vec6) const
 Gets pose as an array with these 6 elements: [x y z vx vy vz] where v{xyz} is the rotation vector and {xyz} the 3D translation of the pose The target vector MUST ALREADY have space for 6 elements (i.e.
 
template<class ARRAYORVECTOR >
void getAsVector (ARRAYORVECTOR &v) const
 Like getAs6Vector() but for dynamic size vectors (required by base class CPoseOrPoint)
 
const double & operator[] (unsigned int i) const
 
double & operator[] (unsigned int i)
 
void asString (std::string &s) const
 Returns a human-readable textual representation of the object: "[x y z rx ry rz]".
 
std::string asString () const
 
void fromString (const std::string &s)
 Set the current object value from a string generated by 'asString' (eg: "[x y z yaw pitch roll]", angles in deg.
 

Static Public Member Functions

static bool is_3D ()
 
static bool is_PDF ()
 

Public Attributes

CArrayDouble< 3 > m_coords
 The translation vector [x,y,z].
 
CArrayDouble< 3 > m_rotvec
 The rotation vector [vx,vy,vz].
 

Static Public Attributes

static const
mrpt::utils::TRuntimeClassId 		classCObject
 
RTTI stuff
static const
mrpt::utils::TRuntimeClassId 		classCSerializable
 

Protected Member Functions

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

RTTI stuff

typedef CPose3DRotVecPtr SmartPtr
 
static mrpt::utils::CLASSINIT _init_CPose3DRotVec
 
static mrpt::utils::TRuntimeClassId classCPose3DRotVec
 
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 CPose3DRotVecPtr Create ()
 

Lie Algebra methods

void ln (mrpt::math::CArrayDouble< 6 > &out_ln) const
 Take the logarithm of the 3x4 matrix defined by this pose, generating the corresponding vector in the SE(3) Lie Algebra.
 
CArrayDouble< 3 > ln_rotation () const
 Take the logarithm of the 3x3 rotation matrix part of this pose, generating the corresponding vector in the Lie Algebra.
 
static CPose3DRotVec exp (const mrpt::math::CArrayDouble< 6 > &vect)
 Exponentiate a Vector in the SE(3) Lie Algebra to generate a new CPose3DRotVec (static method).
 

STL-like methods and typedefs

enum  { static_size = 6 }
 
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: $ ||\mathbf{x}|| = \sqrt{x^2+y^2+z^2} $.
 
vector_double getAsVectorVal () const
 Return the pose or point as a 1xN vector with all the components (see derived classes for each implementation)
 
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.
 

Member Typedef Documentation

typedef const double& mrpt::poses::CPose3DRotVec::const_reference

Definition at line 368 of file CPose3DRotVec.h.

typedef std::ptrdiff_t mrpt::poses::CPose3DRotVec::difference_type

Definition at line 370 of file CPose3DRotVec.h.

typedef double& mrpt::poses::CPose3DRotVec::reference

Definition at line 367 of file CPose3DRotVec.h.

typedef std::size_t mrpt::poses::CPose3DRotVec::size_type

Definition at line 369 of file CPose3DRotVec.h.

typedef CPose3DRotVecPtr mrpt::poses::CPose3DRotVec::SmartPtr

A typedef for the associated smart pointer

Definition at line 67 of file CPose3DRotVec.h.

typedef CPose3DRotVec mrpt::poses::CPose3DRotVec::type_value

Used to emulate CPosePDF types, for example, in mrpt::graphs::CNetworkOfPoses.

Definition at line 354 of file CPose3DRotVec.h.

typedef double mrpt::poses::CPose3DRotVec::value_type

The type of the elements.

Definition at line 366 of file CPose3DRotVec.h.

Member Enumeration Documentation

anonymous enum
Enumerator
is_3D_val 

Definition at line 355 of file CPose3DRotVec.h.

anonymous enum
Enumerator
rotation_dimensions 

Definition at line 357 of file CPose3DRotVec.h.

anonymous enum
Enumerator
is_PDF_val 

Definition at line 358 of file CPose3DRotVec.h.

anonymous enum
Enumerator
static_size 

Definition at line 374 of file CPose3DRotVec.h.

Constructor & Destructor Documentation

mrpt::poses::CPose3DRotVec::CPose3DRotVec ( )
inline

Default constructor, with all the coordinates set to zero.

Definition at line 77 of file CPose3DRotVec.h.

mrpt::poses::CPose3DRotVec::CPose3DRotVec ( TConstructorFlags_Poses  constructor_dummy_param)
inline

Fast constructor that leaves all the data uninitialized - call with UNINITIALIZED_POSE as argument.

Definition at line 83 of file CPose3DRotVec.h.

mrpt::poses::CPose3DRotVec::CPose3DRotVec ( const double  x,
const double  y,
const double  z,
const double  vx,
const double  vy,
const double  vz 
)
inline

Constructor with initilization of the pose.

Definition at line 86 of file CPose3DRotVec.h.

mrpt::poses::CPose3DRotVec::CPose3DRotVec ( const CArrayDouble< 6 > &  v)
inline

Constructor with initilization of the pose from a vector [x y z rx ry rz].

Definition at line 92 of file CPose3DRotVec.h.

mrpt::poses::CPose3DRotVec::CPose3DRotVec ( const math::CMatrixDouble44 &  m)
explicit

Constructor from a 4x4 homogeneous matrix:

mrpt::poses::CPose3DRotVec::CPose3DRotVec ( const CPose3D &  )
explicit

Constructor from a CPose3D object.

mrpt::poses::CPose3DRotVec::CPose3DRotVec ( const mrpt::math::CQuaternionDouble &  q,
const double  x,
const double  y,
const double  z 
)

Constructor from a quaternion (which only represents the 3D rotation part) and a 3D displacement.

mrpt::poses::CPose3DRotVec::CPose3DRotVec ( const double *  vec6)
inlineexplicit

Constructor from an array with these 6 elements: [x y z vx vy vz] where r{ij} are the entries of the 3x3 rotation matrix and t{x,y,z} are the 3D translation of the pose.

See Also
setFrom12Vector, getAs12Vector

Definition at line 110 of file CPose3DRotVec.h.

Member Function Documentation

static const mrpt::utils::TRuntimeClassId* mrpt::poses::CPose3DRotVec::_GetBaseClass ( )
staticprotected
void mrpt::poses::CPose3DRotVec::addComponents ( const CPose3DRotVec &  p)
inline

Scalar sum of all 6 components: This is diferent from poses composition, which is implemented as "+" operators.

Definition at line 237 of file CPose3DRotVec.h.

References m_coords, and m_rotvec.

void mrpt::poses::CPose3DRotVec::asString ( std::string &  s) const
inline

Returns a human-readable textual representation of the object: "[x y z rx ry rz]".

See Also
fromString

Definition at line 322 of file CPose3DRotVec.h.

References mrpt::mrpt::format().

std::string mrpt::poses::CPose3DRotVec::asString ( ) const
inline

Definition at line 323 of file CPose3DRotVec.h.

References asString().

Referenced by asString().

void mrpt::poses::CPose3DRotVec::changeCoordinatesReference ( const CPose3DRotVec &  p)
inline

makes: this = p (+) this

Definition at line 220 of file CPose3DRotVec.h.

CObject* mrpt::utils::CObject::clone ( ) const
inlineinherited

Cloning interface for smart pointers.

Definition at line 154 of file CObject.h.

void mrpt::poses::CPose3DRotVec::composeFrom ( const CPose3DRotVec &  A,
const CPose3DRotVec &  B 
)

Makes "this = A (+) B"; this method is slightly more efficient than "this= A + B;" since it avoids the temporary object.

Note
A or B can be "this" without problems.

Referenced by operator+().

void mrpt::poses::CPose3DRotVec::composePoint ( double  lx,
double  ly,
double  lz,
double &  gx,
double &  gy,
double &  gz,
mrpt::math::CMatrixFixedNumeric< double, 3, 3 > *  out_jacobian_df_dpoint = NULL,
mrpt::math::CMatrixFixedNumeric< double, 3, 6 > *  out_jacobian_df_dpose = NULL 
) const

An alternative, slightly more efficient way of doing $ G = P \oplus L $ with G and L being 3D points and P this 6D pose.

If pointers are provided, the corresponding Jacobians are returned. See this report for mathematical details.

void mrpt::poses::CPose3DRotVec::composePoint ( const TPoint3D  local_point,
TPoint3D &  global_point 
) const
inline

An alternative, slightly more efficient way of doing $ G = P \oplus L $ with G and L being 3D points and P this 6D pose.

Note
local_point is passed by value to allow global and local point to be the same variable

Definition at line 177 of file CPose3DRotVec.h.

References mrpt::math::TPoint3D::x, mrpt::math::TPoint3D::y, and mrpt::math::TPoint3D::z.

static CPose3DRotVecPtr mrpt::poses::CPose3DRotVec::Create ( )
static
static mrpt::utils::CObject* mrpt::poses::CPose3DRotVec::CreateObject ( )
static
double mrpt::poses::CPoseOrPoint< CPose3DRotVec >::distance2DTo ( double  ax,
double  ay 
) const
inlineinherited

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< CPose3DRotVec >::distance2DToSquare ( double  ax,
double  ay 
) const
inlineinherited

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< CPose3DRotVec >::distance3DTo ( double  ax,
double  ay,
double  az 
) const
inlineinherited

Returns the 3D distance from this pose/point to a 3D point.

Definition at line 187 of file CPoseOrPoint.h.

double mrpt::poses::CPoseOrPoint< CPose3DRotVec >::distance3DToSquare ( double  ax,
double  ay,
double  az 
) const
inlineinherited

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< CPose3DRotVec >::distanceTo ( const CPoseOrPoint< OTHERCLASS > &  b) const
inlineinherited

Returns the Euclidean distance to another pose/point:

Definition at line 170 of file CPoseOrPoint.h.

double mrpt::poses::CPoseOrPoint< CPose3DRotVec >::distanceTo ( const mrpt::math::TPoint3D &  b) const
inlineinherited

Returns the euclidean distance to a 3D point:

Definition at line 190 of file CPoseOrPoint.h.

virtual mrpt::utils::CObject* mrpt::poses::CPose3DRotVec::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
inlineinherited

Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer).

Definition at line 151 of file CObject.h.

static bool mrpt::poses::CPose3DRotVec::empty ( )
inlinestatic

Definition at line 376 of file CPose3DRotVec.h.

static CPose3DRotVec mrpt::poses::CPose3DRotVec::exp ( const mrpt::math::CArrayDouble< 6 > &  vect)
static

Exponentiate a Vector in the SE(3) Lie Algebra to generate a new CPose3DRotVec (static method).

void mrpt::poses::CPose3DRotVec::fromString ( const std::string &  s)
inline

Set the current object value from a string generated by 'asString' (eg: "[x y z yaw pitch roll]", angles in deg.

)

See Also
asString
Exceptions
std::exceptionOn invalid format

Definition at line 329 of file CPose3DRotVec.h.

References ASSERTMSG_, mrpt::mrpt::math::size(), and THROW_EXCEPTION.

template<class ARRAYORVECTOR >
void mrpt::poses::CPose3DRotVec::getAs6Vector ( ARRAYORVECTOR &  vec6) const
inline

Gets pose as an array with these 6 elements: [x y z vx vy vz] where v{xyz} is the rotation vector and {xyz} the 3D translation of the pose The target vector MUST ALREADY have space for 6 elements (i.e.

no .resize() method will be called).

See Also
setAs6Vector, getAsVector

Definition at line 280 of file CPose3DRotVec.h.

template<class ARRAYORVECTOR >
void mrpt::poses::CPose3DRotVec::getAsVector ( ARRAYORVECTOR &  v) const
inline

Like getAs6Vector() but for dynamic size vectors (required by base class CPoseOrPoint)

Definition at line 288 of file CPose3DRotVec.h.

vector_double mrpt::poses::CPoseOrPoint< CPose3DRotVec >::getAsVectorVal ( ) const
inlineinherited

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::CPose3DRotVec::getHomogeneousMatrix ( CMatrixDouble44 &  out_HM) const
inline

Returns the corresponding 4x4 homogeneous transformation matrix for the point(translation) or pose (translation+orientation).

See Also
getInverseHomogeneousMatrix, getRotationMatrix

Definition at line 124 of file CPose3DRotVec.h.

CMatrixDouble44 mrpt::poses::CPose3DRotVec::getHomogeneousMatrixVal ( ) const
inline

Definition at line 132 of file CPose3DRotVec.h.

void mrpt::poses::CPoseOrPoint< CPose3DRotVec >::getInverseHomogeneousMatrix ( math::CMatrixDouble44 &  out_HM) const
inlineinherited

Returns the corresponding 4x4 inverse homogeneous transformation matrix for this point or pose.

See Also
getHomogeneousMatrix

Definition at line 219 of file CPoseOrPoint.h.

mrpt::math::CMatrixDouble44 mrpt::poses::CPoseOrPoint< CPose3DRotVec >::getInverseHomogeneousMatrix ( ) const
inlineinherited

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::CPose3DRotVec::getPoseMean ( ) const
inline

Definition at line 361 of file CPose3DRotVec.h.

type_value& mrpt::poses::CPose3DRotVec::getPoseMean ( )
inline

Definition at line 362 of file CPose3DRotVec.h.

void mrpt::poses::CPose3DRotVec::getRotationMatrix ( mrpt::math::CMatrixDouble33 &  ROT) const

Get the 3x3 rotation matrix.

See Also
getHomogeneousMatrix
const mrpt::math::CMatrixDouble33 mrpt::poses::CPose3DRotVec::getRotationMatrix ( ) const
inline

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 137 of file CPose3DRotVec.h.

References getRotationMatrix(), and mrpt::math::UNINITIALIZED_MATRIX.

Referenced by getRotationMatrix().

virtual const mrpt::utils::TRuntimeClassId* mrpt::poses::CPose3DRotVec::GetRuntimeClass ( ) const
virtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::utils::CSerializable.

void mrpt::poses::CPose3DRotVec::inverse ( )

Convert this pose into its inverse, saving the result in itself.

See Also
operator-
void mrpt::poses::CPose3DRotVec::inverseComposeFrom ( const CPose3DRotVec &  A,
const CPose3DRotVec &  B 
)

Makes $ this = A \ominus B $ this method is slightly more efficient than "this= A - B;" since it avoids the temporary object.

Note
A or B can be "this" without problems.
See Also
composeFrom, composePoint

Referenced by operator-().

void mrpt::poses::CPose3DRotVec::inverseComposePoint ( const double  gx,
const double  gy,
const double  gz,
double &  lx,
double &  ly,
double &  lz,
mrpt::math::CMatrixFixedNumeric< double, 3, 3 > *  out_jacobian_df_dpoint = NULL,
mrpt::math::CMatrixFixedNumeric< double, 3, 6 > *  out_jacobian_df_dpose = NULL 
) const

Computes the 3D point L such as $ L = G \ominus this $.

If pointers are provided, the corresponding Jacobians are returned. See this report for mathematical details.

See Also
composePoint, composeFrom
static bool mrpt::poses::CPoseOrPoint< CPose3DRotVec >::is3DPoseOrPoint ( )
inlinestaticinherited

Return true for poses or points with a Z component, false otherwise.

Definition at line 149 of file CPoseOrPoint.h.

static bool mrpt::poses::CPose3DRotVec::is_3D ( )
inlinestatic

Definition at line 356 of file CPose3DRotVec.h.

static bool mrpt::poses::CPose3DRotVec::is_PDF ( )
inlinestatic

Definition at line 359 of file CPose3DRotVec.h.

void mrpt::poses::CPose3DRotVec::ln ( mrpt::math::CArrayDouble< 6 > &  out_ln) const

Take the logarithm of the 3x4 matrix defined by this pose, generating the corresponding vector in the SE(3) Lie Algebra.

CArrayDouble<3> mrpt::poses::CPose3DRotVec::ln_rotation ( ) const

Take the logarithm of the 3x3 rotation matrix part of this pose, generating the corresponding vector in the Lie Algebra.

static size_type mrpt::poses::CPose3DRotVec::max_size ( )
inlinestatic

Definition at line 377 of file CPose3DRotVec.h.

References static_size.

double mrpt::poses::CPoseOrPoint< CPose3DRotVec >::norm ( ) const
inlineinherited

Returns the euclidean norm of vector: $ ||\mathbf{x}|| = \sqrt{x^2+y^2+z^2} $.

Definition at line 193 of file CPoseOrPoint.h.

void mrpt::poses::CPose3DRotVec::operator*= ( const double  s)
inline

Scalar multiplication of x,y,z,vx,vy,vz.

Definition at line 243 of file CPose3DRotVec.h.

CPose3DRotVec mrpt::poses::CPose3DRotVec::operator+ ( const CPose3DRotVec &  b) const
inline

The operator $ a \oplus b $ is the pose compounding operator.

Definition at line 146 of file CPose3DRotVec.h.

References composeFrom(), and mrpt::poses::UNINITIALIZED_POSE.

CPoint3D mrpt::poses::CPose3DRotVec::operator+ ( const CPoint3D &  b) const

The operator $ a \oplus b $ is the pose compounding operator.

CPoint3D mrpt::poses::CPose3DRotVec::operator+ ( const CPoint2D &  b) const

The operator $ a \oplus b $ is the pose compounding operator.

CPose3DRotVec& mrpt::poses::CPose3DRotVec::operator+= ( const CPose3DRotVec &  b)
inline

Make $ this = this \oplus b $ (b can be "this" without problems)

Definition at line 196 of file CPose3DRotVec.h.

CPose3D mrpt::poses::CPose< CPose3DRotVec >::operator- ( const CPose3D &  b) const
inherited

The operator $ a \ominus b $ is the pose inverse compounding operator.

CPose3DRotVec mrpt::poses::CPose3DRotVec::operator- ( const CPose3DRotVec &  b) const
inline

Compute $ RET = this \oplus b $.

Definition at line 209 of file CPose3DRotVec.h.

References inverseComposeFrom(), and mrpt::poses::UNINITIALIZED_POSE.

const double& mrpt::poses::CPose3DRotVec::operator[] ( unsigned int  i) const
inline

Definition at line 290 of file CPose3DRotVec.h.

double& mrpt::poses::CPose3DRotVec::operator[] ( unsigned int  i)
inline

Definition at line 304 of file CPose3DRotVec.h.

void mrpt::poses::CPose3DRotVec::readFromStream ( mrpt::utils::CStream &  in,
int  version 
)
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.

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.

static void mrpt::poses::CPose3DRotVec::resize ( const size_t  n)
inlinestatic

Definition at line 378 of file CPose3DRotVec.h.

References mrpt::format(), and static_size.

double mrpt::poses::CPose3DRotVec::rx ( ) const
inline

Definition at line 228 of file CPose3DRotVec.h.

double& mrpt::poses::CPose3DRotVec::rx ( )
inline

Definition at line 232 of file CPose3DRotVec.h.

double mrpt::poses::CPose3DRotVec::ry ( ) const
inline

Definition at line 229 of file CPose3DRotVec.h.

double& mrpt::poses::CPose3DRotVec::ry ( )
inline

Definition at line 233 of file CPose3DRotVec.h.

double mrpt::poses::CPose3DRotVec::rz ( ) const
inline

Definition at line 230 of file CPose3DRotVec.h.

double& mrpt::poses::CPose3DRotVec::rz ( )
inline

Definition at line 234 of file CPose3DRotVec.h.

template<class ARRAYORVECTOR >
void mrpt::poses::CPose3DRotVec::setFrom6Vector ( const ARRAYORVECTOR &  vec6)
inline

Set pose from an array with these 6 elements: [x y z vx vy vz] where v{xyz} is the rotation vector and {xyz} the 3D translation of the pose.

See Also
getAs6Vector

Definition at line 268 of file CPose3DRotVec.h.

void mrpt::poses::CPose3DRotVec::setFromValues ( const double  x0,
const double  y0,
const double  z0,
const double  vx,
const double  vy,
const double  vz 
)
inline

Set the pose from a 3D position (meters) and yaw/pitch/roll angles (radians) - This method recomputes the internal rotation matrix.

See Also
getYawPitchRoll, setYawPitchRoll

Definition at line 251 of file CPose3DRotVec.h.

static size_type mrpt::poses::CPose3DRotVec::size ( )
inlinestatic

Definition at line 375 of file CPose3DRotVec.h.

References static_size.

void mrpt::poses::CPose3DRotVec::sphericalCoordinates ( const TPoint3D &  point,
double &  out_range,
double &  out_yaw,
double &  out_pitch 
) const

Computes the spherical coordinates of a 3D point as seen from the 6D pose specified by this object.

For the coordinate system see mrpt::poses::CPose3D

double mrpt::poses::CPoseOrPoint< CPose3DRotVec >::sqrDistanceTo ( const CPoseOrPoint< OTHERCLASS > &  b) const
inlineinherited

Returns the squared euclidean distance to another pose/point:

Definition at line 152 of file CPoseOrPoint.h.

void mrpt::poses::CPose3DRotVec::writeToStream ( mrpt::utils::CStream &  out,
int *  getVersion 
) const
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.

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

Implements mrpt::utils::CSerializable.

double mrpt::poses::CPoseOrPoint< CPose3DRotVec >::x ( ) const
inlineinherited

Common members of all points & poses classes.

< Get X coord.

Definition at line 135 of file CPoseOrPoint.h.

double& mrpt::poses::CPoseOrPoint< CPose3DRotVec >::x ( )
inlineinherited

Definition at line 138 of file CPoseOrPoint.h.

void mrpt::poses::CPoseOrPoint< CPose3DRotVec >::x ( const double  v)
inlineinherited
Parameters
vSet X coord.

Definition at line 141 of file CPoseOrPoint.h.

void mrpt::poses::CPoseOrPoint< CPose3DRotVec >::x_incr ( const double  v)
inlineinherited
Parameters
vX+=v

Definition at line 144 of file CPoseOrPoint.h.

double mrpt::poses::CPoseOrPoint< CPose3DRotVec >::y ( ) const
inlineinherited

< Get Y coord.

Definition at line 136 of file CPoseOrPoint.h.

double& mrpt::poses::CPoseOrPoint< CPose3DRotVec >::y ( )
inlineinherited

Definition at line 139 of file CPoseOrPoint.h.

void mrpt::poses::CPoseOrPoint< CPose3DRotVec >::y ( const double  v)
inlineinherited
Parameters
vSet Y coord.

Definition at line 142 of file CPoseOrPoint.h.

void mrpt::poses::CPoseOrPoint< CPose3DRotVec >::y_incr ( const double  v)
inlineinherited
Parameters
vY+=v

Definition at line 145 of file CPoseOrPoint.h.

Member Data Documentation

mrpt::utils::CLASSINIT mrpt::poses::CPose3DRotVec::_init_CPose3DRotVec
staticprotected

Definition at line 67 of file CPose3DRotVec.h.

const mrpt::utils::TRuntimeClassId mrpt::utils::CObject::classCObject
staticinherited

Definition at line 139 of file CObject.h.

mrpt::utils::TRuntimeClassId mrpt::poses::CPose3DRotVec::classCPose3DRotVec
static

Definition at line 67 of file CPose3DRotVec.h.

const mrpt::utils::TRuntimeClassId mrpt::utils::CSerializable::classCSerializable
staticinherited

Definition at line 56 of file CSerializable.h.

const mrpt::utils::TRuntimeClassId* mrpt::poses::CPose3DRotVec::classinfo
static

Definition at line 67 of file CPose3DRotVec.h.

CArrayDouble<3> mrpt::poses::CPose3DRotVec::m_coords

The translation vector [x,y,z].

Definition at line 70 of file CPose3DRotVec.h.

Referenced by addComponents().

CArrayDouble<3> mrpt::poses::CPose3DRotVec::m_rotvec

The rotation vector [vx,vy,vz].

Definition at line 71 of file CPose3DRotVec.h.

Referenced by addComponents().



Page generated by Doxygen 1.8.3 for MRPT 0.9.6 SVN: at Fri Feb 15 22:05:02 EST 2013