Visual Servoing Platform  version 3.0.0
vpRxyzVector Class Reference

#include <visp3/core/vpRxyzVector.h>

+ Inheritance diagram for vpRxyzVector:

Public Member Functions

 vpRxyzVector ()
 
 vpRxyzVector (const vpRxyzVector &rxyz)
 
 vpRxyzVector (const double phi, const double theta, const double psi)
 
 vpRxyzVector (const vpRotationMatrix &R)
 
 vpRxyzVector (const vpThetaUVector &tu)
 
virtual ~vpRxyzVector ()
 
vpRxyzVector buildFrom (const vpRotationMatrix &R)
 
vpRxyzVector buildFrom (const vpThetaUVector &tu)
 
void buildFrom (const double phi, const double theta, const double psi)
 
vpRxyzVectoroperator= (double x)
 
Inherited functionalities from vpRotationVector
double & operator[] (unsigned int i)
 
const double & operator[] (unsigned int i) const
 
vpColVector operator* (double x) const
 
double sumSquare () const
 
vpRowVector t () const
 
Inherited functionalities from vpArray2D
double getMinValue () const
 
double getMaxValue () const
 
unsigned int getRows () const
 
unsigned int getCols () const
 
unsigned int size () const
 
void resize (const unsigned int nrows, const unsigned int ncols, const bool flagNullify=true)
 

Static Public Member Functions

Inherited I/O from vpArray2D with Static Public Member Functions
static bool load (const std::string &filename, vpArray2D< double > &A, const bool binary=false, char *header=NULL)
 
static bool loadYAML (const std::string &filename, vpArray2D< double > &A, char *header=NULL)
 
static bool save (const std::string &filename, const vpArray2D< double > &A, const bool binary=false, const char *header="")
 
static bool saveYAML (const std::string &filename, const vpArray2D< double > &A, const char *header="")
 

Public Attributes

double * data
 

Protected Attributes

unsigned int rowNum
 
unsigned int colNum
 
double ** rowPtrs
 
unsigned int dsize
 

Related Functions

(Note that these are not member functions.)

vpColVector operator* (const double &x, const vpRotationVector &v)
 
enum  vpGEMMmethod
 

Detailed Description

Implementation of a rotation vector as $R(x,y,z)$ Euler angle minimal representation.

Class that consider the case of the Euler $(\varphi,\theta,\psi)$ angle using the x-y-z convention, where $(\varphi,\theta,\psi)$ are respectively the rotation angles around the $x$, $y$ and $z$ axis.

\[R_{xyz}(\varphi,\theta,\psi) = R_x(\varphi) \; R_y(\theta) \; R_z(\psi)\]

with

\[R_{x}(\varphi) = \left( \begin{array}{ccc} 1 & 0 & 0 \\ 0 &\cos \varphi & -\sin\varphi \\ 0 &\sin \varphi & \cos\varphi \\ \end{array} \right) \; R_{y}(\theta) = \left( \begin{array}{ccc} \cos \theta & 0 & \sin\theta\\ 0 & 1 & 0 \\ -\sin\theta & 0 &\cos \theta \end{array} \right) \; R_{z}(\psi) = \left( \begin{array}{ccc} \cos \psi & -\sin\psi & 0\\ \sin\psi &\cos \psi& 0 \\ 0 & 0 & 1 \end{array} \right)\]

The rotation matrix corresponding to the x-y-z convention is given by:

\[ R_{xyz}(\varphi,\theta,\psi) = \left( \begin{array}{ccc} \cos\theta \cos\psi & -\cos\theta \sin\psi & \sin\theta \\ \sin\varphi \sin\theta \cos\psi + \cos\varphi\sin\psi & -\sin\varphi \sin\theta \sin\psi +\cos\varphi\cos\psi & -\sin\varphi \cos\theta \\ -\cos\varphi \sin\theta \cos\psi + \sin\varphi\sin\psi & \cos\varphi \sin\theta \sin\psi +\sin\varphi\cos\psi & \cos\varphi \cos\theta \end{array} \right) \]

