itk::Array< TValue > Class Template Reference

#include <itkArray.h>

Inheritance diagram for itk::Array< TValue >:

Collaboration diagram for itk::Array< TValue >:

Detailed Description

template<typename TValue>
class itk::Array< TValue >

Array class with size defined at construction time.

This class derives from the vnl_vector<> class. Its size is assigned at construction time (run time) and can not be changed afterwards except by using assignment to another Array.

The class is templated over the type of the elements.

Template parameters for class Array:

• TValue = Element type stored at each location in the array.

Definition at line 50 of file itkArray.h.

Public Types
typedef Array	Self
typedef vnl_vector< TValue > ::size_type	SizeValueType
typedef TValue	ValueType
typedef vnl_vector< TValue >	VnlVectorType

Public Member Functions
	Array ()
	Array (const Array &)
	Array (SizeValueType dimension)
	Array (ValueType *data, SizeValueType sz, bool LetArrayManageMemory=false)
	Array (const ValueType *data, SizeValueType sz, bool LetArrayManageMemory=false)
void	Fill (TValue const &v)
const TValue &	GetElement (SizeValueType i) const
SizeValueType	GetSize (void) const
const Self &	operator= (const Self &rhs)
const Self &	operator= (const VnlVectorType &rhs)
void	SetData (TValue *data, bool LetArrayManageMemory=false)
void	SetData (TValue *data, SizeValueType sz, bool LetArrayManageMemory=false)
void	SetElement (SizeValueType i, const TValue &value)
void	SetSize (SizeValueType sz)
void	swap (Array &other)
	~Array ()
template<typename TArrayValue >
	Array (const Array< TArrayValue > &r)
SizeValueType	Size (void) const
unsigned int	GetNumberOfElements (void) const

Private Attributes
bool	m_LetArrayManageMemory

Member Typedef Documentation

template<typename TValue>

typedef Array itk::Array< TValue >::Self

Definition at line 56 of file itkArray.h.

template<typename TValue>

typedef vnl_vector< TValue>::size_type itk::Array< TValue >::SizeValueType

Definition at line 58 of file itkArray.h.

template<typename TValue>

typedef TValue itk::Array< TValue >::ValueType

The element type stored at each location in the Array.

Definition at line 55 of file itkArray.h.

template<typename TValue>

typedef vnl_vector< TValue > itk::Array< TValue >::VnlVectorType

Definition at line 57 of file itkArray.h.

Constructor & Destructor Documentation

template<typename TValue>

itk::Array< TValue >::Array

(

)

Default constructor. It is created with an empty array it has to be allocated later by assignment

template<typename TValue>

itk::Array< TValue >::Array

(

const Array< TValue > &

)

Copy constructor. Uses VNL copy construtor with correct setting for memory management.

template<typename TValue>

itk::Array< TValue >::Array ( SizeValueType  dimension )

explicit

Constructor with size. Size can only be changed by assignment

template<typename TValue>

itk::Array< TValue >::Array	(	ValueType *	data,
		SizeValueType	sz,
		bool	LetArrayManageMemory = false
	)

Constructor that initializes array with contents from a user supplied buffer. The pointer to the buffer and the length is specified. By default, the array does not manage the memory of the buffer. It merely points to that location and it is the user's responsibility to delete it. If "LetArrayManageMemory" is true, then this class will free the memory when this object is destroyed.

template<typename TValue>

itk::Array< TValue >::Array	(	const ValueType *	data,
		SizeValueType	sz,
		bool	LetArrayManageMemory = false
	)

Constructor that initializes array with contents from a user supplied buffer. The pointer to the buffer and the length is specified. By default, the array does not manage the memory of the buffer. It merely points to that location and it is the user's responsibility to delete it. If "LetArrayManageMemory" is true, then this class will free the memory when this object is destroyed.

template<typename TValue>

template<typename TArrayValue >

itk::Array< TValue >::Array ( const Array< TArrayValue > &  r )

inline

Constructor to initialize an array from another of any data type

Definition at line 101 of file itkArray.h.

template<typename TValue>

itk::Array< TValue >::~Array

(

)

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

Member Function Documentation

template<typename TValue>

void itk::Array< TValue >::Fill ( TValue const &  v )

inline

Set the all the elements of the array to the specified value

Definition at line 113 of file itkArray.h.

Referenced by itk::MatchCardinalityImageToImageMetric< TFixedImage, TMovingImage >::GetDerivative(), itk::NumericTraits< Array< T > >::max(), itk::NumericTraits< Array< T > >::min(), itk::NumericTraits< Array< T > >::NonpositiveMin(), itk::NumericTraits< Array< T > >::OneValue(), itk::NumericTraits< Array< T > >::SetLength(), and itk::NumericTraits< Array< T > >::ZeroValue().

