Visual Servoing Platform  version 3.0.0
vpQuaternionVector Class Reference

#include <visp3/core/vpQuaternionVector.h>

+ Inheritance diagram for vpQuaternionVector:

Public Member Functions

 vpQuaternionVector ()
 
 vpQuaternionVector (const vpQuaternionVector &q)
 
 vpQuaternionVector (const double qx, const double qy, const double qz, const double qw)
 
 vpQuaternionVector (const vpRotationMatrix &R)
 
 vpQuaternionVector (const vpThetaUVector &tu)
 
virtual ~vpQuaternionVector ()
 
vpQuaternionVector buildFrom (const double qx, const double qy, const double qz, const double qw)
 
vpQuaternionVector buildFrom (const vpRotationMatrix &R)
 
vpQuaternionVector buildFrom (const vpThetaUVector &tu)
 
void set (const double x, const double y, const double z, const double w)
 
double x () const
 
double y () const
 
double z () const
 
double w () const
 
vpQuaternionVector operator+ (const vpQuaternionVector &q) const
 
vpQuaternionVector operator- (const vpQuaternionVector &q) const
 
vpQuaternionVector operator- () const
 
vpQuaternionVector operator* (const double l) const
 
vpQuaternionVector operator* (const vpQuaternionVector &rq) const
 
vpQuaternionVector operator/ (const double l) const
 
vpQuaternionVector conjugate () const
 
vpQuaternionVector inverse () const
 
double magnitude () const
 
void normalize ()
 
Inherited functionalities from vpRotationVector
double & operator[] (unsigned int i)
 
const double & operator[] (unsigned int i) 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 quaternion angle minimal representation.

Defines a quaternion and its basic operations.

The vpQuaternionVector class is derived from vpRotationVector.

A quaternion is defined by four values: ${\bf q} = (x, y, z, w)$.

This class allows to compute a quaternion from a rotation matrix using either vpQuaternionVector(const vpRotationMatrix &) constructor or buildFrom() method.

It also defines common operations on a quaternion such as:

  • multiplication (scalar and quaternion)
  • addition
  • substraction.

Definition at line 81 of file vpQuaternionVector.h.

Constructor & Destructor Documentation

vpQuaternionVector::vpQuaternionVector ( )

Default constructor that initialize all the 4 angles to zero.

Definition at line 55 of file vpQuaternionVector.cpp.

Referenced by conjugate(), operator*(), operator+(), operator-(), and operator/().

vpQuaternionVector::vpQuaternionVector ( const vpQuaternionVector q)

Copy constructor.

Definition at line 60 of file vpQuaternionVector.cpp.

vpQuaternionVector::vpQuaternionVector ( const double  qx,
const double  qy,
const double  qz,
const double  qw 
)

Constructor from doubles.

Definition at line 65 of file vpQuaternionVector.cpp.

References set().

vpQuaternionVector::vpQuaternionVector ( const vpRotationMatrix R)

Constructs a quaternion from a rotation matrix.

Parameters
R: Matrix containing a rotation.

Definition at line 77 of file vpQuaternionVector.cpp.

References buildFrom().