The vpRxyzVector class is derived from vpRotationVector.

The code below shows first how to initialize this representation of Euler angles, than how to contruct a rotation matrix from a vpRxyzVector and finaly how to extract the vpRxyzVector Euler angles from the build rotation matrix.

#include <iostream>
#include <visp3/core/vpMath.h>
#include <visp3/core/vpRotationMatrix.h>
#include <visp3/core/vpRxyzVector.h>
int main()
{
// Initialise the Euler angles
rxyz[0] = vpMath::rad( 45.f); // phi angle in rad around x axis
rxyz[1] = vpMath::rad(-30.f); // theta angle in rad around y axis
rxyz[2] = vpMath::rad( 90.f); // psi angle in rad around z axis
// Construct a rotation matrix from the Euler angles
// Extract the Euler angles around x,y,z axis from a rotation matrix
rxyz.buildFrom(R);
// Print the extracted Euler angles. Values are the same than the
// one used for initialization
std::cout << rxyz;
// Since the rotation vector is 3 values column vector, the
// transpose operation produce a row vector.
vpRowVector rxyz_t = rxyz.t();
// Print the transpose row vector
std::cout << rxyz_t << std::endl;
}
Examples:
AROgreBasic.cpp, exponentialMap.cpp, HelloWorldOgre.cpp, manGeometricFeatures.cpp, servoAfma6FourPoints2DCamVelocityInteractionCurrent.cpp, servoAfma6FourPoints2DCamVelocityInteractionDesired.cpp, servoViper650FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper850FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper850FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper850FourPointsKinect.cpp, testRobotAfma6Pose.cpp, testRobotViper850Pose.cpp, testTwistMatrix.cpp, and tutorial-ibvs-4pts-wireframe-robot-viper.cpp.

Definition at line 154 of file vpRxyzVector.h.

Constructor & Destructor Documentation

vpRxyzVector::vpRxyzVector ( )

Default constructor that initialize all the 3 angles to zero.

Definition at line 51 of file vpRxyzVector.cpp.

vpRxyzVector::vpRxyzVector ( const vpRxyzVector rxyz)

Copy constructor.

Definition at line 56 of file vpRxyzVector.cpp.

vpRxyzVector::vpRxyzVector ( const double  phi,
const double  theta,
const double  psi 
)

Constructor from 3 angles (in radian).

Parameters
phi: $\varphi$ angle around the $x$ axis.
theta: $\theta$ angle around the $y$ axis.
psi: $\psi$ angle around the $z$ axis.

Definition at line 66 of file vpRxyzVector.cpp.

References buildFrom().

vpRxyzVector::vpRxyzVector ( const vpRotationMatrix R)

Constructor that initialize $R_{xyz}=(\varphi,\theta,\psi)$ Euler angles from a rotation matrix.

Parameters
R: Rotation matrix used to initialize the Euler angles.

Definition at line 77 of file vpRxyzVector.cpp.

References buildFrom().

vpRxyzVector::vpRxyzVector ( const vpThetaUVector tu)

Constructor that initialize $R_{xyz}=(\varphi,\theta,\psi)$ Euler angles vector from a $\theta {\bf u}$ vector.

Parameters
tu: $\theta {\bf u}$ representation of a rotation used here as input to initialize the Euler angles.

Definition at line 89 of file vpRxyzVector.cpp.

References buildFrom().

virtual vpRxyzVector::~vpRxyzVector ( )
inlinevirtual

Destructor.

Definition at line 168 of file vpRxyzVector.h.

Member Function Documentation

vpRxyzVector vpRxyzVector::buildFrom ( const vpThetaUVector tu)

Convert a $\theta {\bf u}$ vector into a $R_{xyz}=(\varphi,\theta,\psi)$ Euler angles vector.

