Visual Servoing Platform version 3.7.0
Loading...
Searching...
No Matches
vpRzyxVector Class Reference

#include <vpRzyxVector.h>

Inheritance diagram for vpRzyxVector:

Public Member Functions

 vpRzyxVector ()
 vpRzyxVector (const vpRzyxVector &)=default
virtual ~vpRzyxVector () VP_OVERRIDE=default
 vpRzyxVector (double phi, double theta, double psi)
VP_EXPLICIT vpRzyxVector (const vpRotationMatrix &R)
VP_EXPLICIT vpRzyxVector (const vpThetaUVector &tu)
VP_EXPLICIT vpRzyxVector (const vpColVector &rzyx)
VP_EXPLICIT vpRzyxVector (const std::vector< double > &rzyx)
vpRzyxVectorbuildFrom (const vpRotationMatrix &R)
vpRzyxVectorbuildFrom (const vpThetaUVector &R)
vpRzyxVectorbuildFrom (const vpColVector &rxyz)
vpRzyxVectorbuildFrom (const std::vector< double > &rxyz)
vpRzyxVectorbuildFrom (const double &phi, const double &theta, const double &psi)
vpRzyxVectoroperator= (const vpColVector &rzyx)
vpRzyxVectoroperator= (double x)
vpRzyxVectoroperator= (const vpRzyxVector &)=default
vpRzyxVectoroperator= (const std::initializer_list< double > &list)
Inherited functionalities from vpArray2D
unsigned int getCols () const
double getMaxValue () const
double getMinValue () const
unsigned int getRows () const
unsigned int size () const
void resize (unsigned int nrows, unsigned int ncols, bool flagNullify=true, bool recopy_=true)
void reshape (unsigned int nrows, unsigned int ncols)
void insert (const vpArray2D< double > &A, unsigned int r, unsigned int c)
bool operator!= (const vpArray2D< double > &A) const
vpArray2D< double > hadamard (const vpArray2D< double > &m) const

Static Public Member Functions

static vpArray2D< double > view (const vpArray2D< double > &A)

Public Attributes

double * data

(Note that these are not member symbols.)

vpColVector operator* (const double &x, const vpRotationVector &v)
bool operator== (const vpArray2D< double > &A) const
bool operator== (const vpArray2D< float > &A) const
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)
enum  vpGEMMmethod

Inherited functionalities from vpRotationVector

double & operator[] (unsigned int i)
const double & operator[] (unsigned int i) const
vpColVector operator* (double x) const
vpRotationVectoroperator<< (double val)
vpRotationVectoroperator, (double val)
double sumSquare () const
vpRowVector t () const
std::vector< double > toStdVector () const
unsigned int m_index

Inherited I/O from vpArray2D with Static Public Member Functions

unsigned int rowNum
unsigned int colNum
double ** rowPtrs
unsigned int dsize
bool isMemoryOwner
bool isRowPtrsOwner
static bool load (const std::string &filename, vpArray2D< double > &A, bool binary=false, char *header=nullptr)
static bool loadYAML (const std::string &filename, vpArray2D< double > &A, char *header=nullptr)
static bool save (const std::string &filename, const vpArray2D< double > &A, bool binary=false, const char *header="")
static bool saveYAML (const std::string &filename, const vpArray2D< double > &A, const char *header="")
static vpArray2D< double > conv2 (const vpArray2D< double > &M, const vpArray2D< double > &kernel, const std::string &mode)
static bool isFinite (const vpArray2D< double > &A)

Detailed Description

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

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

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

with

\‍[R_{z}(\varphi) = \left(
\begin{array}{ccc}
\cos \varphi & -\sin\varphi & 0\\
\sin\varphi &\cos \varphi& 0 \\
0 & 0 & 1
\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_{x}(\psi) = \left(
\begin{array}{ccc}
1 & 0 & 0 \\
0 &\cos \psi & -\sin\psi \\
0 &\sin \psi & \cos\psi \\
\end{array}
\right)
\‍]

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

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

The vpRzyxVector class is derived from vpRotationVector.

From the implementation point of view, it is nothing more than an array of three doubles with values in [rad].

You can set values [rad] accessing each element:

rzyx[0] = M_PI_4;
rzyx[1] = M_PI_2;
rzyx[2] = M_PI;

You can also initialize the vector using operator<<(double):

rzyx << M_PI_4, M_PI_2, M_PI;

Or you can also initialize the vector from a list of doubles if ViSP is build with c++11 enabled:

rzyx = {M_PI_4, M_PI_2, M_PI};

To get the values [rad] use:

double rz = rzyx[0];
double ry = rzyx[1];
double rx = rzyx[2];

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

#include <visp3/core/vpMath.h>
#include <visp3/core/vpRotationMatrix.h>
#include <visp3/core/vpRzyxVector.h>
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
int main()
{
// Initialise the Euler angles
rzyx[0] = vpMath::rad( 45.f); // phi angle in rad/s around z axis
rzyx[1] = vpMath::rad(-30.f); // theta angle in rad/s around y axis
rzyx[2] = vpMath::rad( 90.f); // psi angle in rad/s around x axis
// Construct a rotation matrix from the Euler angles
// Extract the Euler angles around z,y,x axis from a rotation matrix
rzyx.buildFrom(R);
// Print the extracted Euler angles. Values are the same than the
// one used for initialization
std::cout << rzyx;
// Since the rotation vector is 3 values column vector, the
// transpose operation produce a row vector.
vpRowVector rzyx_t = rzyx.t();
// Print the transpose row vector
std::cout << rzyx_t << std::endl;
}
static double rad(double deg)
Definition vpMath.h:129
Implementation of a rotation matrix and operations on such kind of matrices.
Implementation of row vector and the associated operations.
vpColVector t() const
vpRzyxVector & buildFrom(const vpRotationMatrix &R)
Examples
catchPoseRansac2.cpp, catchRotation.cpp, and testMatrixInitialization.cpp.

Definition at line 183 of file vpRzyxVector.h.

Constructor & Destructor Documentation

◆ vpRzyxVector() [1/7]

vpRzyxVector::vpRzyxVector ( )

Default constructor that initialize all the 3 angles to zero.

Definition at line 48 of file vpRzyxVector.cpp.

References vpRotationVector::vpRotationVector().

Referenced by buildFrom(), buildFrom(), buildFrom(), buildFrom(), buildFrom(), operator=(), operator=(), operator=(), operator=(), vpRzyxVector(), and ~vpRzyxVector().

◆ vpRzyxVector() [2/7]

vpRzyxVector::vpRzyxVector ( const vpRzyxVector & )
default

References vpRzyxVector().

◆ ~vpRzyxVector()

virtual vpRzyxVector::~vpRzyxVector ( )
virtualdefault

References vpRzyxVector().

◆ vpRzyxVector() [3/7]

vpRzyxVector::vpRzyxVector ( double phi,
double theta,
double psi )

Constructor from 3 angles (in radian).

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

Definition at line 56 of file vpRzyxVector.cpp.

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

◆ vpRzyxVector() [4/7]

vpRzyxVector::vpRzyxVector ( const vpRotationMatrix & R)

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

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

Definition at line 63 of file vpRzyxVector.cpp.

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

◆ vpRzyxVector() [5/7]

vpRzyxVector::vpRzyxVector ( const vpThetaUVector & tu)

Constructor that initialize $R_{zyx}=(\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 71 of file vpRzyxVector.cpp.

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

◆ vpRzyxVector() [6/7]

vpRzyxVector::vpRzyxVector ( const vpColVector & rzyx)

Copy constructor from a 3-dimension vector.

Definition at line 74 of file vpRzyxVector.cpp.

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

◆ vpRzyxVector() [7/7]

vpRzyxVector::vpRzyxVector ( const std::vector< double > & rzyx)

Copy constructor from a 3-dimension vector.

Definition at line 77 of file vpRzyxVector.cpp.

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

Member Function Documentation

◆ buildFrom() [1/5]

vpRzyxVector & vpRzyxVector::buildFrom ( const double & phi,
const double & theta,
const double & psi )

Construction from 3 angles (in radian).

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

Definition at line 143 of file vpRzyxVector.cpp.

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

◆ buildFrom() [2/5]

vpRzyxVector & vpRzyxVector::buildFrom ( const std::vector< double > & rzyx)

Construct a $R_{zyx}=(\varphi,\theta,\psi)$ Euler angles vector from a 3-dim vector.

Definition at line 174 of file vpRzyxVector.cpp.

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

◆ buildFrom() [3/5]

vpRzyxVector & vpRzyxVector::buildFrom ( const vpColVector & rzyx)

Construct a $R_{zyx}=(\varphi,\theta,\psi)$ Euler angles vector from a 3-dim vector.

Definition at line 157 of file vpRzyxVector.cpp.

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

◆ buildFrom() [4/5]

vpRzyxVector & vpRzyxVector::buildFrom ( const vpRotationMatrix & R)

Convert a rotation matrix into a $ R_{zyx}=(\varphi,\theta,\psi) $ Euler angles vector.

Source: R. Paul, Robot Manipulators: Mathematics, Programming, and Control. MIT Press, 1981, p. 71

Parameters
R: Rotation matrix used as input.
Returns
Euler angles vector $ R_{zyx}=(\varphi,\theta,\psi) $.
Examples
catchRotation.cpp.

Definition at line 88 of file vpRzyxVector.cpp.

References buildFrom(), and vpRzyxVector().

Referenced by buildFrom(), buildFrom(), vpRzyxVector(), vpRzyxVector(), vpRzyxVector(), vpRzyxVector(), and vpRzyxVector().

◆ buildFrom() [5/5]

vpRzyxVector & vpRzyxVector::buildFrom ( const vpThetaUVector & tu)

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

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

Definition at line 128 of file vpRzyxVector.cpp.

References buildFrom(), and vpRzyxVector().

◆ conv2()

vpArray2D< double > vpArray2D< double >::conv2 ( const vpArray2D< double > & M,
const vpArray2D< double > & kernel,
const std::string & mode )
staticinherited

Perform a 2D convolution similar to Matlab conv2 function: $ M \star kernel $.

Parameters
M: First matrix.
kernel: Second matrix.
mode: Convolution mode: "full" (default), "same", "valid".
Convolution mode: full, same, valid (image credit: Theano doc).
Note
This is a very basic implementation that does not use FFT.

Definition at line 1142 of file vpArray2D.h.

References vpArray2D().

◆ getCols()

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

Return the number of columns of the 2D array.

See also
getRows(), size()
Examples
catchLuminanceMapping.cpp, catchMatrixCholesky.cpp, catchPoseVector.cpp, perfMatrixMultiplication.cpp, perfMatrixTranspose.cpp, servoViper850Point2DArtVelocity-jointAvoidance-basic.cpp, testDisplacement.cpp, testMatrix.cpp, testMatrixConditionNumber.cpp, testMatrixConvolution.cpp, testMatrixDeterminant.cpp, testMatrixInitialization.cpp, testMatrixInverse.cpp, testMatrixPseudoInverse.cpp, and testSvd.cpp.

Definition at line 423 of file vpArray2D.h.

Referenced by vpMatrix::choleskyByEigen3(), vpMatrix::choleskyByLapack(), vpMatrix::choleskyByOpenCV(), vpMatrix::cond(), vpMatrix::cppPrint(), vpRowVector::cppPrint(), vpMatrix::csvPrint(), vpRowVector::csvPrint(), vpMatrix::detByLUEigen3(), vpMatrix::extract(), vpHomogeneousMatrix::getCol(), vpMatrix::getCol(), vpRotationMatrix::getCol(), vpMatrix::inducedL2Norm(), vpMatrix::inverseByLUEigen3(), vpMatrix::inverseByQRLapack(), vpRotationMatrix::isARotationMatrix(), vpMatrix::kernel(), vpMatrix::maplePrint(), vpRowVector::maplePrint(), vpMatrix::matlabPrint(), vpRowVector::matlabPrint(), vpMatrix::nullSpace(), vpMatrix::nullSpace(), vpRowVector::operator*(), vpRowVector::operator+(), vpRowVector::operator+=(), vpRowVector::operator-(), vpRowVector::operator-=(), vpForceTwistMatrix::print(), vpMatrix::print(), vpRowVector::print(), vpVelocityTwistMatrix::print(), vpMatrix::row(), vpMatrix::svdEigen3(), vpMatrix::svdLapack(), vpMatrix::svdOpenCV(), vpRowVector::vpRowVector(), and vpRowVector::vpRowVector().

◆ getMaxValue()

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

Return the array max value.

Examples
servoMomentImage.cpp.

Definition at line 425 of file vpArray2D.h.

◆ getMinValue()

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

Return the array min value.

Examples
servoMomentImage.cpp.

Definition at line 427 of file vpArray2D.h.

◆ getRows()

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

Return the number of rows of the 2D array.

See also
getCols(), size()
Examples
catchLuminanceMapping.cpp, catchMatrixCholesky.cpp, catchParticleFilter.cpp, catchPoseVector.cpp, perfMatrixMultiplication.cpp, perfMatrixTranspose.cpp, testDisplacement.cpp, testMatrix.cpp, testMatrixConditionNumber.cpp, testMatrixConvolution.cpp, testMatrixDeterminant.cpp, testMatrixInitialization.cpp, testMatrixInverse.cpp, testMatrixPseudoInverse.cpp, and testSvd.cpp.

Definition at line 433 of file vpArray2D.h.

Referenced by vpMatrix::choleskyByEigen3(), vpMatrix::choleskyByLapack(), vpMatrix::choleskyByOpenCV(), vpMatrix::column(), vpMatrix::cond(), vpColVector::cppPrint(), vpMatrix::cppPrint(), vpColVector::csvPrint(), vpMatrix::csvPrint(), vpMatrix::detByLUEigen3(), vpMatrix::extract(), vpHomogeneousMatrix::getCol(), vpMatrix::getCol(), vpRotationMatrix::getCol(), vpMatrix::inducedL2Norm(), vpMatrix::inverseByCholeskyLapack(), vpMatrix::inverseByLUEigen3(), vpMatrix::inverseByQRLapack(), vpRotationMatrix::isARotationMatrix(), vpMatrix::kernel(), vpColVector::maplePrint(), vpMatrix::maplePrint(), vpColVector::matlabPrint(), vpMatrix::matlabPrint(), vpMatrix::nullSpace(), vpMatrix::nullSpace(), vpColVector::operator*(), vpColVector::operator+(), vpColVector::operator+(), vpColVector::operator+=(), vpColVector::operator+=(), vpColVector::operator-(), vpColVector::operator-=(), vpColVector::operator-=(), vpColVector::print(), vpForceTwistMatrix::print(), vpMatrix::print(), vpPoseVector::print(), vpVelocityTwistMatrix::print(), vpMatrix::svdEigen3(), vpMatrix::svdLapack(), vpMatrix::svdOpenCV(), vpColVector::vpColVector(), and vpColVector::vpColVector().

◆ 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} $

Definition at line 732 of file vpArray2D.h.

References vpArray2D().

◆ insert()

void vpArray2D< double >::insert ( const vpArray2D< double > & A,
unsigned int r,
unsigned int c )
inlineinherited

Insert array A at the given position in the current array.

Warning
Throw vpException::dimensionError if the dimensions of the matrices do not allow the operation.
Parameters
A: The array to insert.
r: The index of the row to begin to insert data.
c: The index of the column to begin to insert data.

Definition at line 586 of file vpArray2D.h.

◆ isFinite()

bool vpArray2D< double >::isFinite ( const vpArray2D< double > & A)
inlinestaticinherited

Definition at line 1188 of file vpArray2D.h.

◆ load()

bool vpArray2D< double >::load ( const std::string & filename,
vpArray2D< double > & A,
bool binary = false,
char * header = nullptr )
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 760 of file vpArray2D.h.

◆ loadYAML()

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

◆ operator!=()

bool operator!= ( const vpArray2D< double > & A) const
inherited

Not equal to comparison operator of a 2D array.

Definition at line 612 of file vpArray2D.h.

References vpArray2D().

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

References vpArray2D< double >::dsize.

◆ operator,()

vpRotationVector & vpRotationVector::operator, ( double val)
inherited

Set vector second and third element values.

Parameters
val: Value of the vector element [rad].
Returns
An updated vector.

The following example shows how to initialize a $\theta_u$ vector from a list of 3 values [rad].

#include <visp3/core/vpThetaUVector.h>
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
int main()
{
tu << 0, M_PI_2, M_PI;
std::cout << "tu: " << tu.t() << std::endl;
}
Implementation of a rotation vector as axis-angle minimal representation.

It produces the following printings:

tu: 0 1.570796327 3.141592654
See also
operator<<()

Definition at line 159 of file vpRotationVector.cpp.

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

◆ operator<<()

vpRotationVector & vpRotationVector::operator<< ( double val)
inherited

Set vector first element value.

Parameters
val: Value of the vector first element [rad].
Returns
An updated vector.

The following example shows how to initialize a $\theta_u$ vector from a list of 3 values [rad].

#include <visp3/core/vpThetaUVector.h>
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
int main()
{
tu << 0, M_PI_2, M_PI;
std::cout << "tu: " << tu.t() << std::endl;
}

It produces the following printings:

tu: 0 1.570796327 3.141592654
See also
operator,()

Definition at line 125 of file vpRotationVector.cpp.

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

◆ operator=() [1/4]

vpRzyxVector & vpRzyxVector::operator= ( const std::initializer_list< double > & list)

Set vector from a list of 3 double angle values in radians.

#include <visp3/core/vpRzyxVector.cpp>
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
int main()
{
vpRzyxVector rzyx = {M_PI, 0, M_PI_2};
std::cout << "rzyx: " << rzyx.t() << std::endl;
}
vpRowVector t() const

It produces the following printings:

zyx: 3.141592654 0 1.570796327
See also
operator<<()

Definition at line 282 of file vpRzyxVector.cpp.

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

◆ operator=() [2/4]

vpRzyxVector & vpRzyxVector::operator= ( const vpColVector & rzyx)

Copy operator that initializes a $R_{zyx}=(\varphi,\theta,\psi)$ Euler angles vector from a 3-dimension column vector.

Parameters
rzyx: 3-dimension vector containing the values of the rotation vector.
#include <visp3/core/vpRzyxVector.h>
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
int main()
{
v[0] = 0.1;
v[1] = 0.2;
v[2] = 0.3;
rzyx = v;
// rzyx is now equal to v : 0.1, 0.2, 0.3
}
Implementation of column vector and the associated operations.

Definition at line 246 of file vpRzyxVector.cpp.

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

◆ operator=() [3/4]

vpRzyxVector & vpRzyxVector::operator= ( const vpRzyxVector & )
default

References vpRzyxVector().

◆ operator=() [4/4]

vpRzyxVector & vpRzyxVector::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/vpRzyxVector.h>
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
int main()
{
// Initialise the rotation vector
v = vpMath::rad( 45.f); // All the 3 angles are set to 45 degrees
}

Definition at line 211 of file vpRzyxVector.cpp.

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

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

References vpArray2D< double >::data.

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

References vpArray2D< double >::data.

◆ reshape()

void vpArray2D< double >::reshape ( unsigned int nrows,
unsigned int ncols )
inlineinherited
Examples
testMatrixInitialization.cpp.

Definition at line 545 of file vpArray2D.h.

◆ resize()

void vpArray2D< double >::resize ( unsigned int nrows,
unsigned int ncols,
bool flagNullify = true,
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.
Examples
catchParticleFilter.cpp, perfMatrixMultiplication.cpp, perfMatrixTranspose.cpp, testMatrix.cpp, testMatrixConditionNumber.cpp, testMatrixDeterminant.cpp, testMatrixInverse.cpp, testMatrixPseudoInverse.cpp, and testSvd.cpp.

Definition at line 448 of file vpArray2D.h.

Referenced by vpMatrix::diag(), vpMatrix::eye(), vpMatrix::init(), vpMatrix::operator,(), vpMatrix::operator<<(), vpMatrix::operator=(), vpMatrix::operator=(), vpMatrix::operator=(), vpMatrix::operator=(), vpMatrix::operator=(), vpMatrix::operator=(), vpMatrix::operator=(), vpMatrix::operator=(), vpMatrix::operator=(), vpMatrix::operator=(), vpMatrix::operator=(), vpMatrix::stack(), vpMatrix::stack(), vpMatrix::stack(), vpMatrix::svdEigen3(), and vpMatrix::svdOpenCV().

◆ save()

bool vpArray2D< double >::save ( const std::string & filename,
const vpArray2D< double > & A,
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 965 of file vpArray2D.h.

◆ saveYAML()

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");
static bool saveYAML(const std::string &filename, const vpArray2D< Type > &A, const char *header="")
Definition vpArray2D.h:1061

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()
Examples
visp-acquire-franka-calib-data.cpp, and visp-acquire-universal-robots-calib-data.cpp.

Definition at line 1061 of file vpArray2D.h.

◆ size()

◆ 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}\‍]

.
Examples
servoAfma6AprilTagPBVS.cpp, servoAfma6MegaposePBVS.cpp, servoFrankaPBVS.cpp, and servoUniversalRobotsPBVS.cpp.

Definition at line 178 of file vpRotationVector.cpp.

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

◆ t()

◆ toStdVector()

std::vector< double > vpRotationVector::toStdVector ( ) const
inherited

Converts the vpRotationVector to a std::vector.

Returns
The corresponding std::vector<double>.

Definition at line 67 of file vpRotationVector.cpp.

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

◆ view()

vpArray2D< double > vpArray2D< double >::view ( const vpArray2D< double > & A)
inlinestaticinherited

Creates a view of the Matrix A. A view shares the same underlying memory as the original array. It can be written into, modifying the original data. However, the array cannot be resized.

When you use this method, it is your responsibility to ensure that the lifespan of the view does not exceed the lifespan of the original array.

Parameters
Athe array to view
Returns
vpArray2D<T>

Definition at line 324 of file vpArray2D.h.

◆ operator*()

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

Allows to multiply a scalar by rotaion vector.

Definition at line 194 of file vpRotationVector.cpp.

References vpRotationVector().

◆ operator==() [1/2]

bool operator== ( const vpArray2D< double > & A) const
related

◆ operator==() [2/2]

bool operator== ( const vpArray2D< float > & A) const
related

◆ 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);
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)
Definition vpGEMM.h:414

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 414 of file vpGEMM.h.

