Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts
Public Types | Public Member Functions

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 >:
Inheritance graph
[legend]

List of all members.

Public Types

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
InternalMatrixTypeGetVnlMatrix (void)
const InternalMatrixTypeGetVnlMatrix (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
Self operator* (const Self &matrix) const
vnl_vector< T > operator* (const vnl_vector< T > &matrix) const
Vector< T, NRows > operator* (const Vector< T, NColumns > &vector) const
Point< T, NRows > operator* (const Point< T, NColumns > &vector) const
vnl_matrix< T > operator* (const vnl_matrix< T > &matrix) const
CovariantVector< T, NRows > operator* (const CovariantVector< T, NColumns > &vector) const
void operator*= (const Self &matrix)
void operator*= (const T &value)
void operator*= (const vnl_matrix< T > &matrix)
void operator/= (const T &value)
const Selfoperator= (const vnl_matrix< T > &matrix)
const Selfoperator= (const InternalMatrixType &matrix)
const Selfoperator= (const Self &matrix)
T * operator[] (unsigned int i)
const T * operator[] (unsigned int i) const
void SetIdentity (void)

Self operator+ (const Self &matrix) const
const Selfoperator+= (const Self &matrix)

Self operator- (const Self &matrix) const
const Selfoperator-= (const Self &matrix)

Self operator* (const T &value)

Self operator/ (const T &value)

bool operator== (const Self &matrix) const

vnl_matrix_fixed< T, NColumns,
NRows > 
GetInverse (void) const

Static Public Attributes

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

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 58 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 165 of file itkMatrix.h.

template<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
itk::Matrix< T, NRows, NColumns >::Matrix ( const InternalMatrixType matrix  )  [inline, explicit]

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

Definition at line 201 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 232 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 235 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 154 of file itkMatrix.h.

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 214 of file itkMatrix.h.

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 226 of file itkMatrix.h.

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 146 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 142 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 189 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 124 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 130 of file itkMatrix.h.

template<class 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<class T, unsigned int NRows = 3, unsigned int NColumns = 3>
Self itk::Matrix< T, NRows, NColumns >::operator* ( const Self matrix  )  const

Matrix by Matrix multiplication.

template<class 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<class 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<class 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<class 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<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 100 of file itkMatrix.h.

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

Matrix by Matrix multiplication.

template<class 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<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 96 of file itkMatrix.h.

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

Matrix addition.

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

Matrix addition.

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

Matrix addition.

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

Matrix addition.

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 115 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 109 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]
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 194 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 207 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]
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 134 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 138 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 150 of file itkMatrix.h.


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]

Number Of Columns and Rows.

Definition at line 54 of file itkMatrix.h.

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 file:

Generated at Tue Jul 13 2010 00:03:42 for ITK by doxygen 1.7.1 written by Dimitri van Heesch, © 1997-2000