Parameters
tu: $\theta {\bf u}$ representation of a rotation used here as input.
Returns
$R_{xyz}=(\varphi,\theta,\psi)$ Euler angles vector.

Definition at line 129 of file vpRxyzVector.cpp.

References vpRotationMatrix::buildFrom(), and buildFrom().

void vpRxyzVector::buildFrom ( const double  phi,
const double  theta,
const double  psi 
)

Construction from 3 angles (in radian).

Parameters
phi: $\varphi$ angle around the $x$ axis.
theta: $\theta$ angle around the $y$ axis.
psi: $\psi$ angle around the $z$ axis.

Definition at line 145 of file vpRxyzVector.cpp.

References vpArray2D< double >::data.

double vpArray2D< double >::getMaxValue ( ) const
inherited

Return the array max value.

Examples:
servoMomentImage.cpp.
double vpArray2D< double >::getMinValue ( ) const
inherited

Return the array min value.

Examples:
servoMomentImage.cpp.
static bool vpArray2D< double >::load ( const std::string &  filename,
vpArray2D< double > &  A,
const bool  binary = false,
char *  header = NULL 
)
inlinestaticinherited

Load a matrix from a file.

Parameters
filename: Absolute file name.
A: Array to be loaded
binary: If true the matrix is loaded from a binary file, else from a text file.
header: Header of the file is loaded in this parameter.
Returns
Returns true if success.
See also
save()

Definition at line 308 of file vpArray2D.h.

References vpException::badValue, and vpArray2D< Type >::resize().

static bool vpArray2D< double >::loadYAML ( const std::string &  filename,
vpArray2D< double > &  A,
char *  header = NULL 
)
inlinestaticinherited

Load an array from a YAML-formatted file.

Parameters
filename: absolute file name.
A: array to be loaded from the file.
header: header of the file is loaded in this parameter.
Returns
Returns true on success.
See also
saveYAML()

Definition at line 392 of file vpArray2D.h.

References vpArray2D< Type >::resize().

vpColVector vpRotationVector::operator* ( double  x) const
inherited

Operator that allows to multiply each element of a rotation vector by a scalar.

Parameters
x: The scalar.
Returns
The rotation vector multiplied by the scalar as a column vector. The current rotation vector (*this) is unchanged.

Definition at line 76 of file vpRotationVector.cpp.

References vpArray2D< double >::dsize.

vpRxyzVector & vpRxyzVector::operator= ( double  v)

Initialize each element of the vector to the same angle value v.

Parameters
v: Angle value to set for each element of the vector.
#include <visp3/core/vpMath.h>
#include <visp3/core/vpRxyzVector.h>
int main()
{
// Initialise the rotation vector
v = vpMath::rad( 45.f); // All the 3 angles are set to 45 degrees
}

Definition at line 171 of file vpRxyzVector.cpp.

References vpArray2D< double >::data, and vpArray2D< double >::dsize.

double& vpRotationVector::operator[] ( unsigned int  i)
inlineinherited

Operator that allows to set the value of an element of the rotation vector: r[i] = value

Definition at line 126 of file vpRotationVector.h.

const double& vpRotationVector::operator[] ( unsigned int  i) const
inlineinherited

Operator that allows to get the value of an element of the rotation vector: value = r[i]

Definition at line 131 of file vpRotationVector.h.

void vpArray2D< double >::resize ( const unsigned int  nrows,
const unsigned int  ncols,
const bool  flagNullify = true 
)
inlineinherited

Set the size of the array and initialize all the values to zero.

Parameters
nrows: number of rows.
ncols: number of column.
flagNullify: if true, then the array is re-initialized to 0 after resize. If false, the initial values from the common part of the array (common part between old and new version of the array) are kept. Default value is true.
Examples:
testArray2D.cpp, testMatrix.cpp, testMatrixInverse.cpp, and testSvd.cpp.

Definition at line 167 of file vpArray2D.h.