References vpException::functionNotImplementedError, and vpArray2D().

◆ 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 53 of file vpGEMM.h.

Member Data Documentation

◆ colNum

unsigned int vpArray2D< double >::colNum
protectedinherited

Number of columns in the array.

Definition at line 1203 of file vpArray2D.h.

Referenced by vpMatrix::AAt(), vpMatrix::AtA(), vpMatrix::choleskyByLapack(), vpMatrix::choleskyByOpenCV(), vpColVector::clear(), vpMatrix::clear(), vpRowVector::clear(), vpMatrix::dampedInverse(), vpMatrix::detByLU(), vpMatrix::detByLUEigen3(), vpMatrix::detByLULapack(), vpMatrix::detByLUOpenCV(), vpMatrix::diag(), vpMatrix::eigenValues(), vpMatrix::eigenValues(), vpMatrix::expm(), vpRowVector::extract(), vpMatrix::eye(), vpMatrix::getDiag(), vpMatrix::getRow(), vpMatrix::getRow(), vpColVector::hadamard(), vpMatrix::hadamard(), vpRowVector::hadamard(), vpMatrix::infinityNorm(), vpSubColVector::init(), vpSubMatrix::init(), vpSubRowVector::init(), vpMatrix::insert(), vpRowVector::insert(), vpMatrix::inverseByCholeskyLapack(), vpMatrix::inverseByCholeskyOpenCV(), vpMatrix::inverseByLU(), vpMatrix::inverseByLUEigen3(), vpMatrix::inverseByLULapack(), vpMatrix::inverseByLUOpenCV(), vpMatrix::inverseByQRLapack(), vpMatrix::inverseTriangular(), vpMatrix::operator*(), vpMatrix::operator*(), vpMatrix::operator*(), vpMatrix::operator*(), vpMatrix::operator*(), vpMatrix::operator*(), vpRotationMatrix::operator*(), vpRotationMatrix::operator*(), vpRowVector::operator*(), vpRowVector::operator*(), vpRowVector::operator*(), vpMatrix::operator*=(), vpRotationMatrix::operator*=(), vpRowVector::operator*=(), vpRowVector::operator+(), vpMatrix::operator+=(), vpMatrix::operator+=(), vpRowVector::operator+=(), vpMatrix::operator,(), vpRowVector::operator,(), vpRowVector::operator-(), vpRowVector::operator-(), vpMatrix::operator-=(), vpMatrix::operator-=(), vpRowVector::operator-=(), vpMatrix::operator/(), vpRowVector::operator/(), vpMatrix::operator/=(), vpRowVector::operator/=(), vpColVector::operator<<(), vpMatrix::operator<<(), vpMatrix::operator=(), vpRowVector::operator=(), vpRowVector::operator=(), vpRowVector::operator=(), vpSubMatrix::operator=(), vpSubMatrix::operator=(), vpSubMatrix::operator=(), vpSubRowVector::operator=(), vpSubRowVector::operator=(), vpSubRowVector::operator=(), operator==(), operator==(), vpColVector::operator==(), vpRowVector::operator==(), vpMatrix::qr(), vpRowVector::reshape(), vpMatrix::setIdentity(), vpMatrix::solveByQR(), vpMatrix::solveByQR(), vpMatrix::solveBySVD(), vpMatrix::stack(), vpMatrix::stack(), vpMatrix::stack(), vpRowVector::stack(), vpMatrix::stackColumns(), vpMatrix::stackColumns(), vpMatrix::stackRows(), vpMatrix::stackRows(), vpMatrix::sum(), vpRowVector::sum(), vpMatrix::sumSquare(), vpRowVector::sumSquare(), vpMatrix::svdEigen3(), vpMatrix::svdLapack(), vpRowVector::t(), and vpMatrix::transpose().

