Orfeo Toolbox  3.16
Public Types | Public Member Functions | Static Public Attributes | Private Attributes | List of all members
itk::Matrix< T, NRows, NColumns > Class Template Reference
Data Representation Objects

A templated class holding a M x N size Matrix This class contains a vnl_matrix_fixed in order to make all the vnl mathematical methods available. More...

#include <itkMatrix.h>

+ Inheritance diagram for itk::Matrix< T, NRows, NColumns >:

Public Types

typedef T ComponentType
 
typedef vnl_matrix_fixed< T,
NRows, NColumns > 		InternalMatrixType
 
typedef Matrix Self
 
typedef T ValueType
 

Public Member Functions

 Matrix (const vnl_matrix< T > &matrix)
 
 Matrix (const InternalMatrixType &matrix)
 
 Matrix ()
 
 Matrix (const Self &matrix)
 
void Fill (const T &value)
 
vnl_matrix_fixed< T, NColumns,
NRows > 		GetInverse (void) const
 
vnl_matrix_fixed< T, NColumns,
NRows > 		GetTranspose (void) const
 
InternalMatrixType & GetVnlMatrix (void)
 
const InternalMatrixType & GetVnlMatrix (void) const
 
bool operator!= (const Self &matrix) const
 
T & operator() (unsigned int row, unsigned int col)
 
const T & operator() (unsigned int row, unsigned int col) const
 
Vector< T, NRows > operator* (const Vector< T, NColumns > &vector) const
 
Point< T, NRows > operator* (const Point< T, NColumns > &vector) const
 
CovariantVector< T, NRows > operator* (const CovariantVector< T, NColumns > &vector) const
 
Self operator* (const Self &matrix) const
 
vnl_matrix< T > operator* (const vnl_matrix< T > &matrix) const
 
vnl_vector< T > operator* (const vnl_vector< T > &matrix) const
 
Self operator* (const T &value)
 
void operator*= (const Self &matrix)
 
void operator*= (const vnl_matrix< T > &matrix)
 
void operator*= (const T &value)
 
Self operator+ (const Self &matrix) const
 
const Self & operator+= (const Self &matrix)
 
Self operator- (const Self &matrix) const
 
const Self & operator-= (const Self &matrix)
 
Self operator/ (const T &value)
 
void operator/= (const T &value)
 
const Self & operator= (const vnl_matrix< T > &matrix)
 
const Self & operator= (const InternalMatrixType &matrix)
 
const Self & operator= (const Self &matrix)
 
bool operator== (const Self &matrix) const
 
T * operator[] (unsigned int i)
 
const T * operator[] (unsigned int i) const
 
void SetIdentity (void)
 

Static Public Attributes

static const unsigned int ColumnDimensions = NColumns
 
static const unsigned int RowDimensions = NRows
 

Private Attributes

InternalMatrixType m_Matrix
 

Detailed Description

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
class itk::Matrix< T, NRows, NColumns >

A templated class holding a M x N size Matrix This class contains a vnl_matrix_fixed in order to make all the vnl mathematical methods available.

Definition at line 42 of file itkMatrix.h.

Member Typedef Documentation

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
typedef T itk::Matrix< T, NRows, NColumns >::ComponentType

Definition at line 50 of file itkMatrix.h.

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
typedef vnl_matrix_fixed<T,NRows,NColumns> itk::Matrix< T, NRows, NColumns >::InternalMatrixType

Internal matrix type

Definition at line 57 of file itkMatrix.h.

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
typedef Matrix itk::Matrix< T, NRows, NColumns >::Self

Standard class typedefs.

Definition at line 46 of file itkMatrix.h.

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
typedef T itk::Matrix< T, NRows, NColumns >::ValueType

Component value type

Definition at line 49 of file itkMatrix.h.

Constructor & Destructor Documentation

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
itk::Matrix< T, NRows, NColumns >::Matrix ( const vnl_matrix< T > &  matrix)
inline

For every operator=, there should be an equivalent copy constructor.

Definition at line 160 of file itkMatrix.h.

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
itk::Matrix< T, NRows, NColumns >::Matrix ( const InternalMatrixType &  matrix)
inlineexplicit

