Visual Servoing Platform  version 3.1.0
Public Member Functions | Public Attributes | Protected Attributes | Related Functions | List of all members
vpThetaUVector Class Reference
core: Core module » Mathematics » Tranformations

#include <visp3/core/vpThetaUVector.h>

+ Inheritance diagram for vpThetaUVector:

Public Member Functions

 vpThetaUVector ()
 
 vpThetaUVector (const vpThetaUVector &tu)
 
 vpThetaUVector (const vpHomogeneousMatrix &M)
 
 vpThetaUVector (const vpPoseVector &p)
 
 vpThetaUVector (const vpRotationMatrix &R)
 
 vpThetaUVector (const vpRzyxVector &rzyx)
 
 vpThetaUVector (const vpRzyzVector &rzyz)
 
 vpThetaUVector (const vpRxyzVector &rxyz)
 
 vpThetaUVector (const vpQuaternionVector &q)
 
 vpThetaUVector (const double tux, const double tuy, const double tuz)
 
 vpThetaUVector (const vpColVector &tu)
 
virtual ~vpThetaUVector ()
 
vpThetaUVector buildFrom (const vpHomogeneousMatrix &M)
 
vpThetaUVector buildFrom (const vpPoseVector &p)
 
vpThetaUVector buildFrom (const vpRotationMatrix &R)
 
vpThetaUVector buildFrom (const vpRzyxVector &rzyx)
 
vpThetaUVector buildFrom (const vpRzyzVector &zyz)
 
vpThetaUVector buildFrom (const vpRxyzVector &xyz)
 
vpThetaUVector buildFrom (const vpQuaternionVector &q)
 
void buildFrom (const double tux, const double tuy, const double tuz)
 
void extract (double &theta, vpColVector &u) const
 
double getTheta () const
 
vpColVector getU () const
 
vpThetaUVector & operator= (const vpColVector &tu)
 
vpThetaUVector & operator= (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
unsigned int getCols () const
 
double getMaxValue () const
 
double getMinValue () const
 
unsigned int getRows () const
 
unsigned int size () const
 
void resize (const unsigned int nrows, const unsigned int ncols, const bool flagNullify=true, const bool recopy_=true)
 
vpArray2D< double > hadamard (const vpArray2D< double > &m) const
 

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
 
void vpGEMM (const vpArray2D< double > &A, const vpArray2D< double > &B, const double &alpha, const vpArray2D< double > &C, const double &beta, vpArray2D< double > &D, const unsigned int &ops=0)
 

Detailed Description

Implementation of a rotation vector as $\theta {\bf u}$ axis-angle minimal representation.

Class that consider the case of the $\theta {\bf u}$ parameterization for the rotation.

The vpThetaUVector class is derived from vpRotationVector.

The $\theta {\bf u}$ representation is one of the minimal representation of a rotation matrix, where ${\bf u} = (u_{x} \; u_{y} \; u_{z})^{\top}$ is a unit vector representing the rotation axis and $\theta$ is the rotation angle.

From the $\theta {\bf u}$ representation it is possible to build the rotation matrix ${\bf R}$ using the Rodrigues formula:

\[ {\bf R} = {\bf I}_{3} + (1 - \cos{ \theta}) \; {\bf u u}^{\top} + \sin{ \theta} \; [{\bf u}]_{\times} \]

with ${\bf I}_{3}$ the identity matrix of dimension $3\times3$ and $[{\bf u}]_{\times}$ the skew matrix:

\[ [{\bf u}]_{\times} = \left( \begin{array}{ccc} 0 & -u_{z} & u_{y} \\ u_{z} & 0 & -u_{x} \\ -u_{y} & u_{x} & 0 \end{array} \right) \]

From the implementation point of view, it is nothing more than an array of three floats.

The code below shows first how to initialize a $\theta {\bf u}$ vector, than how to contruct a rotation matrix from a vpThetaUVector and finaly how to extract the theta U angles from the build rotation matrix.

#include <iostream>
#include <visp3/core/vpMath.h>
#include <visp3/core/vpRotationMatrix.h>
#include <visp3/core/vpThetaUVector.h>
int main()
{
vpThetaUVector tu;
// Initialise the theta U rotation vector
tu[0] = vpMath::rad( 45.f);
tu[1] = vpMath::rad(-30.f);
tu[2] = vpMath::rad( 90.f);
// Construct a rotation matrix from the theta U angles
vpRotationMatrix R(tu);
// Extract the theta U angles from a rotation matrix
tu.buildFrom(R);
// Print the extracted theta U angles. Values are the same than the
// one used for initialization
std::cout << tu;
// Since the rotation vector is 3 values column vector, the
// transpose operation produce a row vector.
vpRowVector tu_t = tu.t();
// Print the transpose row vector
std::cout << tu_t << std::endl;
}
Examples:
calibrateTsai.cpp, exponentialMap.cpp, servoSimu3D_cdMc_CamVelocityWithoutVpServo.cpp, servoSimu3D_cMcd_CamVelocityWithoutVpServo.cpp, testDisplacement.cpp, testFeature.cpp, testPoseRansac2.cpp, testPoseVector.cpp, testRobotViper650-frames.cpp, testRobotViper850-frames.cpp, and tutorial-homography-from-points.cpp.

Definition at line 146 of file vpThetaUVector.h.

Constructor & Destructor Documentation

◆ vpThetaUVector() [1/11]

vpThetaUVector::vpThetaUVector ( )

Default constructor that initialize all the 3 angles to zero.

Definition at line 53 of file vpThetaUVector.cpp.

◆ vpThetaUVector() [2/11]

vpThetaUVector::vpThetaUVector ( const vpThetaUVector &  tu)

Copy constructor.

Definition at line 55 of file vpThetaUVector.cpp.

◆ vpThetaUVector() [3/11]

vpThetaUVector::vpThetaUVector ( const vpHomogeneousMatrix &  M)
explicit

Initialize a $\theta {\bf u}$ vector from an homogeneous matrix.

Definition at line 70 of file vpThetaUVector.cpp.

References buildFrom().

◆ vpThetaUVector() [4/11]

vpThetaUVector::vpThetaUVector ( const vpPoseVector &  p)
explicit

Initialize a $\theta {\bf u}$ vector from a pose vector.

Definition at line 74 of file vpThetaUVector.cpp.

References buildFrom().

◆ vpThetaUVector() [5/11]

vpThetaUVector::vpThetaUVector ( const vpRotationMatrix &  R)
explicit

Initialize a $\theta {\bf u}$ vector from a rotation matrix.

Definition at line 78 of file vpThetaUVector.cpp.

References buildFrom().

◆ vpThetaUVector() [6/11]

vpThetaUVector::vpThetaUVector ( const vpRzyxVector &  rzyx)
explicit

Initialize a $\theta {\bf u}$ vector from an Euler z-y-x representation vector.

Definition at line 84 of file vpThetaUVector.cpp.

References buildFrom().

◆ vpThetaUVector() [7/11]

vpThetaUVector::vpThetaUVector ( const vpRzyzVector &  rzyz)
explicit

Initialize a $\theta {\bf u}$ vector from an Euler z-y-z representation vector.

Definition at line 89 of file vpThetaUVector.cpp.

References buildFrom().

◆ vpThetaUVector() [8/11]

vpThetaUVector::vpThetaUVector ( const vpRxyzVector &  rxyz)
explicit

Initialize a $\theta {\bf u}$ vector from an Euler x-y-z representation vector.

Definition at line 94 of file vpThetaUVector.cpp.

References buildFrom().

◆ vpThetaUVector() [9/11]

vpThetaUVector::vpThetaUVector ( const vpQuaternionVector &  q)
explicit

Initialize a $\theta {\bf u}$ vector from a quaternion representation vector.

Definition at line 99 of file vpThetaUVector.cpp.

References buildFrom().

◆ vpThetaUVector() [10/11]

vpThetaUVector::vpThetaUVector ( const double  tux,
const double  tuy,
const double  tuz 
)

Build a $\theta {\bf u}$ vector from 3 angles in radian.

Definition at line 104 of file vpThetaUVector.cpp.

References buildFrom().

◆ vpThetaUVector() [11/11]

vpThetaUVector::vpThetaUVector ( const vpColVector &  tu)
explicit

Copy constructor from a 3-dimension vector.

Definition at line 57 of file vpThetaUVector.cpp.

References vpArray2D< double >::data, vpException::dimensionError, and vpArray2D< Type >::size().

◆ ~vpThetaUVector()

virtual vpThetaUVector::~vpThetaUVector ( )
inlinevirtual

Destructor.

Definition at line 172 of file vpThetaUVector.h.

References vpRotationVector::operator=().

Member Function Documentation

◆ buildFrom() [1/8]

vpThetaUVector vpThetaUVector::buildFrom ( const vpHomogeneousMatrix &  M)

Converts an homogeneous matrix into a $\theta {\bf u}$ vector.

Examples:
exponentialMap.cpp, and tutorial-homography-from-points.cpp.

Definition at line 112 of file vpThetaUVector.cpp.

References vpHomogeneousMatrix::extract().

Referenced by vpPoseVector::buildFrom(), buildFrom(), vpHomogeneousMatrix::extract(), vpRotationMatrix::getThetaUVector(), vpRobotAfma6::getVelocity(), vpRobotViper650::getVelocity(), vpRobotViper850::getVelocity(), vpExponentialMap::inverse(), vpSimulatorAfma6::setPosition(), and vpThetaUVector().

◆ buildFrom() [2/8]

vpThetaUVector vpThetaUVector::buildFrom ( const vpPoseVector &  p)

Converts a pose vector into a $\theta {\bf u}$ vector copying the $\theta {\bf u}$ values contained in the pose vector.

Definition at line 125 of file vpThetaUVector.cpp.

References vpArray2D< double >::data.

◆ buildFrom() [3/8]

vpThetaUVector vpThetaUVector::buildFrom ( const vpRotationMatrix &  R)

Converts a rotation matrix into a $\theta {\bf u}$ vector.

Definition at line 136 of file vpThetaUVector.cpp.

References vpArray2D< double >::data, and vpMath::sinc().

◆ buildFrom() [4/8]

vpThetaUVector vpThetaUVector::buildFrom ( const vpRzyxVector &  rzyx)

Build a $\theta {\bf u}$ vector from an Euler z-y-x representation vector.

Definition at line 186 of file vpThetaUVector.cpp.

References buildFrom().

◆ buildFrom() [5/8]

vpThetaUVector vpThetaUVector::buildFrom ( const vpRzyzVector &  rzyz)

Build a $\theta {\bf u}$ vector from an Euler z-y-z representation vector.

Definition at line 197 of file vpThetaUVector.cpp.

References buildFrom().

◆ buildFrom() [6/8]

vpThetaUVector vpThetaUVector::buildFrom ( const vpRxyzVector &  rxyz)

Build a $\theta {\bf u}$ vector from an Euler x-y-z representation vector.

Definition at line 208 of file vpThetaUVector.cpp.

References buildFrom().

◆ buildFrom() [7/8]

vpThetaUVector vpThetaUVector::buildFrom ( const vpQuaternionVector &  q)

Build a $\theta {\bf u}$ vector from a quaternion representation vector.

Definition at line 220 of file vpThetaUVector.cpp.

References buildFrom().

◆ buildFrom() [8/8]

void vpThetaUVector::buildFrom ( const double  tux,
const double  tuy,
const double  tuz 
)

Build a $\theta {\bf u}$ vector from 3 angles in radian.

Definition at line 399 of file vpThetaUVector.cpp.

References vpArray2D< double >::data.

◆ extract()

void vpThetaUVector::extract ( double &  theta,
vpColVector &  u 
) const

Extract the rotation angle $ \theta $ and the unit vector $\bf u $ from the $ \theta {\bf u} $ representation.

Parameters
theta: Rotation angle $ \theta $ in rad.
u: 3-dim unit vector ${\bf u} = (u_{x},u_{y},u_{z})^{\top} $ representing the rotation axis.

The following example shows how to use this function:

#include <visp3/core/vpThetaUVector.h>
int main()
{
vpHomogeneousMatrix M(0, 0, 1., vpMath::rad(10), vpMath::rad(20), vpMath::rad(30));
double theta;
vpColVector u;
M.getRotationMatrix().getThetaUVector().extract(theta, u);
std::cout << "theta: " << theta << std::endl;
std::cout << "u : " << u.t() << std::endl;
}
See also
getTheta(), getU()

Definition at line 320 of file vpThetaUVector.cpp.

References vpArray2D< double >::data, getTheta(), and vpColVector::resize().

Referenced by vpQuaternionVector::buildFrom().

◆ getCols()

unsigned int vpArray2D< double >::getCols ( ) const
inlineinherited

Return the number of columns of the 2D array.

See also
getRows(), size()
Examples:
servoViper850Point2DArtVelocity-jointAvoidance-basic.cpp, testColVector.cpp, testDisplacement.cpp, testImageFilter.cpp, testMatrix.cpp, testMatrixDeterminant.cpp, testMatrixInverse.cpp, testMatrixPseudoInverse.cpp, testPoseVector.cpp, testRowVector.cpp, testSvd.cpp, and testTranslationVector.cpp.

Definition at line 146 of file vpArray2D.h.

References vpArray2D< Type >::colNum, vpArray2D< Type >::getMaxValue(), and vpArray2D< Type >::getMinValue().

Referenced by vpRowVector::cppPrint(), vpMatrix::cppPrint(), vpRowVector::csvPrint(), vpMatrix::csvPrint(), vpMatrix::detByLU(), vpMatrix::extract(), vpRotationMatrix::getCol(), vpHomogeneousMatrix::getCol(), vpMatrix::getCol(), vpMatrix::getRow(), vpMatrix::kernel(), vpRowVector::maplePrint(), vpMatrix::maplePrint(), vpRowVector::matlabPrint(), vpMatrix::matlabPrint(), vpRowVector::operator*(), vpRowVector::operator+(), vpRowVector::operator+=(), vpRowVector::operator-(), vpRowVector::operator-=(), vpForceTwistMatrix::print(), vpVelocityTwistMatrix::print(), vpRowVector::print(), vpMatrix::print(), vpMatrix::pseudoInverse(), and vpMatrix::row().

◆ getMaxValue()

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

Return the array max value.

Examples:
servoMomentImage.cpp, testArray2D.cpp, and testMatrix.cpp.

Definition at line 671 of file vpArray2D.h.

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

◆ getMinValue()

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

Return the array min value.

Examples:
servoMomentImage.cpp, testArray2D.cpp, and testMatrix.cpp.

Definition at line 655 of file vpArray2D.h.

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

◆ getRows()

unsigned int vpArray2D< double >::getRows ( ) const
inlineinherited

Return the number of rows of the 2D array.

See also
getCols(), size()
Examples:
testColVector.cpp, testDisplacement.cpp, testImageFilter.cpp, testMatrix.cpp, testMatrixDeterminant.cpp, testMatrixInverse.cpp, testMatrixPseudoInverse.cpp, testPoseVector.cpp, testRowVector.cpp, testSvd.cpp, and testTranslationVector.cpp.

Definition at line 156 of file vpArray2D.h.

References vpArray2D< Type >::rowNum.

Referenced by vpMatrix::column(), vpColVector::cppPrint(), vpMatrix::cppPrint(), vpColVector::csvPrint(), vpMatrix::csvPrint(), vpMatrix::detByLU(), vpMatrix::extract(), vpRotationMatrix::getCol(), vpHomogeneousMatrix::getCol(), vpMatrix::getCol(), vpMatrix::getRow(), vpMatrix::inverseByCholesky(), vpMatrix::kernel(), vpColVector::maplePrint(), vpMatrix::maplePrint(), vpColVector::matlabPrint(), vpMatrix::matlabPrint(), vpColVector::operator+(), vpColVector::operator+=(), vpColVector::operator-(), vpColVector::operator-=(), vpForceTwistMatrix::print(), vpVelocityTwistMatrix::print(), vpPoseVector::print(), vpColVector::print(), vpMatrix::print(), and vpMatrix::pseudoInverse().

◆ getTheta()

double vpThetaUVector::getTheta ( ) const

Get the rotation angle $ \theta $ from the $ \theta {\bf u} $ representation.

Returns
Rotation angle $ \theta $ in rad.

The following example shows how to use this function:

#include <visp3/core/vpThetaUVector.h>
int main()
{
vpHomogeneousMatrix M(0, 0, 1., vpMath::rad(10), vpMath::rad(20), vpMath::rad(30));
std::cout << "theta: " << M.getRotationMatrix().getThetaUVector().getTheta() << std::endl;
std::cout << "u : " << M.getRotationMatrix().getThetaUVector().getU().t() << std::endl;
}
See also
getTheta(), extract()

Definition at line 356 of file vpThetaUVector.cpp.

References vpArray2D< double >::data.

Referenced by extract(), and getU().

◆ getU()

vpColVector vpThetaUVector::getU ( ) const

Get the unit vector $\bf u $ from the $ \theta {\bf u} $ representation.

Returns
3-dim unit vector ${\bf u} = (u_{x},u_{y},u_{z})^{\top} $ representing the rotation axis.

The following example shows how to use this function:

#include <visp3/core/vpThetaUVector.h>
int main()
{
vpHomogeneousMatrix M(0, 0, 1., vpMath::rad(10), vpMath::rad(20), pMath::rad(30));
std::cout << "theta: " << M.getRotationMatrix().getThetaUVector().getTheta() << std::endl;
std::cout << "u : " << M.getRotationMatrix().getThetaUVector().getU().t() << std::endl;
}
See also
getTheta(), extract()

Definition at line 381 of file vpThetaUVector.cpp.

References vpArray2D< double >::data, and getTheta().

◆ hadamard()

vpArray2D< double > vpArray2D< double >::hadamard ( const vpArray2D< double > &  m) const
inherited

Compute the Hadamard product (element wise matrix multiplication).

Parameters
m: Second matrix;
Returns
m1.hadamard(m2) The Hadamard product : $ m1 \circ m2 = (m1 \circ m2)_{i,j} = (m1)_{i,j} (m2)_{i,j} $
Examples:
testArray2D.cpp.

Definition at line 690 of file vpArray2D.h.

References vpArray2D< Type >::colNum, vpArray2D< Type >::data, vpException::dimensionError, vpArray2D< Type >::dsize, vpArray2D< Type >::getCols(), vpArray2D< Type >::getRows(), vpArray2D< Type >::resize(), and vpArray2D< Type >::rowNum.

◆ load()

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 318 of file vpArray2D.h.

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

◆ loadYAML()

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 426 of file vpArray2D.h.

References vpArray2D< Type >::resize().

◆ operator*()

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.

Referenced by vpQuaternionVector::~vpQuaternionVector().

◆ operator=() [1/2]

vpThetaUVector & vpThetaUVector::operator= ( const vpColVector &  tu)

Copy operator that initializes a $\theta {\bf u}$ vector from a 3-dimension column vector tu.

Parameters
tu: 3-dimension vector containing the values of the $\theta {\bf u}$ vector.
#include <visp3/core/vpThetaUVector.h>
int main()
{
vpColVector v(3);
v[0] = 0.1;
v[1] = 0.2;
v[2] = 0.3;
vpThetaUVector tu;
tu = v;
// tu is now equal to v : 0.1, 0.2, 0.3
}

Definition at line 280 of file vpThetaUVector.cpp.

References vpArray2D< double >::data, vpException::dimensionError, and vpArray2D< Type >::size().

◆ operator=() [2/2]

vpThetaUVector & vpThetaUVector::operator= ( double  v)

Initialize each element of the $\theta {\bf u}$ vector to the same angle value v.

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

Definition at line 249 of file vpThetaUVector.cpp.

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

◆ operator[]() [1/2]

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 127 of file vpRotationVector.h.

◆ operator[]() [2/2]

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 132 of file vpRotationVector.h.

◆ resize()

void vpArray2D< double >::resize ( const unsigned int  nrows,
const unsigned int  ncols,
const bool  flagNullify = true,
const bool  recopy_ = 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.
recopy_: if true, will perform an explicit recopy of the old data if needed and if flagNullify is set to false.
Examples:
testArray2D.cpp, testMatrix.cpp, testMatrixDeterminant.cpp, testMatrixInverse.cpp, testMatrixPseudoInverse.cpp, and testSvd.cpp.

Definition at line 171 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(), vpMatrix::operator=(), and vpMatrix::stack().

◆ save()

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 508 of file vpArray2D.h.

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

◆ saveYAML()

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<double> M(3,4);
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
data:
- [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
data:
- [0, 0, 0, 0]
- [0, 0, 0, 0]
- [0, 0, 0, 0]
See also
loadYAML()

Definition at line 597 of file vpArray2D.h.

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

◆ size()

unsigned int vpArray2D< double >::size ( ) const
inlineinherited

Return the number of elements of the 2D array.

Examples:
testColVector.cpp, testDisplacement.cpp, testMatrix.cpp, testPoseVector.cpp, testRobotViper650-frames.cpp, testRobotViper850-frames.cpp, testRowVector.cpp, testThread2.cpp, testTranslationVector.cpp, testTukeyEstimator.cpp, tutorial-ibvs-4pts-wireframe-robot-afma6.cpp, and tutorial-ibvs-4pts-wireframe-robot-viper.cpp.

Definition at line 158 of file vpArray2D.h.

References vpArray2D< Type >::rowNum.

Referenced by vpRowVector::insert(), vpColVector::insert(), vpColVector::operator*(), and vpMatrix::stack().

◆ sumSquare()

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 102 of file vpRotationVector.cpp.

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

◆ t()

vpRowVector vpRotationVector::t ( ) const
inherited

Return the transpose of the rotation vector.

Examples:
testViper650.cpp, and testViper850.cpp.

Definition at line 56 of file vpRotationVector.cpp.

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

Friends And Related Function Documentation

◆ operator*()

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.

◆ vpGEMM()

void vpGEMM ( const vpArray2D< double > &  A,
const vpArray2D< double > &  B,
const double &  alpha,
const vpArray2D< double > &  C,
const double &  beta,
vpArray2D< double > &  D,
const unsigned int &  ops = 0 
)
related

This function performs generalized matrix multiplication: D = alpha*op(A)*op(B) + beta*op(C), where op(X) is X or X^T. Operation on A, B and C matrices is described by enumeration vpGEMMmethod().

For example, to compute D = alpha*A^T*B^T+beta*C we need to call :

vpGEMM(A, B, alpha, C, beta, D, VP_GEMM_A_T + VP_GEMM_B_T);

If C is not used, vpGEMM must be called using an empty array null. Thus to compute D = alpha*A^T*B, we have to call:

vpGEMM(A, B, alpha, null, 0, D, VP_GEMM_B_T);
Exceptions
vpException::incorrectMatrixSizeErrorif the sizes of the matrices do not allow the operations.
Parameters
A: An array that could be a vpMatrix.
B: An array that could be a vpMatrix.
alpha: A scalar.
C: An array that could be a vpMatrix.
beta: A scalar.
D: The resulting array that could be a vpMatrix.
ops: A scalar describing operation applied on the matrices. Possible values are the one defined in vpGEMMmethod(): VP_GEMM_A_T, VP_GEMM_B_T, VP_GEMM_C_T.

Definition at line 393 of file vpGEMM.h.

References vpException::functionNotImplementedError.

◆ vpGEMMmethod

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

◆ colNum

unsigned int vpArray2D< double >::colNum
protectedinherited

Number of columns in the array.

Definition at line 76 of file vpArray2D.h.

Referenced by vpMatrix::AAt(), vpMatrix::AtA(), vpColVector::clear(), vpMatrix::detByLU(), vpMatrix::diag(), vpMatrix::eigenValues(), vpMatrix::expm(), vpMatrix::eye(), vpMatrix::getRow(), vpColVector::hadamard(), vpMatrix::hadamard(), vpMatrix::infinityNorm(), vpSubColVector::init(), vpSubRowVector::init(), vpSubMatrix::init(), vpRowVector::insert(), vpMatrix::insert(), vpMatrix::inverseByCholesky(), vpRotationMatrix::operator*(), vpRowVector::operator*(), vpMatrix::operator*(), vpRotationMatrix::operator*=(), vpRowVector::operator*=(), vpMatrix::operator*=(), vpRowVector::operator+(), vpRowVector::operator+=(), vpMatrix::operator+=(), vpRowVector::operator-(), vpRowVector::operator-=(), vpMatrix::operator-=(), vpRowVector::operator/(), vpMatrix::operator/(), vpRowVector::operator/=(), vpMatrix::operator/=(), vpMatrix::operator<<(), vpColVector::operator<<(), vpSubRowVector::operator=(), vpSubMatrix::operator=(), vpRowVector::operator=(), vpColVector::operator=(), vpMatrix::operator=(), vpRowVector::reshape(), vpMatrix::setIdentity(), vpMatrix::solveBySVD(), vpMatrix::stack(), vpRowVector::stack(), vpMatrix::stackColumns(), vpMatrix::stackRows(), vpRowVector::sum(), vpMatrix::sum(), vpRowVector::sumSquare(), vpMatrix::sumSquare(), vpRowVector::t(), vpMatrix::t(), vpMatrix::transpose(), vpColVector::vpColVector(), and vpMatrix::vpMatrix().

◆ data

double * vpArray2D< double >::data
inherited

Address of the first element of the data array.

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

Definition at line 84 of file vpArray2D.h.

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

◆ dsize

unsigned int vpArray2D< double >::dsize
protectedinherited

Current array size (rowNum * colNum)

Definition at line 80 of file vpArray2D.h.

Referenced by vpColVector::clear(), vpTranslationVector::euclideanNorm(), vpRowVector::euclideanNorm(), vpMatrix::euclideanNorm(), vpColVector::hadamard(), vpMatrix::hadamard(), vpSubColVector::init(), vpSubRowVector::init(), vpSubMatrix::init(), vpTranslationVector::operator*(), vpRotationVector::operator*(), vpTranslationVector::operator-(), vpTranslationVector::operator/(), vpRzyzVector::operator=(), vpRxyzVector::operator=(), vpRzyxVector::operator=(), operator=(), vpColVector::operator=(), vpMatrix::operator=(), vpRowVector::reshape(), vpColVector::reshape(), vpMatrix::stackRows(), vpRotationVector::t(), vpColVector::vpColVector(), and vpMatrix::vpMatrix().

◆ rowNum

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::detByLU(), vpMatrix::diag(), vpMatrix::eigenValues(), vpMatrix::expm(), vpColVector::extract(), vpMatrix::eye(), vpColVector::hadamard(), vpMatrix::hadamard(), vpColVector::infinityNorm(), vpMatrix::infinityNorm(), vpSubColVector::init(), vpSubRowVector::init(), vpSubMatrix::init(), vpMatrix::insert(), vpMatrix::inverseByCholesky(), 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(), vpColVector::sum(), vpMatrix::sum(), vpRotationVector::sumSquare(), vpTranslationVector::sumSquare(), vpColVector::sumSquare(), vpMatrix::sumSquare(), vpTranslationVector::t(), vpPoseVector::t(), vpColVector::t(), vpMatrix::t(), vpMatrix::transpose(), vpColVector::vpColVector(), and vpMatrix::vpMatrix().

◆ rowPtrs

double ** vpArray2D< double >::rowPtrs
protectedinherited

Address of the first element of each rows.

Definition at line 78 of file vpArray2D.h.

Referenced by vpMatrix::AAt(), vpColVector::clear(), vpMatrix::infinityNorm(), vpSubColVector::init(), vpSubRowVector::init(), vpSubMatrix::init(), vpRowVector::init(), vpColVector::init(), vpMatrix::init(), vpRotationMatrix::operator*(), vpForceTwistMatrix::operator*(), vpVelocityTwistMatrix::operator*(), vpHomogeneousMatrix::operator*(), vpMatrix::operator*(), vpRotationMatrix::operator*=(), vpMatrix::operator*=(), vpMatrix::operator+=(), vpMatrix::operator-=(), vpMatrix::operator/(), vpMatrix::operator/=(), vpMatrix::operator<<(), vpColVector::operator<<(), vpSubMatrix::operator=(), vpRotationMatrix::operator=(), vpHomogeneousMatrix::operator=(), vpForceTwistMatrix::operator=(), vpVelocityTwistMatrix::operator=(), vpRowVector::operator=(), vpColVector::operator=(), vpMatrix::operator=(), vpMatrix::stackColumns(), vpRowVector::sum(), vpMatrix::sum(), vpRotationVector::sumSquare(), vpTranslationVector::sumSquare(), vpRowVector::sumSquare(), vpMatrix::sumSquare(), vpMatrix::transpose(), vpColVector::vpColVector(), and vpMatrix::vpMatrix().