◆ data

double* vpArray2D< double >::data
inherited

Address of the first element of the data array.

Examples
catchQuaternion.cpp, catchRotation.cpp, perfMatrixMultiplication.cpp, testDisplacement.cpp, testMatrix.cpp, testMatrixInitialization.cpp, testUniversalRobotsGetData.cpp, and tutorial-bridge-opencv-matrix.cpp.

Definition at line 149 of file vpArray2D.h.

Referenced by vpMatrix::AAt(), vpMatrix::AtA(), vpHomogeneousMatrix::buildFrom(), vpHomogeneousMatrix::buildFrom(), vpQuaternionVector::buildFrom(), vpQuaternionVector::buildFrom(), vpRxyzVector::buildFrom(), vpRxyzVector::buildFrom(), vpRxyzVector::buildFrom(), vpRzyxVector::buildFrom(), vpRzyxVector::buildFrom(), vpRzyxVector::buildFrom(), vpRzyzVector::buildFrom(), vpRzyzVector::buildFrom(), vpRzyzVector::buildFrom(), vpThetaUVector::buildFrom(), vpThetaUVector::buildFrom(), vpThetaUVector::buildFrom(), vpThetaUVector::buildFrom(), vpThetaUVector::buildFrom(), vpSubColVector::checkParentStatus(), vpSubMatrix::checkParentStatus(), vpSubRowVector::checkParentStatus(), vpColVector::clear(), vpMatrix::clear(), vpRowVector::clear(), vpHomogeneousMatrix::convert(), vpHomogeneousMatrix::convert(), vpMatrix::detByLUEigen3(), vpMatrix::detByLUOpenCV(), vpMatrix::expm(), vpThetaUVector::extract(), vpMatrix::frobeniusNorm(), vpMatrix::getRow(), vpThetaUVector::getTheta(), vpThetaUVector::getU(), vpColVector::hadamard(), vpMatrix::hadamard(), vpRowVector::hadamard(), vpSubColVector::init(), vpSubMatrix::init(), vpSubRowVector::init(), vpColVector::insert(), vpMatrix::insert(), vpMatrix::inverseByCholeskyOpenCV(), vpMatrix::inverseByLUEigen3(), vpMatrix::inverseByLUOpenCV(), vpHomogeneousMatrix::isValid(), vpColVector::operator*(), vpHomography::operator*(), vpMatrix::operator*(), vpMatrix::operator*(), vpRowVector::operator*(), vpRowVector::operator*(), vpTranslationVector::operator*(), vpColVector::operator,(), vpHomogeneousMatrix::operator,(), vpRotationMatrix::operator,(), vpRotationVector::operator,(), vpRowVector::operator,(), vpTranslationVector::operator,(), vpColVector::operator-(), vpRowVector::operator-(), vpTranslationVector::operator-(), vpColVector::operator/(), vpHomography::operator/(), vpRowVector::operator/(), vpTranslationVector::operator/(), vpHomography::operator/=(), vpColVector::operator<<(), vpHomogeneousMatrix::operator<<(), vpRotationMatrix::operator<<(), vpRotationVector::operator<<(), vpRowVector::operator<<(), vpTranslationVector::operator<<(), vpColVector::operator=(), vpColVector::operator=(), vpColVector::operator=(), vpColVector::operator=(), vpColVector::operator=(), vpColVector::operator=(), vpColVector::operator=(), vpMatrix::operator=(), vpMatrix::operator=(), vpMatrix::operator=(), vpMatrix::operator=(), vpMatrix::operator=(), vpMatrix::operator=(), vpMatrix::operator=(), vpMatrix::operator=(), vpMatrix::operator=(), vpMatrix::operator=(), vpMatrix::operator=(), vpQuaternionVector::operator=(), vpQuaternionVector::operator=(), vpRotationMatrix::operator=(), vpRotationVector::operator=(), vpRowVector::operator=(), vpRowVector::operator=(), vpRowVector::operator=(), vpRxyzVector::operator=(), vpRxyzVector::operator=(), vpRxyzVector::operator=(), vpRzyxVector::operator=(), vpRzyxVector::operator=(), vpRzyxVector::operator=(), vpRzyzVector::operator=(), vpRzyzVector::operator=(), vpRzyzVector::operator=(), vpSubColVector::operator=(), vpSubColVector::operator=(), vpSubColVector::operator=(), vpSubColVector::operator=(), vpSubColVector::operator=(), vpSubColVector::operator=(), vpSubColVector::operator=(), vpSubRowVector::operator=(), vpSubRowVector::operator=(), vpSubRowVector::operator=(), vpSubRowVector::operator=(), vpThetaUVector::operator=(), vpThetaUVector::operator=(), vpThetaUVector::operator=(), vpTranslationVector::operator=(), vpTranslationVector::operator=(), vpTranslationVector::operator=(), vpTranslationVector::operator=(), operator==(), operator==(), vpColVector::operator==(), vpColVector::operator==(), vpRowVector::operator==(), vpColVector::operator[](), vpColVector::operator[](), vpPoseVector::operator[](), vpPoseVector::operator[](), vpRotationVector::operator[](), vpRotationVector::operator[](), vpRowVector::operator[](), vpRowVector::operator[](), vpTranslationVector::operator[](), vpTranslationVector::operator[](), vpRotationMatrix::orthogonalize(), vpMatrix::qr(), vpColVector::reshape(), vpRowVector::reshape(), vpQuaternionVector::set(), vpMatrix::stack(), vpMatrix::stack(), vpMatrix::stackRows(), vpColVector::sum(), vpColVector::sumSquare(), vpMatrix::svdEigen3(), vpMatrix::svdLapack(), vpMatrix::svdOpenCV(), vpColVector::t(), vpPoseVector::t(), vpRotationVector::t(), vpRowVector::t(), vpTranslationVector::t(), vpColVector::toStdVector(), vpPoseVector::toStdVector(), vpRotationVector::toStdVector(), vpRowVector::toStdVector(), vpMatrix::transpose(), vpColVector::view(), vpMatrix::view(), vpColVector::vpColVector(), vpHomogeneousMatrix::vpHomogeneousMatrix(), vpQuaternionVector::w(), vpQuaternionVector::w(), vpQuaternionVector::x(), vpQuaternionVector::x(), vpQuaternionVector::y(), vpQuaternionVector::y(), vpQuaternionVector::z(), vpQuaternionVector::z(), vpSubColVector::~vpSubColVector(), vpSubMatrix::~vpSubMatrix(), and vpSubRowVector::~vpSubRowVector().