vpQuaternionVector::vpQuaternionVector ( 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 vpQuaternionVector.cpp.

References buildFrom().

virtual vpQuaternionVector::~vpQuaternionVector ( )
inlinevirtual

Destructor.

Definition at line 93 of file vpQuaternionVector.h.

Member Function Documentation

vpQuaternionVector vpQuaternionVector::buildFrom ( const double  qx,
const double  qy,
const double  qz,
const double  qw 
)

Manually change values of a quaternion.

Parameters
qx: x quaternion parameter.
qy: y quaternion parameter.
qz: z quaternion parameter.
qw: w quaternion parameter.
See also
set()

Definition at line 121 of file vpQuaternionVector.cpp.

References set().

Referenced by buildFrom(), vpPoseVector::extract(), vpHomogeneousMatrix::extract(), and vpQuaternionVector().

vpQuaternionVector vpQuaternionVector::buildFrom ( const vpRotationMatrix R)

Constructs a quaternion from a rotation matrix.

Parameters
R: Rotation matrix.

Definition at line 201 of file vpQuaternionVector.cpp.

References vpThetaUVector::extract(), and set().

vpQuaternionVector vpQuaternionVector::buildFrom ( const vpThetaUVector tu)

Convert a $\theta {\bf u}$ vector into a quaternion.

Parameters
tu: $\theta {\bf u}$ representation of a rotation used here as input.
Returns
Quaternion vector.

Definition at line 135 of file vpQuaternionVector.cpp.

References buildFrom().

vpQuaternionVector vpQuaternionVector::conjugate ( ) const

Quaternion conjugate.

Returns
The conjugate quaternion.

Definition at line 220 of file vpQuaternionVector.cpp.

References vpQuaternionVector(), w(), x(), y(), and z().

Referenced by inverse().

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.
vpQuaternionVector vpQuaternionVector::inverse ( ) const

Quaternion inverse.

Returns
The inverse quaternion.

Definition at line 229 of file vpQuaternionVector.cpp.

References conjugate(), vpMath::nul(), w(), x(), y(), and z().

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().

double vpQuaternionVector::magnitude ( ) const

Quaternion magnitude or norm.

Returns
The magnitude or norm of the quaternion.

Definition at line 247 of file vpQuaternionVector.cpp.

References w(), x(), y(), and z().

Referenced by normalize().

void vpQuaternionVector::normalize ( )

Normalize the quaternion.

Definition at line 254 of file vpQuaternionVector.cpp.

References magnitude(), vpMath::nul(), set(), w(), x(), y(), and z().

vpQuaternionVector vpQuaternionVector::operator* ( const double  l) const

Multiplication by scalar. Returns a quaternion defined by (lx,ly,lz,lw).

Definition at line 172 of file vpQuaternionVector.cpp.

References vpQuaternionVector(), w(), x(), y(), and z().

vpQuaternionVector vpQuaternionVector::operator* ( const vpQuaternionVector rq) const

Multiply two quaternions.

Definition at line 178 of file vpQuaternionVector.cpp.

References vpQuaternionVector(), w(), x(), y(), and z().

vpQuaternionVector vpQuaternionVector::operator+ ( const vpQuaternionVector q) const

Quaternion addition.

Adds two quaternions. Addition is component-wise.

Parameters
q: quaternion to add.

Definition at line 149 of file vpQuaternionVector.cpp.

References vpQuaternionVector(), w(), x(), y(), and z().

vpQuaternionVector vpQuaternionVector::operator- ( const vpQuaternionVector q) const

Quaternion substraction.

Substracts a quaternion from another. Substraction is component-wise.

Parameters
q: quaternion to substract.

Definition at line 160 of file vpQuaternionVector.cpp.

References vpQuaternionVector(), w(), x(), y(), and z().

vpQuaternionVector vpQuaternionVector::operator- ( void  ) const

Negate operator. Returns a quaternion defined by (-x,-y,-z-,-w).

Definition at line 166 of file vpQuaternionVector.cpp.

References vpQuaternionVector(), w(), x(), y(), and z().

vpQuaternionVector vpQuaternionVector::operator/ ( const double  l) const

Division by scalar. Returns a quaternion defined by (x/l,y/l,z/l,w/l).

Definition at line 186 of file vpQuaternionVector.cpp.

References vpException::fatalError, vpMath::nul(), vpQuaternionVector(), w(), x(), y(), and z().

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().

void vpQuaternionVector::set ( const double  qx,
const double  qy,
const double  qz,
const double  qw 
)

Manually change values of a quaternion.

Parameters
qx: x quaternion parameter.
qy: y quaternion parameter.
qz: z quaternion parameter.
qw: w quaternion parameter.

Definition at line 103 of file vpQuaternionVector.cpp.

References vpArray2D< double >::data.

Referenced by buildFrom(), normalize(), and vpQuaternionVector().

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.

double vpQuaternionVector::w ( ) const

Returns w-component of the quaternion.

Definition at line 268 of file vpQuaternionVector.cpp.

References vpArray2D< double >::data.

Referenced by vpRotationMatrix::buildFrom(), conjugate(), inverse(), magnitude(), normalize(), operator*(), operator+(), operator-(), and operator/().

double vpQuaternionVector::x ( ) const

Returns x-component of the quaternion.

Definition at line 262 of file vpQuaternionVector.cpp.

References vpArray2D< double >::data.

Referenced by vpRotationMatrix::buildFrom(), conjugate(), inverse(), magnitude(), normalize(), operator*(), operator+(), operator-(), and operator/().

double vpQuaternionVector::y ( ) const

Returns y-component of the quaternion.

Definition at line 264 of file vpQuaternionVector.cpp.

References vpArray2D< double >::data.

Referenced by vpRotationMatrix::buildFrom(), conjugate(), inverse(), magnitude(), normalize(), operator*(), operator+(), operator-(), and operator/().

double vpQuaternionVector::z ( ) const

Returns z-component of the quaternion.

Definition at line 266 of file vpQuaternionVector.cpp.

References vpArray2D< double >::data.

Referenced by vpRotationMatrix::buildFrom(), conjugate(), inverse(), magnitude(), normalize(), operator*(), operator+(), operator-(), and operator/().

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(), vpRxyzVector::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=(), vpRxyzVector::operator=(), vpMatrix::operator=(), vpThetaUVector::operator=(), vpColVector::operator[](), vpRowVector::reshape(), vpColVector::reshape(), set(), vpMatrix::stackRows(), vpRotationVector::t(), vpTranslationVector::t(), vpPoseVector::t(), vpRowVector::t(), vpColVector::t(), w(), x(), y(), 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().