NumCpp  2.12.1
A Templatized Header Only C++ Implementation of the Python NumPy Library
nc::rotations::DCM Class Reference

Factory methods for generating direction cosine matrices and vectors. More...

#include <DCM.hpp>

Static Public Member Functions

static NdArray< double > eulerAngles (const NdArray< double > &angles)
 
static NdArray< double > eulerAngles (double roll, double pitch, double yaw)
 
static NdArray< double > eulerAxisAngle (const NdArray< double > &inAxis, double inAngle)
 
static NdArray< double > eulerAxisAngle (const Vec3 &inAxis, double inAngle)
 
static bool isValid (const NdArray< double > &inArray)
 
static double pitch (const NdArray< double > &dcm)
 
static double roll (const NdArray< double > &dcm)
 
static NdArray< double > xRotation (double inAngle)
 
static double yaw (const NdArray< double > &dcm)
 
static NdArray< double > yRotation (double inAngle)
 
static NdArray< double > zRotation (double inAngle)
 

Detailed Description

Factory methods for generating direction cosine matrices and vectors.

Member Function Documentation

◆ eulerAngles() [1/2]

static NdArray< double > nc::rotations::DCM::eulerAngles ( const NdArray< double > &  angles)
inlinestatic

returns a direction cosine matrix that rotates according to the input euler angles

Parameters
angleseuler roll, pitch, angles
Returns
NdArray

◆ eulerAngles() [2/2]

static NdArray< double > nc::rotations::DCM::eulerAngles ( double  roll,
double  pitch,
double  yaw 
)
inlinestatic

returns a direction cosine matrix that rotates according to the input euler angles

Parameters
rolleuler roll angle in radians
pitcheuler pitch angle in radians
yaweuler yaw angle in radians
Returns
NdArray

◆ eulerAxisAngle() [1/2]

static NdArray< double > nc::rotations::DCM::eulerAxisAngle ( const NdArray< double > &  inAxis,
double  inAngle 
)
inlinestatic

returns a direction cosine matrix that rotates about the input axis by the input angle

Parameters
inAxiseuler axis cartesian vector with x,y,z components
inAngleeuler angle in radians
Returns
NdArray

◆ eulerAxisAngle() [2/2]

static NdArray< double > nc::rotations::DCM::eulerAxisAngle ( const Vec3 inAxis,
double  inAngle 
)
inlinestatic

returns a direction cosine matrix that rotates about the input axis by the input angle

Parameters
inAxiseuler axis cartesian vector with x,y,z components
inAngleeuler angle in radians
Returns
NdArray

◆ isValid()

static bool nc::rotations::DCM::isValid ( const NdArray< double > &  inArray)
inlinestatic

returns whether the input array is a direction cosine matrix

Parameters
inArray
Returns
bool

◆ pitch()

static double nc::rotations::DCM::pitch ( const NdArray< double > &  dcm)
inlinestatic

The euler pitch angle in radians

Parameters
dcma valid direction cosine matrix
Returns
euler pitch angle in radians

◆ roll()

static double nc::rotations::DCM::roll ( const NdArray< double > &  dcm)
inlinestatic

The euler roll angle in radians

Parameters
dcma valid direction cosine matrix
Returns
euler roll angle in radians

◆ xRotation()

static NdArray< double > nc::rotations::DCM::xRotation ( double  inAngle)
inlinestatic

returns a direction cosine matrix that rotates about the x axis by the input angle

Parameters
inAngle(in radians)
Returns
NdArray<double>

◆ yaw()

static double nc::rotations::DCM::yaw ( const NdArray< double > &  dcm)
inlinestatic

The euler yaw angle in radians

Parameters
dcma valid direction cosine matrix
Returns
euler yaw angle in radians

◆ yRotation()

static NdArray< double > nc::rotations::DCM::yRotation ( double  inAngle)
inlinestatic

returns a direction cosine matrix that rotates about the x axis by the input angle

Parameters
inAngle(in radians)
Returns
NdArray<double>

◆ zRotation()

static NdArray< double > nc::rotations::DCM::zRotation ( double  inAngle)
inlinestatic

returns a direction cosine matrix that rotates about the x axis by the input angle

Parameters
inAngle(in radians)
Returns
NdArray<double>

The documentation for this class was generated from the following file: