go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions
itk::NDImageBase< TPixel > Class Template Reference

#include <itkNDImageBase.h>

Inheritance diagram for itk::NDImageBase< TPixel >:
Inheritance graph
[legend]
Collaboration diagram for itk::NDImageBase< TPixel >:
Collaboration graph
[legend]

Public Types

typedef Image< TPixel, 2 >
::AccessorType 
AccessorType
typedef SmartPointer< const SelfConstPointer
typedef DataObjectType::Pointer DataObjectPointer
typedef DataObject DataObjectType
typedef Array< IndexValueTypeIndexType
typedef ImageBase
< 2 >::IndexValueType 
IndexValueType
typedef Image< TPixel, 2 >
::InternalPixelType 
InternalPixelType
typedef Array< OffsetValueTypeOffsetType
typedef ImageBase
< 2 >::OffsetValueType 
OffsetValueType
typedef Image< TPixel, 2 >
::PixelContainer 
PixelContainer
typedef Image< TPixel, 2 >
::PixelContainerConstPointer 
PixelContainerConstPointer
typedef Image< TPixel, 2 >
::PixelContainerPointer 
PixelContainerPointer
typedef Image< TPixel, 2 >
::PixelType 
PixelType
typedef ImageBase< 2 >::PointType Point2DType
typedef SmartPointer< SelfPointer
typedef Array< PointValueTypePointType
typedef Point2DType::ValueType PointValueType
typedef NDImageBase Self
typedef Array< SizeValueTypeSizeType
typedef ImageBase
< 2 >::SizeValueType 
SizeValueType
typedef ImageBase< 2 >::SpacingType Spacing2DType
typedef Array< SpacingValueTypeSpacingType
typedef Spacing2DType::ValueType SpacingValueType
typedef Object Superclass
typedef Image< TPixel, 2 >
::ValueType 
ValueType

Public Member Functions

virtual void Allocate (void)=0
virtual IndexType ComputeIndex (OffsetValueType offset) const =0
virtual OffsetValueType ComputeOffset (const IndexType &ind) const =0
virtual void CopyInformation (const DataObject *data)=0
virtual void CreateNewImage (void)=0
virtual void FillBuffer (const TPixel &value)=0
virtual TPixel * GetBufferPointer ()=0
virtual const TPixel * GetBufferPointer () const =0
virtual const char * GetClassName () const
virtual DataObject * GetImage (void)=0
virtual unsigned int GetImageDimension (void)=0
virtual ImageIOBaseGetImageIOReader (void)=0
virtual ImageIOBaseGetImageIOWriter (void)=0
virtual const char * GetInputFileName (void)=0
virtual const OffsetValueTypeGetOffsetTable () const =0
virtual PointType GetOrigin (void)=0
virtual const char * GetOutputFileName (void)=0
virtual const TPixel & GetPixel (const IndexType &index) const =0
virtual TPixel & GetPixel (const IndexType &index)=0
virtual AccessorType GetPixelAccessor (void)=0
virtual const AccessorType GetPixelAccessor (void) const =0
virtual PixelContainerGetPixelContainer ()=0
virtual const PixelContainerGetPixelContainer () const =0
virtual ProcessObject * GetReader (void)=0
virtual SpacingType GetSpacing (void)=0
virtual ProcessObject * GetWriter (void)=0
virtual unsigned int ImageDimension (void)=0
virtual void Initialize (void)=0
TPixel & operator[] (const IndexType &index)
const TPixel & operator[] (const IndexType &index) const
virtual void Read (void)=0
virtual void SetImageIOReader (ImageIOBase *_arg)=0
virtual void SetImageIOWriter (ImageIOBase *_arg)=0
virtual void SetInputFileName (const char *)=0
virtual void SetOrigin (const PointType &origin)=0
virtual void SetOutputFileName (const char *)=0
virtual void SetPixel (const IndexType &index, const TPixel &value)=0
virtual void SetPixelContainer (PixelContainer *container)=0
virtual void SetRegions (SizeType size)=0
virtual void SetRequestedRegion (DataObject *data)=0
virtual void SetSpacing (const SpacingType &spacing)=0
virtual void Write (void)=0

Static Public Member Functions

static Pointer NewNDImage (unsigned int dim)

Protected Member Functions

 NDImageBase ()
virtual ~NDImageBase ()

Private Member Functions

 NDImageBase (const Self &)
void operator= (const Self &)

Detailed Description

template<class TPixel>
class itk::NDImageBase< TPixel >

An image whose dimension can be specified at runtime.

