ODIN
Public Member Functions | List of all members
RotMatrix Class Reference

Rotation Matrix. More...

#include <geometry.h>

Inheritance diagram for RotMatrix:
Inheritance graph
[legend]

Public Member Functions

 RotMatrix (const STD_string &object_label="unnamedRotMatrix")
 
 RotMatrix (const RotMatrix &sct)
 
dvectoroperator[] (unsigned int index)
 
const dvectoroperator[] (unsigned int index) const
 
RotMatrixoperator= (const RotMatrix &sct)
 
bool operator== (const RotMatrix &srm) const
 
dvector operator* (const dvector &vec) const
 
RotMatrix operator* (const RotMatrix &matrix) const
 
 operator farray () const
 
RotMatrixset_inplane_rotation (float phi)
 
STD_string print () const
 
- Public Member Functions inherited from Labeled
 Labeled (const STD_string &label="unnamed")
 
Labeledset_label (const STD_string &label)
 
const STD_string & get_label () const
 
Labeledoperator= (const Labeled &l)
 

Detailed Description

Rotation Matrix.

This class represents 3 by 3 rotation matrix

Definition at line 67 of file geometry.h.

Constructor & Destructor Documentation

◆ RotMatrix() [1/2]

RotMatrix::RotMatrix ( const STD_string &  object_label = "unnamedRotMatrix")

default constructor for a 3 by 3 rotation matrix

◆ RotMatrix() [2/2]

RotMatrix::RotMatrix ( const RotMatrix sct)

constructs a rotation matrix from an existing rotation matrix

Member Function Documentation

◆ operator farray()

RotMatrix::operator farray ( ) const

Returns the matrix as a 2-dim farray

◆ operator*() [1/2]

dvector RotMatrix::operator* ( const dvector vec) const

returns the product this * vec

◆ operator*() [2/2]

RotMatrix RotMatrix::operator* ( const RotMatrix matrix) const

returns the product this * matrix

◆ operator=()

RotMatrix& RotMatrix::operator= ( const RotMatrix sct)

assignment operator

◆ operator==()

bool RotMatrix::operator== ( const RotMatrix srm) const

returns true if srm is element-wise equal to this. Two elements are considered equal if their difference does not exceed GEO_CHECK_LIMIT.

◆ operator[]() [1/2]

dvector& RotMatrix::operator[] ( unsigned int  index)
inline

returns a row of rotation matrix

Definition at line 83 of file geometry.h.

◆ operator[]() [2/2]

const dvector& RotMatrix::operator[] ( unsigned int  index) const
inline

returns a row of rotation matrix

Definition at line 88 of file geometry.h.

◆ print()

STD_string RotMatrix::print ( ) const

returns a string describing the rotation matrix

◆ set_inplane_rotation()

RotMatrix& RotMatrix::set_inplane_rotation ( float  phi)

Create anti-clockwise in-plane rotation matrix with angle 'phi' (in rad).


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