References vpArray2D< Type >::colNum, vpArray2D< Type >::dsize, vpException::memoryAllocationError, vpArray2D< Type >::rowNum, and vpArray2D< Type >::rowPtrs.

Referenced by vpMatrix::diag(), vpMatrix::eye(), vpMatrix::init(), and vpMatrix::operator=().

static bool vpArray2D< double >::save ( const std::string &  filename,
const vpArray2D< double > &  A,
const bool  binary = false,
const char *  header = "" 
)
inlinestaticinherited

Save a matrix to a file.

Parameters
filename: Absolute file name.
A: Array to be saved.
binary: If true the matrix is saved in a binary file, else a text file.
header: Optional line that will be saved at the beginning of the file.
Returns
Returns true if success.

Warning : If you save the matrix as in a text file the precision is less than if you save it in a binary file.

See also
load()

Definition at line 468 of file vpArray2D.h.

References vpArray2D< Type >::getCols(), and vpArray2D< Type >::getRows().

static bool vpArray2D< double >::saveYAML ( const std::string &  filename,
const vpArray2D< double > &  A,
const char *  header = "" 
)
inlinestaticinherited

Save an array in a YAML-formatted file.

Parameters
filename: absolute file name.
A: array to be saved in the file.
header: optional lines that will be saved at the beginning of the file. Should be YAML-formatted and will adapt to the indentation if any.
Returns
Returns true if success.

Here is an example of outputs.

vpArray2D::saveYAML("matrix.yml", M, "example: a YAML-formatted header");
vpArray2D::saveYAML("matrixIndent.yml", M, "example:\n - a YAML-formatted header\n - with inner indentation");

Content of matrix.yml:

example: a YAML-formatted header
rows: 3
cols: 4
- [0, 0, 0, 0]
- [0, 0, 0, 0]
- [0, 0, 0, 0]

Content of matrixIndent.yml:

example:
- a YAML-formatted header
- with inner indentation
rows: 3
cols: 4
- [0, 0, 0, 0]
- [0, 0, 0, 0]
- [0, 0, 0, 0]
See also
loadYAML()

Definition at line 560 of file vpArray2D.h.

References vpArray2D< Type >::getCols(), and vpArray2D< Type >::getRows().

double vpRotationVector::sumSquare ( ) const
inherited

Return the sum square of all the elements $r_{i}$ of the rotation vector r(m).

Returns
The value

\[\sum{i=0}^{m} r_i^{2}\]

.

Definition at line 101 of file vpRotationVector.cpp.

References vpArray2D< double >::rowNum, and vpArray2D< double >::rowPtrs.

vpRowVector vpRotationVector::t ( ) const
inherited

Return the transpose of the rotation vector.

Examples:
testViper850.cpp.

Definition at line 57 of file vpRotationVector.cpp.

References vpArray2D< double >::data, and vpArray2D< double >::dsize.

Friends And Related Function Documentation

vpColVector operator* ( const double &  x,
const vpRotationVector v 
)
related

Allows to multiply a scalar by rotaion vector.

Definition at line 89 of file vpRotationVector.cpp.

enum vpGEMMmethod
related

Enumeration of the operations applied on matrices in vpGEMM() function.

Operations are :

  • VP_GEMM_A_T to use the transpose matrix of A instead of the matrix A
  • VP_GEMM_B_T to use the transpose matrix of B instead of the matrix B
  • VP_GEMM_C_T to use the transpose matrix of C instead of the matrix C

Definition at line 57 of file vpGEMM.h.

Member Data Documentation

double * vpArray2D< double >::data
inherited

Address of the first element of the data array.

Examples:
testDisplacement.cpp, testMatrix.cpp, testPoseVector.cpp, and testTranslationVector.cpp.

Definition at line 84 of file vpArray2D.h.