The NDImageBase class is needed for the FullSearch optimizer. It allows run-time construction of an N-dimensional image. It has most of the functionality of a normal itk::Image.

Todo:
not all! An internal writer and reader are included for convenience.

The NewNDImage function defines the dimension of the image. CreateNewImage creates an instance of an itk::Image, with dimension as specified by NewNDImage. Note: the NewNDImage does not return an itk::Image, but an elx::NDImageTemplate.

Suggested way of using this class:
NDImageBase<short> var1 = NDImageBase::NewNDImage(3);
var1->CreateNewImage();
The result is similar as:
itk::Image<short,3>::Pointer var1 = itk::Image<short,3>::New();
except that the actual itk::Image is stored as member variable in the NDImageTemplate.

See also:
FullSearchOptimizer, NDImageTemplate

Definition at line 55 of file itkNDImageBase.h.


Member Typedef Documentation

template<class TPixel >
typedef Image<TPixel,2>::AccessorType itk::NDImageBase< TPixel >::AccessorType

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

Definition at line 80 of file itkNDImageBase.h.

template<class TPixel >
typedef SmartPointer<const Self> itk::NDImageBase< TPixel >::ConstPointer

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

Definition at line 63 of file itkNDImageBase.h.

template<class TPixel >
typedef DataObjectType::Pointer itk::NDImageBase< TPixel >::DataObjectPointer

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

Definition at line 74 of file itkNDImageBase.h.

template<class TPixel >
typedef DataObject itk::NDImageBase< TPixel >::DataObjectType

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

Definition at line 71 of file itkNDImageBase.h.

template<class TPixel >
typedef Array<IndexValueType> itk::NDImageBase< TPixel >::IndexType

ND versions of the index and sizetypes. Unlike in their counterparts in the itk::Image, their size can be defined at runtime. The elx::NDImageTemplate takes care of converting from/to these types to to/from the corresponding types in itk::Image.

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

Definition at line 99 of file itkNDImageBase.h.

template<class TPixel >
typedef ImageBase<2>::IndexValueType itk::NDImageBase< TPixel >::IndexValueType

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

Definition at line 90 of file itkNDImageBase.h.

template<class TPixel >
typedef Image<TPixel,2>::InternalPixelType itk::NDImageBase< TPixel >::InternalPixelType

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

Definition at line 79 of file itkNDImageBase.h.

template<class TPixel >
typedef Array<OffsetValueType> itk::NDImageBase< TPixel >::OffsetType

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

Definition at line 103 of file itkNDImageBase.h.

template<class TPixel >
typedef ImageBase<2>::OffsetValueType itk::NDImageBase< TPixel >::OffsetValueType

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

Definition at line 92 of file itkNDImageBase.h.

template<class TPixel >
typedef Image<TPixel,2>::PixelContainer itk::NDImageBase< TPixel >::PixelContainer

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

Definition at line 81 of file itkNDImageBase.h.

template<class TPixel >
typedef Image<TPixel,2>::PixelContainerConstPointer itk::NDImageBase< TPixel >::PixelContainerConstPointer

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

Definition at line 83 of file itkNDImageBase.h.

template<class TPixel >
typedef Image<TPixel,2>::PixelContainerPointer itk::NDImageBase< TPixel >::PixelContainerPointer

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

Definition at line 82 of file itkNDImageBase.h.

template<class TPixel >
typedef Image<TPixel,2>::PixelType itk::NDImageBase< TPixel >::PixelType

Type definitions like normal itkImages, independent of the dimension

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

Definition at line 77 of file itkNDImageBase.h.

template<class TPixel >
typedef ImageBase<2>::PointType itk::NDImageBase< TPixel >::Point2DType

Definition at line 86 of file itkNDImageBase.h.

template<class TPixel >
typedef SmartPointer<Self> itk::NDImageBase< TPixel >::Pointer

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

Definition at line 62 of file itkNDImageBase.h.

template<class TPixel >
typedef Array<PointValueType> itk::NDImageBase< TPixel >::PointType

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

Definition at line 102 of file itkNDImageBase.h.

template<class TPixel >
typedef Point2DType::ValueType itk::NDImageBase< TPixel >::PointValueType

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

Definition at line 89 of file itkNDImageBase.h.

template<class TPixel >
typedef NDImageBase itk::NDImageBase< TPixel >::Self

Standard class typedefs.

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

Definition at line 60 of file itkNDImageBase.h.

template<class TPixel >
typedef Array<SizeValueType> itk::NDImageBase< TPixel >::SizeType

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

Definition at line 100 of file itkNDImageBase.h.

