ITK  4.13.0
Insight Segmentation and Registration Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes | List of all members
itk::FixedArray< TValue, VLength > Class Template Reference
Data Representation Objects | Module ITKCommon

#include <itkFixedArray.h>

+ Inheritance diagram for itk::FixedArray< TValue, VLength >:
+ Collaboration diagram for itk::FixedArray< TValue, VLength >:

Detailed Description

template<typename TValue, unsigned int VLength = 3>
class itk::FixedArray< TValue, VLength >

Simulate a standard C array with copy semnatics.

Simulates a standard C array, except that copy semantics are used instead of reference semantics. Also, arrays of different sizes cannot be assigned to one another, and size information is known for function returns.

Template Parameters
TValueElement type stored at each location in the array.
VLength= Length of the array.

The length of the array is fixed at compile time. If you wish to specify the length of the array at run-time, use the class itk::Array. If you wish to change to change the length of the array at run-time, you're best off using std::vector<>.

Wiki Examples:
Examples:
Examples/Statistics/ImageToListSampleAdaptor.cxx, Examples/Statistics/PointSetToAdaptor.cxx, Examples/Statistics/ScalarImageMarkovRandomField1.cxx, SphinxExamples/src/Core/Common/CreateAFixedArray/Code.cxx, SphinxExamples/src/Filtering/ImageGrid/Create3DVolume/Code.cxx, WikiExamples/ImageProcessing/PermuteAxesImageFilter.cxx, WikiExamples/ImageProcessing/ScaleTransform.cxx, WikiExamples/ImageProcessing/TileImageFilter_CreateVolume.cxx, WikiExamples/ImageProcessing/TileImageFilter_SideBySide.cxx, WikiExamples/Images/FlipImageFilter.cxx, and WikiExamples/Statistics/ImageToListSampleAdaptor.cxx.

Definition at line 50 of file itkFixedArray.h.

Classes

class  ConstReverseIterator
 
class  ReverseIterator
 

Public Types

typedef ValueType CArray [VLength]
 
typedef const ValueType * const_pointer
 
typedef const ValueType & const_reference
 
typedef const ValueType * ConstIterator
 
typedef ValueType * Iterator
 
typedef ValueType * pointer
 
typedef ValueType & reference
 
typedef unsigned int SizeType
 
typedef TValue ValueType
 

Public Member Functions

Iterator Begin ()
 
ConstIterator Begin () const
 
Iterator End ()
 
ConstIterator End () const
 
void Fill (const ValueType &)
 
template<typename TScalarValue >
 FixedArray (const TScalarValue *r)
 
ValueType * GetDataPointer ()
 
const ValueType * GetDataPointer () const
 
bool operator!= (const FixedArray &r) const
 
FixedArray & operator= (const ValueType r[VLength])
 
bool operator== (const FixedArray &r) const
 
ReverseIterator rBegin ()
 
ConstReverseIterator rBegin () const
 
ReverseIterator rEnd ()
 
ConstReverseIterator rEnd () const
 
SizeType Size () const
 
 FixedArray ()
 
 FixedArray (const ValueType r[VLength])
 
 FixedArray (const ValueType &r)
 
template<typename TFixedArrayValueType >
 FixedArray (const FixedArray< TFixedArrayValueType, VLength > &r)
 
template<typename TFixedArrayValueType >
FixedArray & operator= (const FixedArray< TFixedArrayValueType, VLength > &r)
 
reference operator[] (short index)
 
const_reference operator[] (short index) const
 
reference operator[] (unsigned short index)
 
const_reference operator[] (unsigned short index) const
 
reference operator[] (int index)
 
const_reference operator[] (int index) const
 
reference operator[] (unsigned int index)
 
const_reference operator[] (unsigned int index) const
 
reference operator[] (long index)
 
const_reference operator[] (long index) const
 
reference operator[] (unsigned long index)
 
const_reference operator[] (unsigned long index) const
 
reference operator[] (long long index)
 
const_reference operator[] (long long index) const
 
reference operator[] (unsigned long long index)
 
const_reference operator[] (unsigned long long index) const
 
void SetElement (unsigned short index, const_reference value)
 
const_reference GetElement (unsigned short index) const
 

Static Public Member Functions

static FixedArray Filled (const ValueType &)
 

Static Public Attributes

static const unsigned int Dimension = VLength
 
static const unsigned int Length = VLength
 

Private Attributes

CArray m_InternalArray
 

Member Typedef Documentation

template<typename TValue, unsigned int VLength = 3>
typedef ValueType itk::FixedArray< TValue, VLength >::CArray[VLength]

A type representing the C-array version of this FixedArray.

Definition at line 63 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
typedef const ValueType* itk::FixedArray< TValue, VLength >::const_pointer

A const pointer to the ValueType.