template<typename TValue>

const TValue& itk::Array< TValue >::GetElement ( SizeValueType  i ) const

inline

Get one element

Definition at line 131 of file itkArray.h.

template<typename TValue>

unsigned int itk::Array< TValue >::GetNumberOfElements ( void  ) const

inline

Return the number of elements in the Array

Definition at line 126 of file itkArray.h.

template<typename TValue>

SizeValueType itk::Array< TValue >::GetSize ( void  ) const

inline

Definition at line 141 of file itkArray.h.

Referenced by itk::Array< AccumulateType >::Array(), itk::NumericTraits< Array< T > >::GetLength(), itk::OptimizerParametersHelper< TValue >::MoveDataPointer(), itk::MetaArrayWriter::SetMultiChannelInput(), and itk::Statistics::ProbabilityDistribution::SetParameters().

template<typename TValue>

const Self& itk::Array< TValue >::operator=

(

const Self &

rhs

)

Copy opertor

template<typename TValue>

const Self& itk::Array< TValue >::operator=

(

const VnlVectorType &

rhs

)

template<typename TValue>

void itk::Array< TValue >::SetData	(	TValue *	data,
		bool	LetArrayManageMemory = false
	)

Set the pointer from which the data is imported. If "LetArrayManageMemory" is false, then the application retains the responsibility of freeing the memory for this data. If "LetArrayManageMemory" is true, then this class will free the memory when this object is destroyed.

Referenced by itk::MetaArrayReader::GetOutput(), and itk::OptimizerParametersHelper< TValue >::MoveDataPointer().

template<typename TValue>

void itk::Array< TValue >::SetData	(	TValue *	data,
		SizeValueType	sz,
		bool	LetArrayManageMemory = false
	)

Similar to the previous method. In the above method, the size must be separately set prior to using user-supplied data. This introduces an unnecessary allocation step to be performed. This method avoids it and should be used to import data wherever possible to avoid this. Set the pointer from which the data is imported. If "LetArrayManageMemory" is false, then the application retains the responsibility of freeing the memory for this data. If "LetArrayManageMemory" is true, then this class will free the memory when this object is destroyed.

template<typename TValue>

void itk::Array< TValue >::SetElement ( SizeValueType  i, const TValue &  value  )

inline

Set one element

Definition at line 135 of file itkArray.h.

template<typename TValue>

void itk::Array< TValue >::SetSize

(

SizeValueType

sz

)

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

Referenced by itk::Array< AccumulateType >::Array(), itk::TranslationTransform< TScalar, NDimensions >::GetFixedParameters(), itk::MetaArrayReader::GetMultiChannelOutput(), itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::LabelStatistics::LabelStatistics(), and itk::NumericTraits< Array< T > >::SetLength().

template<typename TValue>

SizeValueType itk::Array< TValue >::Size ( void  ) const

inline

Return the number of elements in the Array

Definition at line 124 of file itkArray.h.

Referenced by itk::Statistics::MeasurementVectorTraits::Assert(), itk::NumericTraits< Array< T > >::max(), itk::NumericTraits< Array< T > >::min(), itk::NumericTraits< Array< T > >::NonpositiveMin(), itk::NumericTraits< Array< T > >::OneValue(), itk::AutomaticTopologyMeshSource< TOutputMesh >::IdentifierArrayHashFunction::operator()(), itk::AutomaticTopologyMeshSource< TOutputMesh >::IdentifierArrayEqualsFunction::operator()(), itk::MetaArrayWriter::SetInput(), itk::DisplacementFieldTransform< TScalar, NDimensions >::SetParameters(), itk::MeshIOBase::SetPixelType(), itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform >::SetShrinkFactorsPerLevel(), SimpleMultiResolutionImageRegistrationUI2< TRegistration >::StartNewLevel(), and itk::NumericTraits< Array< T > >::ZeroValue().

template<typename TValue>

void itk::Array< TValue >::swap ( Array< TValue > &  other )

inline

Definition at line 171 of file itkArray.h.

Referenced by itk::Array< AccumulateType >::swap(), and itk::swap().

Member Data Documentation

template<typename TValue>

bool itk::Array< TValue >::m_LetArrayManageMemory

private

Definition at line 180 of file itkArray.h.

Referenced by itk::Array< AccumulateType >::Array(), and itk::Array< AccumulateType >::swap().

---

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

• itkArray.h