template<class TPixel >
typedef ImageBase<2>::SizeValueType itk::NDImageBase< TPixel >::SizeValueType

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

Definition at line 91 of file itkNDImageBase.h.

template<class TPixel >
typedef ImageBase<2>::SpacingType itk::NDImageBase< TPixel >::Spacing2DType

Definition at line 85 of file itkNDImageBase.h.

template<class TPixel >
typedef Array<SpacingValueType> itk::NDImageBase< TPixel >::SpacingType

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

Definition at line 101 of file itkNDImageBase.h.

template<class TPixel >
typedef Spacing2DType::ValueType itk::NDImageBase< TPixel >::SpacingValueType

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

Definition at line 88 of file itkNDImageBase.h.

template<class TPixel >
typedef Object itk::NDImageBase< TPixel >::Superclass

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

Definition at line 61 of file itkNDImageBase.h.

template<class TPixel >
typedef Image<TPixel,2>::ValueType itk::NDImageBase< TPixel >::ValueType

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

Definition at line 78 of file itkNDImageBase.h.


Constructor & Destructor Documentation

template<class TPixel >
itk::NDImageBase< TPixel >::NDImageBase ( ) [inline, protected]

Definition at line 197 of file itkNDImageBase.h.

template<class TPixel >
virtual itk::NDImageBase< TPixel >::~NDImageBase ( ) [inline, protected, virtual]

Definition at line 198 of file itkNDImageBase.h.

template<class TPixel >
itk::NDImageBase< TPixel >::NDImageBase ( const Self ) [private]

Member Function Documentation

template<class TPixel >
virtual void itk::NDImageBase< TPixel >::Allocate ( void  ) [pure virtual]
template<class TPixel >
virtual IndexType itk::NDImageBase< TPixel >::ComputeIndex ( OffsetValueType  offset) const [pure virtual]
template<class TPixel >
virtual OffsetValueType itk::NDImageBase< TPixel >::ComputeOffset ( const IndexType ind) const [pure virtual]
template<class TPixel >
virtual void itk::NDImageBase< TPixel >::CopyInformation ( const DataObject *  data) [pure virtual]
Todo:
Transform IndexToPoint methods.

Implemented in itk::NDImageTemplate< TPixel, VDimension >.

template<class TPixel >
virtual void itk::NDImageBase< TPixel >::CreateNewImage ( void  ) [pure virtual]

Use New method to create a new actual image

Implemented in itk::NDImageTemplate< TPixel, VDimension >.

template<class TPixel >
virtual void itk::NDImageBase< TPixel >::FillBuffer ( const TPixel &  value) [pure virtual]
template<class TPixel >
virtual TPixel* itk::NDImageBase< TPixel >::GetBufferPointer ( ) [pure virtual]
template<class TPixel >
virtual const TPixel* itk::NDImageBase< TPixel >::GetBufferPointer ( ) const [pure virtual]
template<class TPixel >
virtual const char* itk::NDImageBase< TPixel >::GetClassName ( ) const [virtual]

Method for creation through the object factory. Run-time type information (and related methods).

Reimplemented in itk::NDImageTemplate< TPixel, VDimension >.

template<class TPixel >
virtual DataObject* itk::NDImageBase< TPixel >::GetImage ( void  ) [pure virtual]

Get the actual image

Implemented in itk::NDImageTemplate< TPixel, VDimension >.

template<class TPixel >
virtual unsigned int itk::NDImageBase< TPixel >::GetImageDimension ( void  ) [pure virtual]
template<class TPixel >
virtual ImageIOBase* itk::NDImageBase< TPixel >::GetImageIOReader ( void  ) [pure virtual]
template<class TPixel >
virtual ImageIOBase* itk::NDImageBase< TPixel >::GetImageIOWriter ( void  ) [pure virtual]
template<class TPixel >
virtual const char* itk::NDImageBase< TPixel >::GetInputFileName ( void  ) [pure virtual]
template<class TPixel >
virtual const OffsetValueType* itk::NDImageBase< TPixel >::GetOffsetTable ( ) const [pure virtual]
template<class TPixel >
virtual PointType itk::NDImageBase< TPixel >::GetOrigin ( void  ) [pure virtual]
template<class TPixel >
virtual const char* itk::NDImageBase< TPixel >::GetOutputFileName ( void  ) [pure virtual]
template<class TPixel >
virtual const TPixel& itk::NDImageBase< TPixel >::GetPixel ( const IndexType index) const [pure virtual]
template<class TPixel >
virtual TPixel& itk::NDImageBase< TPixel >::GetPixel ( const IndexType index) [pure virtual]
template<class TPixel >
virtual AccessorType itk::NDImageBase< TPixel >::GetPixelAccessor ( void  ) [pure virtual]
template<class TPixel >
virtual const AccessorType itk::NDImageBase< TPixel >::GetPixelAccessor ( void  ) const [pure virtual]
template<class TPixel >
virtual PixelContainer* itk::NDImageBase< TPixel >::GetPixelContainer ( ) [pure virtual]
template<class TPixel >
virtual const PixelContainer* itk::NDImageBase< TPixel >::GetPixelContainer ( ) const [pure virtual]
template<class TPixel >
virtual ProcessObject* itk::NDImageBase< TPixel >::GetReader ( void  ) [pure virtual]
template<class TPixel >
virtual SpacingType itk::NDImageBase< TPixel >::GetSpacing ( void  ) [pure virtual]
template<class TPixel >
virtual ProcessObject* itk::NDImageBase< TPixel >::GetWriter ( void  ) [pure virtual]
template<class TPixel >
virtual unsigned int itk::NDImageBase< TPixel >::ImageDimension ( void  ) [pure virtual]

