ITK  4.6.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Private Attributes | List of all members
itk::Matrix< T, NRows, NColumns > Class Template Reference
Data Representation Objects | Module ITKCommon

#include <itkMatrix.h>

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

Detailed Description

template<typename 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.

Wiki Examples:
Examples:
DataRepresentation/Image/Image4.cxx, and DataRepresentation/Mesh/MeshTraits.cxx.

Definition at line 46 of file itkMatrix.h.

Public Types

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

Public Member Functions

void Fill (const T &value)
 
vnl_matrix_fixed< T, NColumns,
NRows > 		GetTranspose (void) const
 
InternalMatrixType & GetVnlMatrix (void)
 
const InternalMatrixType & GetVnlMatrix (void) const
 
 Matrix (const vnl_matrix< T > &matrix)
 
 Matrix (const InternalMatrixType &matrix)
 
 Matrix ()
 
 Matrix (const Self &matrix)
 
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
 
vnl_vector_fixed< T, NRows > operator* (const vnl_vector_fixed< T, NColumns > &vector) const
 
Self operator* (const CompatibleSquareMatrixType &matrix) const
 
template<unsigned int OuterDim>
Matrix< T, NRows, OuterDim > operator* (const vnl_matrix_fixed< T, NRows, OuterDim > &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 CompatibleSquareMatrixType &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)
 
vnl_matrix_fixed< T, NColumns,
NRows > 		GetInverse (void) const
 

Static Public Attributes

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

Private Attributes

InternalMatrixType m_Matrix
 

Member Typedef Documentation

template<typename T, unsigned int NRows = 3, unsigned int NColumns = 3>
typedef Matrix<T, NColumns, NColumns> itk::Matrix< T, NRows, NColumns >::CompatibleSquareMatrixType

Compatible square matrix. This is currently used by operator* to help with wrapping.

Todo:
In the future, the method should be templated to allow multiplication by NColumns by XRows.

Definition at line 67 of file itkMatrix.h.

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

Definition at line 54 of file itkMatrix.h.

template<typename 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 62 of file itkMatrix.h.

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

Standard class typedefs.

Definition at line 50 of file itkMatrix.h.

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

Component value type

Definition at line 53 of file itkMatrix.h.

Constructor & Destructor Documentation

template<typename 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 197 of file itkMatrix.h.

template<typename 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 233 of file itkMatrix.h.

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

Default constructor.

Definition at line 264 of file itkMatrix.h.

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

Copy constructor.

Definition at line 267 of file itkMatrix.h.

Member Function Documentation

template<typename 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.

Examples:
DataRepresentation/Image/Image4.cxx.

Definition at line 184 of file itkMatrix.h.

Referenced by itk::ShapeLabelObject< TLabel, VImageDimension >::ShapeLabelObject(), and itk::StatisticsLabelObject< TLabel, VImageDimension >::StatisticsLabelObject().

template<typename 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 246 of file itkMatrix.h.

template<typename 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 258 of file itkMatrix.h.

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

Return the matrix.

Definition at line 166 of file itkMatrix.h.

Referenced by itk::OpenCVBasicTypeBridge< itk::Matrix< T, NRows, NColumns >, cv::Matx< T, NRows, NColumns > >::FromITKToOpenCV().

template<typename 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 172 of file itkMatrix.h.

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

Definition at line 221 of file itkMatrix.h.

template<typename 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 142 of file itkMatrix.h.

template<typename 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 148 of file itkMatrix.h.

template<typename T, unsigned int NRows = 3, unsigned int NColumns = 3>
Vector< T, NRows > itk::Matrix< T, NRows, NColumns >::operator* ( const Vector< T, NColumns > &  vector) const

Matrix by Vector multiplication.

template<typename T, unsigned int NRows = 3, unsigned int NColumns = 3>
Point< T, NRows > itk::Matrix< T, NRows, NColumns >::operator* ( const Point< T, NColumns > &  vector) const

Matrix by Point multiplication.

template<typename T, unsigned int NRows = 3, unsigned int NColumns = 3>
CovariantVector< T, NRows > itk::Matrix< T, NRows, NColumns >::operator* ( const CovariantVector< T, NColumns > &  vector) const

Matrix by CovariantVector multiplication.

template<typename T, unsigned int NRows = 3, unsigned int NColumns = 3>
vnl_vector_fixed<T,NRows> itk::Matrix< T, NRows, NColumns >::operator* ( const vnl_vector_fixed< T, NColumns > &  vector) const

Matrix by vnl_vector_fixed multiplication.

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

Matrix by Matrix multiplication.

template<typename T, unsigned int NRows = 3, unsigned int NColumns = 3>
template<unsigned int OuterDim>
Matrix<T, NRows, OuterDim> itk::Matrix< T, NRows, NColumns >::operator* ( const vnl_matrix_fixed< T, NRows, OuterDim > &  matrix) const
inline

Definition at line 85 of file itkMatrix.h.

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

Matrix by vnl_matrix multiplication.

template<typename T, unsigned int NRows = 3, unsigned int NColumns = 3>
vnl_vector< T > itk::Matrix< T, NRows, NColumns >::operator* ( const vnl_vector< T > &  matrix) const

Matrix by vnl_vector multiplication.

template<typename 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 118 of file itkMatrix.h.

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

Matrix by Matrix multiplication.

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

Matrix by vnl_matrix multiplication.

template<typename 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 114 of file itkMatrix.h.

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

Matrix addition.

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

Matrix addition.

template<typename T, unsigned int NRows = 3, unsigned int NColumns = 3>
const Self& itk::Matrix< T, NRows, NColumns >::operator-= ( const Self &  matrix)
template<typename 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 133 of file itkMatrix.h.

template<typename 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 127 of file itkMatrix.h.

template<typename 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 190 of file itkMatrix.h.

Referenced by itk::Matrix< ScalarType, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension) >::Matrix().

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

Definition at line 226 of file itkMatrix.h.

template<typename 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 239 of file itkMatrix.h.

template<typename 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 203 of file itkMatrix.h.

Referenced by itk::Matrix< ScalarType, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension) >::operator!=().

template<typename 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 154 of file itkMatrix.h.

template<typename 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 160 of file itkMatrix.h.

template<typename 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 178 of file itkMatrix.h.

Member Data Documentation

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

Number Of Columns and Rows.

Definition at line 58 of file itkMatrix.h.

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

Definition at line 270 of file itkMatrix.h.

Referenced by itk::Matrix< ScalarType, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension) >::Fill(), itk::Matrix< ScalarType, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension) >::GetInverse(), itk::Matrix< ScalarType, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension) >::GetTranspose(), itk::Matrix< ScalarType, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension) >::GetVnlMatrix(), itk::Matrix< ScalarType, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension) >::operator()(), itk::Matrix< ScalarType, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension) >::operator*(), itk::Matrix< ScalarType, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension) >::operator*=(), itk::Matrix< ScalarType, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension) >::operator/=(), itk::Matrix< ScalarType, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension) >::operator=(), itk::Matrix< ScalarType, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension) >::operator==(), itk::Matrix< ScalarType, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension) >::operator[](), and itk::Matrix< ScalarType, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension) >::SetIdentity().

template<typename 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 57 of file itkMatrix.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Mon Jul 21 2014 02:00:26 for ITK by   doxygen 1.8.5