For every operator=, there should be an equivalent copy constructor.

Definition at line 195 of file itkMatrix.h.

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
itk::Matrix< T, NRows, NColumns >::Matrix ( )
inline

Default constructor.

Definition at line 224 of file itkMatrix.h.

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
itk::Matrix< T, NRows, NColumns >::Matrix ( const Self &  matrix)
inline

Copy constructor.

Definition at line 227 of file itkMatrix.h.

Member Function Documentation

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
void itk::Matrix< T, NRows, NColumns >::Fill ( const T &  value)
inline

Fill the matrix with a value.

Definition at line 149 of file itkMatrix.h.

Referenced by itk::LandmarkBasedTransformInitializer< TTransform, TFixedImage, TMovingImage >::InitializeTransform(), otb::Functor::StatisticsAttributesLabelObjectFunctor< TLabelObject, TFeatureImage >::operator()(), otb::Functor::ShapeAttributesLabelObjectFunctor< TLabelObject, TLabelImage >::operator()(), itk::SpatialOrientationAdapter::ToDirectionCosines(), otb::Curves2DWidget::UpdateSpaceToScreenTransform(), otb::ImageWidget< TInputImage >::UpdateTransforms(), and itk::MINC2ImageIO::XYZFromDirectionCosines().

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
vnl_matrix_fixed<T,NColumns,NRows> itk::Matrix< T, NRows, NColumns >::GetInverse ( void  ) const
inline

Return the inverse matrix.

Definition at line 207 of file itkMatrix.h.

Referenced by itk::ImageBase< VImageDimension >::ComputeIndexToPhysicalPointMatrices(), itk::MatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >::GetInverseMatrix(), itk::VectorFuzzyConnectednessImageFilter< TInputImage, TOutputImage >::SetHomogeneityMatrix(), and itk::VectorFuzzyConnectednessImageFilter< TInputImage, TOutputImage >::SetObjectsMatrix().

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
vnl_matrix_fixed<T,NColumns,NRows> itk::Matrix< T, NRows, NColumns >::GetTranspose ( void  ) const
inline

Return the transposed matrix.

Definition at line 218 of file itkMatrix.h.

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
InternalMatrixType& itk::Matrix< T, NRows, NColumns >::GetVnlMatrix ( void  )
inline

Return the matrix.

Definition at line 137 of file itkMatrix.h.

Referenced by itk::ScalableAffineTransform< TScalarType, NDimensions >::ComputeMatrix(), otb::Functor::StatisticsAttributesLabelObjectFunctor< TLabelObject, TFeatureImage >::operator()(), otb::Functor::ShapeAttributesLabelObjectFunctor< TLabelObject, TLabelImage >::operator()(), and itk::Versor< T >::Set().

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
const InternalMatrixType& itk::Matrix< T, NRows, NColumns >::GetVnlMatrix ( void  ) const
inline

Return the matrix.

Definition at line 141 of file itkMatrix.h.

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
bool itk::Matrix< T, NRows, NColumns >::operator!= ( const Self &  matrix) const
inline

Definition at line 183 of file itkMatrix.h.

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
T& itk::Matrix< T, NRows, NColumns >::operator() ( unsigned int  row,
unsigned int  col 
)
inline

Return an element of the matrix.

Definition at line 119 of file itkMatrix.h.

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
const T& itk::Matrix< T, NRows, NColumns >::operator() ( unsigned int  row,
unsigned int  col 
) const
inline

Return an element of the matrix.

Definition at line 125 of file itkMatrix.h.

template<class T, unsigned int NRows, unsigned int NColumns>
Vector< T, NRows > itk::Matrix< T, NRows, NColumns >::operator* ( const Vector< T, NColumns > &  vect) const

Matrix by Vector multiplication.

Product by a Vector

Definition at line 32 of file itkMatrix.txx.

template<class T, unsigned int NRows, unsigned int NColumns>
Point< T, NRows > itk::Matrix< T, NRows, NColumns >::operator* ( const Point< T, NColumns > &  pnt) const

Matrix by Point multiplication.