◆ dsize

◆ isMemoryOwner

bool vpArray2D< double >::isMemoryOwner
protectedinherited

Whether this array owns the memory it points to.

Definition at line 1209 of file vpArray2D.h.

Referenced by vpColVector::clear(), and vpRowVector::clear().

◆ isRowPtrsOwner

bool vpArray2D< double >::isRowPtrsOwner
protectedinherited

Whether this array owns the row pointers.

Definition at line 1211 of file vpArray2D.h.

◆ m_index

unsigned int vpRotationVector::m_index
protectedinherited

◆ rowNum

unsigned int vpArray2D< double >::rowNum
protectedinherited

Number of rows in the array.

Definition at line 1201 of file vpArray2D.h.

Referenced by vpMatrix::AAt(), vpMatrix::AtA(), vpMatrix::choleskyByLapack(), vpMatrix::choleskyByOpenCV(), vpColVector::clear(), vpMatrix::clear(), vpRowVector::clear(), vpMatrix::detByLU(), vpMatrix::detByLUEigen3(), vpMatrix::detByLULapack(), vpMatrix::detByLUOpenCV(), vpMatrix::diag(), vpMatrix::eigenValues(), vpMatrix::eigenValues(), vpMatrix::expm(), vpColVector::extract(), vpMatrix::eye(), vpMatrix::getCol(), vpMatrix::getDiag(), vpMatrix::getRow(), vpColVector::hadamard(), vpMatrix::hadamard(), vpRowVector::hadamard(), vpColVector::infinityNorm(), vpMatrix::infinityNorm(), vpSubColVector::init(), vpSubMatrix::init(), vpSubRowVector::init(), vpMatrix::insert(), vpMatrix::inverseByCholeskyLapack(), vpMatrix::inverseByCholeskyOpenCV(), vpMatrix::inverseByLU(), vpMatrix::inverseByLUEigen3(), vpMatrix::inverseByLULapack(), vpMatrix::inverseByLUOpenCV(), vpMatrix::inverseByQRLapack(), vpMatrix::inverseTriangular(), vpColVector::operator*(), vpColVector::operator*(), vpColVector::operator*(), vpColVector::operator*(), vpHomogeneousMatrix::operator*(), vpMatrix::operator*(), vpMatrix::operator*(), vpMatrix::operator*(), vpMatrix::operator*(), vpMatrix::operator*(), vpMatrix::operator*(), vpRotationMatrix::operator*(), vpRotationMatrix::operator*(), vpTranslationVector::operator*(), vpColVector::operator*=(), vpMatrix::operator*=(), vpRotationMatrix::operator*=(), vpTranslationVector::operator*=(), vpColVector::operator+(), vpColVector::operator+=(), vpColVector::operator+=(), vpMatrix::operator+=(), vpMatrix::operator+=(), vpColVector::operator,(), vpColVector::operator-(), vpColVector::operator-(), vpColVector::operator-=(), vpColVector::operator-=(), vpMatrix::operator-=(), vpMatrix::operator-=(), vpColVector::operator/(), vpMatrix::operator/(), vpColVector::operator/=(), vpMatrix::operator/=(), vpTranslationVector::operator/=(), vpColVector::operator<<(), vpMatrix::operator<<(), vpColVector::operator=(), vpColVector::operator=(), vpColVector::operator=(), vpColVector::operator=(), vpColVector::operator=(), vpColVector::operator=(), vpMatrix::operator=(), vpMatrix::operator=(), vpRowVector::operator=(), vpSubColVector::operator=(), vpSubColVector::operator=(), vpSubColVector::operator=(), vpSubColVector::operator=(), vpSubColVector::operator=(), vpSubColVector::operator=(), vpSubColVector::operator=(), vpSubMatrix::operator=(), vpSubMatrix::operator=(), vpSubMatrix::operator=(), vpSubRowVector::operator=(), vpSubRowVector::operator=(), vpSubRowVector::operator=(), vpSubRowVector::operator=(), vpTranslationVector::operator=(), vpTranslationVector::operator=(), operator==(), operator==(), vpColVector::operator==(), vpColVector::operator==(), vpRowVector::operator==(), vpMatrix::qr(), vpColVector::reshape(), vpMatrix::setIdentity(), vpColVector::stack(), vpMatrix::stack(), vpMatrix::stack(), vpMatrix::stack(), vpMatrix::stackColumns(), vpMatrix::stackColumns(), vpMatrix::stackRows(), vpMatrix::stackRows(), vpColVector::sum(), vpMatrix::sum(), vpColVector::sumSquare(), vpMatrix::sumSquare(), vpRotationVector::sumSquare(), vpTranslationVector::sumSquare(), vpMatrix::svdEigen3(), vpMatrix::svdLapack(), vpColVector::t(), vpPoseVector::t(), vpTranslationVector::t(), and vpMatrix::transpose().

◆ rowPtrs

double** vpArray2D< double >::rowPtrs
protectedinherited

Address of the first element of each rows.

Definition at line 1205 of file vpArray2D.h.

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