Extra functions for NDImage. Get the Dimension.

Implemented in itk::NDImageTemplate< TPixel, VDimension >.

template<class TPixel >
virtual void itk::NDImageBase< TPixel >::Initialize ( void  ) [pure virtual]
template<class TPixel >
NDImageBase< TPixel >::Pointer itk::NDImageBase< TPixel >::NewNDImage ( unsigned int  dim) [static]

Definition at line 219 of file itkNDImageBase.h.

template<class TPixel >
void itk::NDImageBase< TPixel >::operator= ( const Self ) [private]
template<class TPixel >
TPixel& itk::NDImageBase< TPixel >::operator[] ( const IndexType index) [inline]

Definition at line 131 of file itkNDImageBase.h.

template<class TPixel >
const TPixel& itk::NDImageBase< TPixel >::operator[] ( const IndexType index) const [inline]

Definition at line 133 of file itkNDImageBase.h.

template<class TPixel >
virtual void itk::NDImageBase< TPixel >::Read ( void  ) [pure virtual]

Read image data from file into the actual image

Implemented in itk::NDImageTemplate< TPixel, VDimension >.

template<class TPixel >
virtual void itk::NDImageBase< TPixel >::SetImageIOReader ( ImageIOBase _arg) [pure virtual]
template<class TPixel >
virtual void itk::NDImageBase< TPixel >::SetImageIOWriter ( ImageIOBase _arg) [pure virtual]
template<class TPixel >
virtual void itk::NDImageBase< TPixel >::SetInputFileName ( const char *  ) [pure virtual]
template<class TPixel >
virtual void itk::NDImageBase< TPixel >::SetOrigin ( const PointType origin) [pure virtual]
template<class TPixel >
virtual void itk::NDImageBase< TPixel >::SetOutputFileName ( const char *  ) [pure virtual]

Set/Get the Input/OutputFileName

Implemented in itk::NDImageTemplate< TPixel, VDimension >.

template<class TPixel >
virtual void itk::NDImageBase< TPixel >::SetPixel ( const IndexType index,
const TPixel &  value 
) [pure virtual]
template<class TPixel >
virtual void itk::NDImageBase< TPixel >::SetPixelContainer ( PixelContainer container) [pure virtual]
template<class TPixel >
virtual void itk::NDImageBase< TPixel >::SetRegions ( SizeType  size) [pure virtual]
Todo:
: extend to direction cosines; but not needed for now in elastix

Region typedef support. A region is used to specify a subset of an image.

Todo:
an NDRegionType should first be declared, in the same way as NDImage use SetRegions(size) for now. then knowlegde of the RegionType is not necessary. alternative: forget about the regiontype and add the functions SetLargestPossibleRegion, SetRegions etc with arguments (index,size) or maybe: ImageIORegion

Implemented in itk::NDImageTemplate< TPixel, VDimension >.

template<class TPixel >
virtual void itk::NDImageBase< TPixel >::SetRequestedRegion ( DataObject *  data) [pure virtual]
template<class TPixel >
virtual void itk::NDImageBase< TPixel >::SetSpacing ( const SpacingType spacing) [pure virtual]
template<class TPixel >
virtual void itk::NDImageBase< TPixel >::Write ( void  ) [pure virtual]

Write the actual image to file.

Implemented in itk::NDImageTemplate< TPixel, VDimension >.



Generated on 24-05-2012 for elastix by doxygen 1.7.6.1 elastix logo