Product by a Point

Definition at line 53 of file itkMatrix.txx.

template<class T, unsigned int NRows, unsigned int NColumns>
CovariantVector< T, NRows > itk::Matrix< T, NRows, NColumns >::operator* ( const CovariantVector< T, NColumns > &  covect) const

Matrix by CovariantVector multiplication.

Product by a CovariantVector

Definition at line 75 of file itkMatrix.txx.

template<class T, unsigned int NRows, unsigned int NColumns>
Matrix< T, NRows, NColumns > itk::Matrix< T, NRows, NColumns >::operator* ( const Self &  matrix) const

Matrix by Matrix multiplication.

Product by a matrix

Definition at line 98 of file itkMatrix.txx.

References itk::Matrix< T, NRows, NColumns >::m_Matrix.

template<class T, unsigned int NRows, unsigned int NColumns>
vnl_matrix< T > itk::Matrix< T, NRows, NColumns >::operator* ( const vnl_matrix< T > &  matrix) const

Matrix by vnl_matrix multiplication.

Product by a vnl_matrix

Definition at line 188 of file itkMatrix.txx.

template<class T, unsigned int NRows, unsigned int NColumns>
vnl_vector< T > itk::Matrix< T, NRows, NColumns >::operator* ( const vnl_vector< T > &  vc) const

Matrix by vnl_vector multiplication.

Product by a vnl_vector

Definition at line 224 of file itkMatrix.txx.

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
Self itk::Matrix< T, NRows, NColumns >::operator* ( const T &  value)
inline

Matrix by scalar multiplication.

Definition at line 97 of file itkMatrix.h.

template<class T , unsigned int NRows, unsigned int NColumns>
void itk::Matrix< T, NRows, NColumns >::operator*= ( const Self &  matrix)

Matrix by Matrix multiplication.

Product by a matrix

Definition at line 201 of file itkMatrix.txx.

References itk::Matrix< T, NRows, NColumns >::m_Matrix.

template<class T, unsigned int NRows, unsigned int NColumns>
void itk::Matrix< T, NRows, NColumns >::operator*= ( const vnl_matrix< T > &  matrix)

Matrix by vnl_matrix multiplication.

Product by a vnl_matrix

Definition at line 213 of file itkMatrix.txx.

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
void itk::Matrix< T, NRows, NColumns >::operator*= ( const T &  value)
inline

Matrix by scalar multiplication.

Definition at line 93 of file itkMatrix.h.

template<class T , unsigned int NRows, unsigned int NColumns>
Matrix< T, NRows, NColumns > itk::Matrix< T, NRows, NColumns >::operator+ ( const Self &  matrix) const

Matrix addition.

Matrix Addition

Definition at line 112 of file itkMatrix.txx.

References itk::Matrix< T, NRows, NColumns >::m_Matrix.

template<class T , unsigned int NRows, unsigned int NColumns>
const Matrix< T, NRows, NColumns > & itk::Matrix< T, NRows, NColumns >::operator+= ( const Self &  matrix)

Matrix Addition in-place

Definition at line 133 of file itkMatrix.txx.

References itk::Matrix< T, NRows, NColumns >::m_Matrix.

template<class T , unsigned int NRows, unsigned int NColumns>
Matrix< T, NRows, NColumns > itk::Matrix< T, NRows, NColumns >::operator- ( const Self &  matrix) const

Matrix addition.

Matrix Subtraction

Definition at line 151 of file itkMatrix.txx.

References itk::Matrix< T, NRows, NColumns >::m_Matrix.

template<class T , unsigned int NRows, unsigned int NColumns>
const Matrix< T, NRows, NColumns > & itk::Matrix< T, NRows, NColumns >::operator-= ( const Self &  matrix)

Matrix subtraction in-place

Definition at line 170 of file itkMatrix.txx.

References itk::Matrix< T, NRows, NColumns >::m_Matrix.

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
Self itk::Matrix< T, NRows, NColumns >::operator/ ( const T &  value)
inline

Matrix by scalar division.

Definition at line 111 of file itkMatrix.h.

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
void itk::Matrix< T, NRows, NColumns >::operator/= ( const T &  value)
inline

