Main MRPT website > C++ reference
MRPT logo
Classes | Typedefs | Functions
Geometry module
The Eigen3 library

Detailed Description

This module provides support for:

 #include <Eigen/Geometry>
Collaboration diagram for Geometry module:

Classes

class  Eigen::Homogeneous
  More...
class  Eigen::Rotation2D
  More...
class  Eigen::Quaternion
  More...
class  Eigen::AngleAxis
  More...
class  Eigen::Transform
  More...
class  Eigen::Translation
  More...
class  Scaling
  More...
class  Eigen::Hyperplane
  More...
class  Eigen::ParametrizedLine
  More...
class  Eigen::AlignedBox
  More...

Typedefs

typedef Rotation2D< float > Eigen::Rotation2Df
 single precision 2D rotation type
typedef Rotation2D< double > Eigen::Rotation2Dd
 double precision 2D rotation type
typedef Quaternion< float > Eigen::Quaternionf
 single precision quaternion type
typedef Quaternion< double > Eigen::Quaterniond
 double precision quaternion type
typedef Map< Quaternion< float >, 0 > Eigen::QuaternionMapf
 Map an unaligned array of single precision scalar as a quaternion.
typedef Map< Quaternion
< double >, 0 > 
Eigen::QuaternionMapd
 Map an unaligned array of double precision scalar as a quaternion.
typedef Map< Quaternion< float >
, Aligned > 
Eigen::QuaternionMapAlignedf
 Map a 16-bits aligned array of double precision scalars as a quaternion.
typedef Map< Quaternion
< double >, Aligned > 
Eigen::QuaternionMapAlignedd
 Map a 16-bits aligned array of double precision scalars as a quaternion.
typedef AngleAxis< float > Eigen::AngleAxisf
 single precision angle-axis type
typedef AngleAxis< double > Eigen::AngleAxisd
 double precision angle-axis type
typedef Transform< float,
2, Isometry > 
Eigen::Isometry2f
typedef Transform< float,
3, Isometry > 
Eigen::Isometry3f
typedef Transform< double,
2, Isometry > 
Eigen::Isometry2d
typedef Transform< double,
3, Isometry > 
Eigen::Isometry3d
typedef Transform< float,
2, Affine > 
Eigen::Affine2f
typedef Transform< float,
3, Affine > 
Eigen::Affine3f
typedef Transform< double,
2, Affine > 
Eigen::Affine2d
typedef Transform< double,
3, Affine > 
Eigen::Affine3d
typedef Transform< float,
2, AffineCompact > 
Eigen::AffineCompact2f
typedef Transform< float,
3, AffineCompact > 
Eigen::AffineCompact3f
typedef Transform< double,
2, AffineCompact > 
Eigen::AffineCompact2d
typedef Transform< double,
3, AffineCompact > 
Eigen::AffineCompact3d
typedef Transform< float,
2, Projective > 
Eigen::Projective2f
typedef Transform< float,
3, Projective > 
Eigen::Projective3f
typedef Transform< double,
2, Projective > 
Eigen::Projective2d
typedef Transform< double,
3, Projective > 
Eigen::Projective3d
typedef Translation< float, 2 > Eigen::Translation2f
typedef Translation< double, 2 > Eigen::Translation2d
typedef Translation< float, 3 > Eigen::Translation3f
typedef Translation< double, 3 > Eigen::Translation3d
typedef DiagonalMatrix< float, 2 > Eigen::AlignedScaling2f
typedef DiagonalMatrix< double, 2 > Eigen::AlignedScaling2d
typedef DiagonalMatrix< float, 3 > Eigen::AlignedScaling3f
typedef DiagonalMatrix< double, 3 > Eigen::AlignedScaling3d

Functions

template<typename Derived , typename OtherDerived >
internal::umeyama_transform_matrix_type
< Derived, OtherDerived >
::type 
Eigen::umeyama (const MatrixBase< Derived > &src, const MatrixBase< OtherDerived > &dst, bool with_scaling=true)
 
Matrix< Scalar, 3, 1 > Eigen::MatrixBase::eulerAngles (Index a0, Index a1, Index a2) const
 

Typedef Documentation

typedef Transform<double,2,Affine> Eigen::Affine2d

Definition at line 634 of file Geometry.

typedef Transform<float,2,Affine> Eigen::Affine2f

Definition at line 630 of file Geometry.

typedef Transform<double,3,Affine> Eigen::Affine3d

Definition at line 636 of file Geometry.

typedef Transform<float,3,Affine> Eigen::Affine3f

Definition at line 632 of file Geometry.

typedef Transform<double,2,AffineCompact> Eigen::AffineCompact2d

Definition at line 643 of file Geometry.

typedef Transform<float,2,AffineCompact> Eigen::AffineCompact2f

Definition at line 639 of file Geometry.

typedef Transform<double,3,AffineCompact> Eigen::AffineCompact3d

Definition at line 645 of file Geometry.

typedef Transform<float,3,AffineCompact> Eigen::AffineCompact3f

Definition at line 641 of file Geometry.

typedef DiagonalMatrix<double,2> Eigen::AlignedScaling2d
Deprecated:

Definition at line 153 of file Geometry.

typedef DiagonalMatrix<float, 2> Eigen::AlignedScaling2f
Deprecated:

Definition at line 151 of file Geometry.

typedef DiagonalMatrix<double,3> Eigen::AlignedScaling3d
Deprecated:

Definition at line 157 of file Geometry.

typedef DiagonalMatrix<float, 3> Eigen::AlignedScaling3f
Deprecated:

Definition at line 155 of file Geometry.

typedef AngleAxis<double> Eigen::AngleAxisd

double precision angle-axis type

Definition at line 163 of file Geometry.

