Orfeo Toolbox  3.16
Public Types | Public Member Functions
itk::Array2D< TValueType > Class Template Reference

Array2D class representing a 2D array with size defined at construction time. More...

#include <itkArray2D.h>

+ Inheritance diagram for itk::Array2D< TValueType >:
+ Collaboration diagram for itk::Array2D< TValueType >:

List of all members.

Public Types

typedef Array2D Self
typedef TValueType ValueType
typedef vnl_matrix< TValueType > VnlMatrixType

Public Member Functions

 Array2D ()
 Array2D (unsigned int rows, unsigned int cols)
 Array2D (const Self &array)
 Array2D (const VnlMatrixType &matrix)
 ~Array2D ()
void Fill (TValueType const &v)
const Selfoperator= (const Self &array)
const Selfoperator= (const VnlMatrixType &matrix)
void SetSize (unsigned int m, unsigned int n)

Detailed Description

template<typename TValueType>
class itk::Array2D< TValueType >

Array2D class representing a 2D array with size defined at construction time.

This class derives from the vnl_matrix<> class. Its size is assigned at construction time (run time) and can not be changed afterwards.

The class is templated over the type of the elements.

Template parameters for class Array2D:

Definition at line 44 of file itkArray2D.h.


Member Typedef Documentation

template<typename TValueType>
typedef Array2D itk::Array2D< TValueType >::Self

Definition at line 50 of file itkArray2D.h.

template<typename TValueType>
typedef TValueType itk::Array2D< TValueType >::ValueType

The element type stored at each location in the Array2D.

Definition at line 49 of file itkArray2D.h.

template<typename TValueType>
typedef vnl_matrix<TValueType> itk::Array2D< TValueType >::VnlMatrixType

Definition at line 51 of file itkArray2D.h.


Constructor & Destructor Documentation

template<typename TValueType >
itk::Array2D< TValueType >::Array2D ( )

Default constructor

Definition at line 28 of file itkArray2D.txx.

template<typename TValueType >
itk::Array2D< TValueType >::Array2D ( unsigned int  numberOfRows,
unsigned int  numberOfCols 
)

Constructor with number of rows and columns as arguments

Definition at line 35 of file itkArray2D.txx.

template<typename TValueType >
itk::Array2D< TValueType >::Array2D ( const Self array)

Copy Constructor

Definition at line 51 of file itkArray2D.txx.

template<typename TValueType >
itk::Array2D< TValueType >::Array2D ( const VnlMatrixType matrix)

Constructor from a vnl_matrix

Definition at line 44 of file itkArray2D.txx.

template<typename TValueType>
itk::Array2D< TValueType >::~Array2D ( )
inline

This destructor is not virtual for performance reasons. However, this means that subclasses cannot allocate memory.

Definition at line 70 of file itkArray2D.h.


Member Function Documentation

template<typename TValueType>
void itk::Array2D< TValueType >::Fill ( TValueType const &  v)
inline
template<typename TValueType >
const Array2D< TValueType > & itk::Array2D< TValueType >::operator= ( const Self array)

Assignment Operator from Array

Definition at line 59 of file itkArray2D.txx.

template<typename TValueType >
const Array2D< TValueType > & itk::Array2D< TValueType >::operator= ( const VnlMatrixType matrix)

Assignment Operator from vnl_matrix

Definition at line 69 of file itkArray2D.txx.

template<typename TValueType >
void itk::Array2D< TValueType >::SetSize ( unsigned int  m,
unsigned int  n 
)

Destructively set the size to that given. Will lose data.

Set the size of the array

Definition at line 78 of file itkArray2D.txx.


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

Generated at Sun Feb 3 2013 01:06:12 for Orfeo Toolbox with doxygen 1.8.1.1