Definition at line 121 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
typedef const ValueType& itk::FixedArray< TValue, VLength >::const_reference

A const reference to the ValueType.

Definition at line 127 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
typedef const ValueType* itk::FixedArray< TValue, VLength >::ConstIterator

A const iterator through the array.

Definition at line 69 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
typedef ValueType* itk::FixedArray< TValue, VLength >::Iterator

An iterator through the array.

Definition at line 66 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
typedef ValueType* itk::FixedArray< TValue, VLength >::pointer

A pointer to the ValueType.

Definition at line 118 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
typedef ValueType& itk::FixedArray< TValue, VLength >::reference

A reference to the ValueType.

Definition at line 124 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
typedef unsigned int itk::FixedArray< TValue, VLength >::SizeType

Definition at line 129 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
typedef TValue itk::FixedArray< TValue, VLength >::ValueType

The element type stored at each location in the FixedArray.

Definition at line 60 of file itkFixedArray.h.

Constructor & Destructor Documentation

template<typename TValue, unsigned int VLength = 3>
itk::FixedArray< TValue, VLength >::FixedArray ( )

Constructors

template<typename TValue, unsigned int VLength = 3>
itk::FixedArray< TValue, VLength >::FixedArray ( const ValueType  r[VLength])

Constructors

template<typename TValue, unsigned int VLength = 3>
itk::FixedArray< TValue, VLength >::FixedArray ( const ValueType &  r)

Constructors

template<typename TValue, unsigned int VLength = 3>
template<typename TFixedArrayValueType >
itk::FixedArray< TValue, VLength >::FixedArray ( const FixedArray< TFixedArrayValueType, VLength > &  r)
inline

Constructor to initialize a fixed array from another of any data type

Definition at line 140 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
template<typename TScalarValue >
itk::FixedArray< TValue, VLength >::FixedArray ( const TScalarValue *  r)
inline

Definition at line 152 of file itkFixedArray.h.

Member Function Documentation

template<typename TValue, unsigned int VLength = 3>
Iterator itk::FixedArray< TValue, VLength >::Begin ( )

Get various iterators to the array.

Referenced by itk::CopyMeshToMeshPoints(), itk::FixedArray< NeighborhoodType, itkGetStaticConstMacro(ImageDimension) >::FixedArray(), and itk::FixedArray< NeighborhoodType, itkGetStaticConstMacro(ImageDimension) >::operator=().

template<typename TValue, unsigned int VLength = 3>
ConstIterator itk::FixedArray< TValue, VLength >::Begin ( ) const
template<typename TValue, unsigned int VLength = 3>
Iterator itk::FixedArray< TValue, VLength >::End ( )
template<typename TValue, unsigned int VLength = 3>
ConstIterator itk::FixedArray< TValue, VLength >::End ( ) const
template<typename TValue, unsigned int VLength = 3>
void itk::FixedArray< TValue, VLength >::Fill ( const ValueType &  )

Referenced by itk::VoronoiDiagram2DGenerator< TCoordType >::FortuneSite::FortuneSite(), itk::fem::Solver< TDimension >::InitializeInterpolationGrid(), itk::NumericTraits< FixedArray< T, D > >::SetLength(), itk::DiscreteGaussianDerivativeImageFilter< TInputImage, TOutputImage >::SetMaximumError(), itk::DisplacementFieldToBSplineImageFilter< TInputImage, TInputPointSet, TOutputImage >::SetNumberOfFittingLevels(), itk::N4BiasFieldCorrectionImageFilter< TInputImage, TMaskImage, TOutputImage >::SetNumberOfFittingLevels(), itk::DiscreteGaussianDerivativeImageFilter< TInputImage, TOutputImage >::SetOrder(), itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::SetShrinkFactorsPerLevel(), itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::SetSigma(), itk::DiscreteGaussianDerivativeImageFilter< TInputImage, TOutputImage >::SetVariance(), itk::ShapeLabelObject< TLabel, VImageDimension >::ShapeLabelObject(), and itk::StatisticsLabelObject< TLabel, VImageDimension >::StatisticsLabelObject().

template<typename TValue, unsigned int VLength = 3>
static FixedArray itk::FixedArray< TValue, VLength >::Filled ( const ValueType &  )
static
template<typename TValue, unsigned int VLength = 3>
ValueType* itk::FixedArray< TValue, VLength >::GetDataPointer ( )
inline

Return a pointer to the data.

Definition at line 237 of file itkFixedArray.h.

Referenced by itk::Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType >::Get(), itk::Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType >::Get(), itk::MetaArrayWriter::SetInput(), itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::SetOutputPixel(), itk::ImageBase< TImage::ImageDimension >::TransformLocalVectorToPhysicalVector(), and itk::ImageBase< TImage::ImageDimension >::TransformPhysicalVectorToLocalVector().