typedef AngleAxis<float> Eigen::AngleAxisf

single precision angle-axis type

Definition at line 160 of file Geometry.

typedef Transform<double,2,Isometry> Eigen::Isometry2d

Definition at line 625 of file Geometry.

typedef Transform<float,2,Isometry> Eigen::Isometry2f

Definition at line 621 of file Geometry.

typedef Transform<double,3,Isometry> Eigen::Isometry3d

Definition at line 627 of file Geometry.

typedef Transform<float,3,Isometry> Eigen::Isometry3f

Definition at line 623 of file Geometry.

typedef Transform<double,2,Projective> Eigen::Projective2d

Definition at line 652 of file Geometry.

typedef Transform<float,2,Projective> Eigen::Projective2f

Definition at line 648 of file Geometry.

typedef Transform<double,3,Projective> Eigen::Projective3d

Definition at line 654 of file Geometry.

typedef Transform<float,3,Projective> Eigen::Projective3f

Definition at line 650 of file Geometry.

typedef Quaternion<double> Eigen::Quaterniond

double precision quaternion type

Definition at line 295 of file Geometry.

typedef Quaternion<float> Eigen::Quaternionf

single precision quaternion type

Definition at line 292 of file Geometry.

typedef Map<Quaternion<double>, Aligned> Eigen::QuaternionMapAlignedd

Map a 16-bits aligned array of double precision scalars as a quaternion.

Definition at line 418 of file Geometry.

typedef Map<Quaternion<float>, Aligned> Eigen::QuaternionMapAlignedf

Map a 16-bits aligned array of double precision scalars as a quaternion.

Definition at line 415 of file Geometry.

typedef Map<Quaternion<double>, 0> Eigen::QuaternionMapd

Map an unaligned array of double precision scalar as a quaternion.

Definition at line 412 of file Geometry.

typedef Map<Quaternion<float>, 0> Eigen::QuaternionMapf

Map an unaligned array of single precision scalar as a quaternion.

Definition at line 409 of file Geometry.

typedef Rotation2D<double> Eigen::Rotation2Dd

double precision 2D rotation type

Definition at line 140 of file Geometry.

typedef Rotation2D<float> Eigen::Rotation2Df

single precision 2D rotation type

Definition at line 137 of file Geometry.

typedef Translation<double,2> Eigen::Translation2d

Definition at line 185 of file Geometry.

typedef Translation<float, 2> Eigen::Translation2f

Definition at line 184 of file Geometry.

typedef Translation<double,3> Eigen::Translation3d

Definition at line 187 of file Geometry.

typedef Translation<float, 3> Eigen::Translation3f

Definition at line 186 of file Geometry.


Function Documentation

Matrix< typename MatrixBase< Derived >::Scalar, 3, 1 > Eigen::MatrixBase::eulerAngles ( Index  a0,
Index  a1,
Index  a2 
) const [inline]

Returns:
the Euler-angles of the rotation matrix *this using the convention defined by the triplet (a0,a1,a2)

Each of the three parameters a0,a1,a2 represents the respective rotation axis as an integer in {0,1,2}. For instance, in:

 Vector3f ea = mat.eulerAngles(2, 0, 2); 

"2" represents the z axis and "0" the x axis, etc. The returned angles are such that we have the following equality:

 mat == AngleAxisf(ea[0], Vector3f::UnitZ())
      * AngleAxisf(ea[1], Vector3f::UnitX())
      * AngleAxisf(ea[2], Vector3f::UnitZ()); 

This corresponds to the right-multiply conventions (with right hand side frames).

Definition at line 47 of file Geometry.

template<typename Derived , typename OtherDerived >
internal::umeyama_transform_matrix_type<Derived, OtherDerived>::type Eigen::umeyama ( const MatrixBase< Derived > &  src,
const MatrixBase< OtherDerived > &  dst,
bool  with_scaling = true 
)

Returns the transformation between two point sets.

The algorithm is based on: "Least-squares estimation of transformation parameters between two point patterns", Shinji Umeyama, PAMI 1991, DOI: 10.1109/34.88573

It estimates parameters $ c, \mathbf{R}, $ and $ \mathbf{t} $ such that

\begin{align*} \frac{1}{n} \sum_{i=1}^n \vert\vert y_i - (c\mathbf{R}x_i + \mathbf{t}) \vert\vert_2^2 \end{align*}

is minimized.

The algorithm is based on the analysis of the covariance matrix $ \Sigma_{\mathbf{x}\mathbf{y}} \in \mathbb{R}^{d \times d} $ of the input point sets $ \mathbf{x} $ and $ \mathbf{y} $ where $d$ is corresponding to the dimension (which is typically small). The analysis is involving the SVD having a complexity of $O(d^3)$ though the actual computational effort lies in the covariance matrix computation which has an asymptotic lower bound of $O(dm)$ when the input point sets have dimension $d \times m$.

Currently the method is working only for floating point matrices.

Todo:
Should the return type of umeyama() become a Transform?
Parameters:
srcSource points $ \mathbf{x} = \left( x_1, \hdots, x_n \right) $.
dstDestination points $ \mathbf{y} = \left( y_1, \hdots, y_n \right) $.
with_scalingSets $ c=1 $ when false is passed.
Returns:
The homogeneous transformation

\begin{align*} T = \begin{bmatrix} c\mathbf{R} & \mathbf{t} \\ \mathbf{0} & 1 \end{bmatrix} \end{align*}

minimizing the resudiual above. This transformation is always returned as an Eigen::Matrix.

Definition at line 109 of file Geometry.




Page generated by Doxygen 1.7.5 for MRPT 0.9.5 SVN: at Thu Oct 13 21:25:36 UTC 2011