Matrix by scalar division.

Definition at line 105 of file itkMatrix.h.

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
const Self& itk::Matrix< T, NRows, NColumns >::operator= ( const vnl_matrix< T > &  matrix)
inline

Assignment operator.

Definition at line 153 of file itkMatrix.h.

Referenced by itk::Matrix< double, OutputImageType::ImageDimension, OutputImageType::ImageDimension >::Matrix().

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
const Self& itk::Matrix< T, NRows, NColumns >::operator= ( const InternalMatrixType &  matrix)
inline

Definition at line 188 of file itkMatrix.h.

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
const Self& itk::Matrix< T, NRows, NColumns >::operator= ( const Self &  matrix)
inline

Assignment operator.

Definition at line 200 of file itkMatrix.h.

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
bool itk::Matrix< T, NRows, NColumns >::operator== ( const Self &  matrix) const
inline

Comparison operators.

Definition at line 166 of file itkMatrix.h.

Referenced by itk::Matrix< double, OutputImageType::ImageDimension, OutputImageType::ImageDimension >::operator!=().

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
T* itk::Matrix< T, NRows, NColumns >::operator[] ( unsigned int  i)
inline

Return a row of the matrix.

Definition at line 129 of file itkMatrix.h.

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
const T* itk::Matrix< T, NRows, NColumns >::operator[] ( unsigned int  i) const
inline

Return a row of the matrix.

Definition at line 133 of file itkMatrix.h.

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
void itk::Matrix< T, NRows, NColumns >::SetIdentity ( void  )
inline

Set the matrix to identity.

Definition at line 145 of file itkMatrix.h.

Referenced by itk::MINC2ImageIO::XYZFromDirectionCosines().

Member Data Documentation

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
const unsigned int itk::Matrix< T, NRows, NColumns >::ColumnDimensions = NColumns
static

Definition at line 54 of file itkMatrix.h.

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
InternalMatrixType itk::Matrix< T, NRows, NColumns >::m_Matrix
private

Definition at line 227 of file itkMatrix.h.

Referenced by itk::Matrix< double, OutputImageType::ImageDimension, OutputImageType::ImageDimension >::Fill(), itk::Matrix< double, OutputImageType::ImageDimension, OutputImageType::ImageDimension >::GetInverse(), itk::Matrix< double, OutputImageType::ImageDimension, OutputImageType::ImageDimension >::GetTranspose(), itk::Matrix< double, OutputImageType::ImageDimension, OutputImageType::ImageDimension >::GetVnlMatrix(), itk::Matrix< double, OutputImageType::ImageDimension, OutputImageType::ImageDimension >::operator()(), itk::Matrix< T, NRows, NColumns >::operator*(), itk::Matrix< T, NRows, NColumns >::operator*=(), itk::Matrix< double, OutputImageType::ImageDimension, OutputImageType::ImageDimension >::operator*=(), itk::Matrix< T, NRows, NColumns >::operator+(), itk::Matrix< T, NRows, NColumns >::operator+=(), itk::Matrix< T, NRows, NColumns >::operator-(), itk::Matrix< T, NRows, NColumns >::operator-=(), itk::Matrix< double, OutputImageType::ImageDimension, OutputImageType::ImageDimension >::operator/=(), itk::Matrix< double, OutputImageType::ImageDimension, OutputImageType::ImageDimension >::operator=(), itk::Matrix< double, OutputImageType::ImageDimension, OutputImageType::ImageDimension >::operator==(), itk::Matrix< double, OutputImageType::ImageDimension, OutputImageType::ImageDimension >::operator[](), and itk::Matrix< double, OutputImageType::ImageDimension, OutputImageType::ImageDimension >::SetIdentity().

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
const unsigned int itk::Matrix< T, NRows, NColumns >::RowDimensions = NRows
static

Number Of Columns and Rows.

Definition at line 53 of file itkMatrix.h.

The documentation for this class was generated from the following files:
Generated at Sun Jun 16 2013 02:09:57 for Orfeo Toolbox with doxygen 1.8.3.1