Referenced by vpMatrix::AtA(), vpHomogeneousMatrix::buildFrom(), vpRzyxVector::buildFrom(), vpRzyzVector::buildFrom(), buildFrom(), vpThetaUVector::buildFrom(), vpSubColVector::checkParentStatus(), vpSubRowVector::checkParentStatus(), vpSubMatrix::checkParentStatus(), vpColVector::clear(), vpHomogeneousMatrix::convert(), vpTranslationVector::euclideanNorm(), vpRowVector::euclideanNorm(), vpColVector::euclideanNorm(), vpMatrix::euclideanNorm(), vpMatrix::expm(), vpThetaUVector::extract(), vpSubColVector::init(), vpSubRowVector::init(), vpSubMatrix::init(), vpTranslationVector::operator*(), vpRowVector::operator*(), vpColVector::operator*(), vpHomography::operator*(), vpTranslationVector::operator-(), vpRowVector::operator-(), vpColVector::operator-(), vpTranslationVector::operator/(), vpRowVector::operator/(), vpColVector::operator/(), vpHomography::operator/(), vpHomography::operator/=(), vpSubColVector::operator=(), vpSubRowVector::operator=(), vpTranslationVector::operator=(), vpRowVector::operator=(), vpColVector::operator=(), vpRzyxVector::operator=(), vpRzyzVector::operator=(), operator=(), vpMatrix::operator=(), vpThetaUVector::operator=(), vpColVector::operator[](), vpRowVector::reshape(), vpColVector::reshape(), vpQuaternionVector::set(), vpMatrix::stackRows(), vpRotationVector::t(), vpTranslationVector::t(), vpPoseVector::t(), vpRowVector::t(), vpColVector::t(), vpQuaternionVector::w(), vpQuaternionVector::x(), vpQuaternionVector::y(), vpQuaternionVector::z(), vpSubColVector::~vpSubColVector(), vpSubMatrix::~vpSubMatrix(), and vpSubRowVector::~vpSubRowVector().

unsigned int vpArray2D< double >::rowNum
protectedinherited

Number of rows in the array.

Definition at line 74 of file vpArray2D.h.

Referenced by vpMatrix::AAt(), vpMatrix::AtA(), vpColVector::clear(), vpMatrix::diag(), vpMatrix::eigenValues(), vpMatrix::expm(), vpColVector::extract(), vpMatrix::eye(), vpColVector::infinityNorm(), vpMatrix::infinityNorm(), vpSubColVector::init(), vpSubRowVector::init(), vpSubMatrix::init(), vpMatrix::insert(), vpMatrix::inverseByCholesky(), vpMatrix::inverseByLU(), vpMatrix::inverseByQR(), vpRotationMatrix::operator*(), vpTranslationVector::operator*(), vpHomogeneousMatrix::operator*(), vpColVector::operator*(), vpMatrix::operator*(), vpRotationMatrix::operator*=(), vpTranslationVector::operator*=(), vpColVector::operator*=(), vpMatrix::operator*=(), vpColVector::operator+(), vpColVector::operator+=(), vpMatrix::operator+=(), vpColVector::operator-(), vpColVector::operator-=(), vpMatrix::operator-=(), vpColVector::operator/(), vpMatrix::operator/(), vpTranslationVector::operator/=(), vpColVector::operator/=(), vpMatrix::operator/=(), vpMatrix::operator<<(), vpColVector::operator<<(), vpSubColVector::operator=(), vpSubRowVector::operator=(), vpSubMatrix::operator=(), vpTranslationVector::operator=(), vpRowVector::operator=(), vpColVector::operator=(), vpMatrix::operator=(), vpColVector::reshape(), vpMatrix::setIdentity(), vpMatrix::stack(), vpColVector::stack(), vpMatrix::stackColumns(), vpMatrix::stackRows(), vpMatrix::sum(), vpRotationVector::sumSquare(), vpTranslationVector::sumSquare(), vpColVector::sumSquare(), vpMatrix::sumSquare(), vpTranslationVector::t(), vpPoseVector::t(), vpColVector::t(), vpMatrix::t(), and vpMatrix::transpose().