template<typename TValue, unsigned int VLength = 3>
const ValueType* itk::FixedArray< TValue, VLength >::GetDataPointer ( ) const
inline

Definition at line 242 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
const_reference itk::FixedArray< TValue, VLength >::GetElement ( unsigned short  index) const
inline

Set/Get element methods are more convenient in wrapping languages

Definition at line 233 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
bool itk::FixedArray< TValue, VLength >::operator!= ( const FixedArray< TValue, VLength > &  r) const
inline

Definition at line 194 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
template<typename TFixedArrayValueType >
FixedArray& itk::FixedArray< TValue, VLength >::operator= ( const FixedArray< TFixedArrayValueType, VLength > &  r)
inline

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

The destructor is PURPOSELY NOT DEFINED, in order to prevent inefficient byte alignment of arrays of this object.

~FixedArray();

For a full discussion, see https://www.itk.org/mailman/private/insight-developers/2008-June/010480.htmlOperator= defined for a variety of types.

Definition at line 172 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
FixedArray& itk::FixedArray< TValue, VLength >::operator= ( const ValueType  r[VLength])
template<typename TValue, unsigned int VLength = 3>
bool itk::FixedArray< TValue, VLength >::operator== ( const FixedArray< TValue, VLength > &  r) const

Operators == and != are used to compare whether two arrays are equal. Note that arrays are equal when the number of components (size) is the same, and each component value is equal.

template<typename TValue, unsigned int VLength = 3>
reference itk::FixedArray< TValue, VLength >::operator[] ( short  index)
inline

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 200 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
const_reference itk::FixedArray< TValue, VLength >::operator[] ( short  index) const
inline

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 201 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
reference itk::FixedArray< TValue, VLength >::operator[] ( unsigned short  index)
inline

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 202 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
const_reference itk::FixedArray< TValue, VLength >::operator[] ( unsigned short  index) const
inline

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 203 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
reference itk::FixedArray< TValue, VLength >::operator[] ( int  index)
inline

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 204 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
const_reference itk::FixedArray< TValue, VLength >::operator[] ( int  index) const
inline

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 205 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
reference itk::FixedArray< TValue, VLength >::operator[] ( unsigned int  index)
inline

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 213 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
const_reference itk::FixedArray< TValue, VLength >::operator[] ( unsigned int  index) const
inline

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 214 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
reference itk::FixedArray< TValue, VLength >::operator[] ( long  index)
inline

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 220 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
const_reference itk::FixedArray< TValue, VLength >::operator[] ( long  index) const
inline

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 221 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
reference itk::FixedArray< TValue, VLength >::operator[] ( unsigned long  index)
inline

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 222 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
const_reference itk::FixedArray< TValue, VLength >::operator[] ( unsigned long  index) const
inline

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 223 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
reference itk::FixedArray< TValue, VLength >::operator[] ( long long  index)
inline

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 224 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
const_reference itk::FixedArray< TValue, VLength >::operator[] ( long long  index) const
inline

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 225 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
reference itk::FixedArray< TValue, VLength >::operator[] ( unsigned long long  index)
inline

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 226 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
const_reference itk::FixedArray< TValue, VLength >::operator[] ( unsigned long long  index) const
inline

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 227 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
ReverseIterator itk::FixedArray< TValue, VLength >::rBegin ( )
template<typename TValue, unsigned int VLength = 3>
ConstReverseIterator itk::FixedArray< TValue, VLength >::rBegin ( ) const
template<typename TValue, unsigned int VLength = 3>
ReverseIterator itk::FixedArray< TValue, VLength >::rEnd ( )
template<typename TValue, unsigned int VLength = 3>
ConstReverseIterator itk::FixedArray< TValue, VLength >::rEnd ( ) const
template<typename TValue, unsigned int VLength = 3>
void itk::FixedArray< TValue, VLength >::SetElement ( unsigned short  index,
const_reference  value 
)
inline

Set/Get element methods are more convenient in wrapping languages

Definition at line 231 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
SizeType itk::FixedArray< TValue, VLength >::Size ( ) const

Member Data Documentation

template<typename TValue, unsigned int VLength = 3>
const unsigned int itk::FixedArray< TValue, VLength >::Dimension = VLength
static

Dimension constant

Definition at line 57 of file itkFixedArray.h.

template<typename TValue, unsigned int VLength = 3>
const unsigned int itk::FixedArray< TValue, VLength >::Length = VLength
static

Length constant

Definition at line 54 of file itkFixedArray.h.

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

template<typename TValue, unsigned int VLength = 3>
CArray itk::FixedArray< TValue, VLength >::m_InternalArray
private

Internal C array representation.

Definition at line 270 of file itkFixedArray.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 Tue Dec 19 2017 05:28:47 for ITK by   doxygen 1.8.5