itk::ImageAdaptor< TImage, TAccessor > Class Template Reference
[Image Adaptors]

Give access to partial aspects of voxels from an Image. More...

#include <itkImageAdaptor.h>

Collaboration diagram for itk::ImageAdaptor< TImage, TAccessor >:

[legend]List of all members.

Public Types
typedef ImageAdaptor	Self
typedef ImageBase< itkGetStaticConstMacro(ImageDimension)	Superclass )
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TImage	InternalImageType
typedef TAccessor::ExternalType	PixelType
typedef TAccessor::InternalType	InternalPixelType
typedef TAccessor	AccessorType
typedef Index< itkGetStaticConstMacro(ImageDimension)	IndexType )
typedef IndexType::IndexValueType	IndexValueType
typedef Size< itkGetStaticConstMacro(ImageDimension)	SizeType )
typedef SizeType::SizeValueType	SizeValueType
typedef Offset< itkGetStaticConstMacro(ImageDimension)	OffsetType )
typedef OffsetType::OffsetValueType	OffsetValueType
typedef ImageRegion< itkGetStaticConstMacro(ImageDimension)	RegionType )
typedef TImage::PixelContainer	PixelContainer
typedef TImage::PixelContainerPointer	PixelContainerPointer
typedef InternalPixelType *	InternalPixelPointerType
Public Member Functions
	itkStaticConstMacro (ImageDimension, unsigned int, TImage::ImageDimension)
virtual const char *	GetClassName () const
virtual void	SetLargestPossibleRegion (const RegionType &region)
virtual void	SetBufferedRegion (const RegionType &region)
virtual void	SetRequestedRegion (const RegionType &region)
virtual void	SetRequestedRegion (DataObject *data)
virtual const RegionType &	GetRequestedRegion () const
virtual const RegionType &	GetLargestPossibleRegion () const
virtual const RegionType &	GetBufferedRegion () const
void	Allocate ()
virtual void	Initialize ()
void	SetPixel (const IndexType &index, const PixelType &value)
PixelType	GetPixel (const IndexType &index) const
PixelType	operator[] (const IndexType &index) const
const OffsetValueType *	GetOffsetTable () const
IndexType	ComputeIndex (OffsetValueType offset) const
PixelContainerPointer	GetPixelContainer ()
void	SetPixelContainer (PixelContainer *container)
virtual const double *	GetSpacing () const
virtual const double *	GetOrigin () const
virtual void	SetImage (TImage *)
virtual void	Modified () const
virtual unsigned long	GetMTime () const
AccessorType &	GetPixelAccessor (void)
const AccessorType &	GetPixelAccessor (void) const
void	SetPixelAccessor (const AccessorType &accessor)
InternalPixelType *	GetBufferPointer ()
const InternalPixelType *	GetBufferPointer () const
void	GetBufferPointer2 (InternalPixelPointerType &)
virtual void	SetSpacing (const double values[ImageDimension])
virtual void	SetSpacing (const float values[ImageDimension])
virtual void	SetOrigin (const double values[ImageDimension])
virtual void	SetOrigin (const float values[ImageDimension])
virtual void	Update ()
virtual void	UpdateOutputInformation ()
virtual void	SetRequestedRegionToLargestPossibleRegion ()
virtual void	CopyInformation (const DataObject *data)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	ImageAdaptor ()
virtual	~ImageAdaptor ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

template<class TImage, class TAccessor>
class itk::ImageAdaptor< TImage, TAccessor >

Give access to partial aspects of voxels from an Image.

ImageAdaptors are templated over the ImageType and over a functor that will specify what part of the pixel can be accessed

The basic aspects of this class are the types it defines.

Image adaptors can be used as intermediate classes that allow the sending of an image to a filter, specifying what part of the image pixels the filter will act on.

The TAccessor class should implement the Get and Set methods as static methods. These two will specify how data can be put and get from parts of each pixel. It should define the types ExternalType and InternalType too.

Definition at line 47 of file itkImageAdaptor.h.

---

Member Typedef Documentation

template<class TImage, class TAccessor> typedef TAccessor itk::ImageAdaptor< TImage, TAccessor >::AccessorType

Accessor type that convert data between internal and external representations. Definition at line 82 of file itkImageAdaptor.h. Referenced by itk::ImageAdaptor< TImage, TAccessor >::GetPixelAccessor(), and itk::ImageAdaptor< TImage, TAccessor >::SetPixelAccessor().

template<class TImage, class TAccessor> typedef SmartPointer<const Self> itk::ImageAdaptor< TImage, TAccessor >::ConstPointer

Definition at line 61 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> typedef Index<itkGetStaticConstMacro(ImageDimension) itk::ImageAdaptor< TImage, TAccessor >::IndexType)

Index typedef support. An index is used to access pixel values. Definition at line 85 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> typedef IndexType::IndexValueType itk::ImageAdaptor< TImage, TAccessor >::IndexValueType

Definition at line 86 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> typedef TImage itk::ImageAdaptor< TImage, TAccessor >::InternalImageType

Typedef of unadapted image Definition at line 67 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> typedef InternalPixelType* itk::ImageAdaptor< TImage, TAccessor >::InternalPixelPointerType

Convenient typedef. Definition at line 189 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> typedef TAccessor::InternalType itk::ImageAdaptor< TImage, TAccessor >::InternalPixelType

Pixel typedef support. Used to declare pixel type in filters or other operations. Definition at line 78 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> typedef Offset<itkGetStaticConstMacro(ImageDimension) itk::ImageAdaptor< TImage, TAccessor >::OffsetType)

Offset typedef support. Definition at line 93 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> typedef OffsetType::OffsetValueType itk::ImageAdaptor< TImage, TAccessor >::OffsetValueType

Definition at line 94 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> typedef TImage::PixelContainer itk::ImageAdaptor< TImage, TAccessor >::PixelContainer

PixelContainer typedef support. Used to construct a container for the pixel data. Definition at line 177 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> typedef TImage::PixelContainerPointer itk::ImageAdaptor< TImage, TAccessor >::PixelContainerPointer

Definition at line 178 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> typedef TAccessor::ExternalType itk::ImageAdaptor< TImage, TAccessor >::PixelType

Pixel typedef support. Used to declare pixel type in filters or other operations. Definition at line 74 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> typedef SmartPointer<Self> itk::ImageAdaptor< TImage, TAccessor >::Pointer

Definition at line 60 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> typedef ImageRegion<itkGetStaticConstMacro(ImageDimension) itk::ImageAdaptor< TImage, TAccessor >::RegionType)

Region typedef support. A region is used to specify a subset of an image. Definition at line 98 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> typedef ImageAdaptor itk::ImageAdaptor< TImage, TAccessor >::Self

Standard class typedefs. Definition at line 58 of file itkImageAdaptor.h. Referenced by itk::ImageAdaptor< TImage, TAccessor >::SetPixelAccessor().

template<class TImage, class TAccessor> typedef Size<itkGetStaticConstMacro(ImageDimension) itk::ImageAdaptor< TImage, TAccessor >::SizeType)

Size typedef support. A size is used to define region bounds. Definition at line 89 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> typedef SizeType::SizeValueType itk::ImageAdaptor< TImage, TAccessor >::SizeValueType

Definition at line 90 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> typedef ImageBase<itkGetStaticConstMacro(ImageDimension) itk::ImageAdaptor< TImage, TAccessor >::Superclass)

Definition at line 59 of file itkImageAdaptor.h.

---

Constructor & Destructor Documentation

template<class TImage, class TAccessor> itk::ImageAdaptor< TImage, TAccessor >::ImageAdaptor (   )  [protected]

template<class TImage, class TAccessor> virtual itk::ImageAdaptor< TImage, TAccessor >::~ImageAdaptor (   )  [protected, virtual]

---

Member Function Documentation

template<class TImage, class TAccessor> void itk::ImageAdaptor< TImage, TAccessor >::Allocate (   )  [inline]

Allocate the image memory. Dimension and Size must be set a priori.

template<class TImage, class TAccessor> IndexType itk::ImageAdaptor< TImage, TAccessor >::ComputeIndex (  OffsetValueType  offset  )  const

Compute Index given an Offset

template<class TImage, class TAccessor> virtual void itk::ImageAdaptor< TImage, TAccessor >::CopyInformation (  const DataObject *  data  )  [virtual]

Return the Data Accesor object

template<class TImage, class TAccessor> virtual const RegionType& itk::ImageAdaptor< TImage, TAccessor >::GetBufferedRegion (   )  const [virtual]

Get the region object that defines the size and starting index of the region of the image currently loaded in memory. This method overloads the one in ImageBase in order to delegate to the adapted image. See also: ImageRegion, SetLargestPossibleRegion(), SetRequestedRegion()

template<class TImage, class TAccessor> const InternalPixelType* itk::ImageAdaptor< TImage, TAccessor >::GetBufferPointer (   )  const

Return a pointer to the beginning of the buffer. This is used by the image iterator class.

template<class TImage, class TAccessor> InternalPixelType* itk::ImageAdaptor< TImage, TAccessor >::GetBufferPointer (   )

Return a pointer to the beginning of the buffer. This is used by the image iterator class.

template<class TImage, class TAccessor> void itk::ImageAdaptor< TImage, TAccessor >::GetBufferPointer2 (  InternalPixelPointerType &   )

Return a pointer to the beginning of the buffer. This is used by the image iterator class.

template<class TImage, class TAccessor> virtual const char* itk::ImageAdaptor< TImage, TAccessor >::GetClassName (   )  const [virtual]

Run-time type information (and related methods).

template<class TImage, class TAccessor> virtual const RegionType& itk::ImageAdaptor< TImage, TAccessor >::GetLargestPossibleRegion (   )  const [virtual]

Get the region object that defines the size and starting index for the largest possible region this image could represent. This is used in determining how much memory would be needed to load an entire dataset. It is also used to determine boundary conditions. This method overloads the one in ImageBase in order to delegate to the adapted image. See also: ImageRegion, GetBufferedRegion(), GetRequestedRegion()

template<class TImage, class TAccessor> virtual unsigned long itk::ImageAdaptor< TImage, TAccessor >::GetMTime (   )  const [virtual]

Delegate GetMTime to the Internal Image

template<class TImage, class TAccessor> const OffsetValueType* itk::ImageAdaptor< TImage, TAccessor >::GetOffsetTable (   )  const

Get the OffsetTable from the adapted image

template<class TImage, class TAccessor> virtual const double* itk::ImageAdaptor< TImage, TAccessor >::GetOrigin (   )  const [virtual]

Get the origin of the image. The origin is the geometric coordinates of the image origin. The value returned is a pointer to a double array. See also: SetOrigin()

template<class TImage, class TAccessor> PixelType itk::ImageAdaptor< TImage, TAccessor >::GetPixel (  const IndexType &  index  )  const [inline]

Get a pixel (read only version) Definition at line 162 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> const AccessorType& itk::ImageAdaptor< TImage, TAccessor >::GetPixelAccessor (  void   )  const [inline]

Return the Data Accesor object Definition at line 234 of file itkImageAdaptor.h. References itk::ImageAdaptor< TImage, TAccessor >::AccessorType.

template<class TImage, class TAccessor> AccessorType& itk::ImageAdaptor< TImage, TAccessor >::GetPixelAccessor (  void   )  [inline]

Return the Data Accesor object Definition at line 230 of file itkImageAdaptor.h. References itk::ImageAdaptor< TImage, TAccessor >::AccessorType.

template<class TImage, class TAccessor> PixelContainerPointer itk::ImageAdaptor< TImage, TAccessor >::GetPixelContainer (   )  [inline]

Return a pointer to the container. Definition at line 181 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> virtual const RegionType& itk::ImageAdaptor< TImage, TAccessor >::GetRequestedRegion (   )  const [virtual]

Get the region object that defines the size and starting index for the region of the image requested (i.e., the region of the image to be operated on by a filter). This method overloads the one in ImageBase in order to delegate to the adapted image. See also: ImageRegion, SetLargestPossibleRegion(), SetBufferedRegion()

template<class TImage, class TAccessor> virtual const double* itk::ImageAdaptor< TImage, TAccessor >::GetSpacing (   )  const [virtual]

Get the spacing (size of a pixel) of the image. The spacing is the geometric distance between image samples. The value returned is a pointer to a double array. See also: SetSpacing()

template<class TImage, class TAccessor> virtual void itk::ImageAdaptor< TImage, TAccessor >::Initialize (   )  [virtual]

Restore the data object to its initial state. This means releasing memory.

template<class TImage, class TAccessor> itk::ImageAdaptor< TImage, TAccessor >::itkStaticConstMacro (  ImageDimension  , unsigned  int, TImage::ImageDimension  )

Dimension of the image. This constant is used by functions that are templated over image type (as opposed to being templated over pixel type and dimension) when they need compile time access to the dimension of the image.

template<class TImage, class TAccessor> virtual void itk::ImageAdaptor< TImage, TAccessor >::Modified (   )  const [virtual]

Delegate Modified to the Internal Image

template<class TImage, class TAccessor> Pointer itk::ImageAdaptor< TImage, TAccessor >::New (   )  [static]

Method for creation through the object factory.

template<class TImage, class TAccessor> PixelType itk::ImageAdaptor< TImage, TAccessor >::operator[] (  const IndexType &  index  )  const [inline]

Access a pixel. This version can only be an rvalue. Definition at line 166 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> void itk::ImageAdaptor< TImage, TAccessor >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected]

template<class TImage, class TAccessor> virtual void itk::ImageAdaptor< TImage, TAccessor >::SetBufferedRegion (  const RegionType &  region  )  [virtual]

Set the region object that defines the size and starting index of the region of the image currently load in memory. See also: ImageRegion, SetLargestPossibleRegion(), SetRequestedRegion()

template<class TImage, class TAccessor> virtual void itk::ImageAdaptor< TImage, TAccessor >::SetImage (  TImage *   )  [virtual]

Set Internal Image

template<class TImage, class TAccessor> virtual void itk::ImageAdaptor< TImage, TAccessor >::SetLargestPossibleRegion (  const RegionType &  region  )  [virtual]

Set the region object that defines the size and starting index for the largest possible region this image could represent. This is used in determining how much memory would be needed to load an entire dataset. It is also used to determine boundary conditions. See also: ImageRegion, SetBufferedRegion(), SetRequestedRegion()

template<class TImage, class TAccessor> virtual void itk::ImageAdaptor< TImage, TAccessor >::SetOrigin (  const float  values[ImageDimension]  )  [virtual]

Set the origin of the image.

template<class TImage, class TAccessor> virtual void itk::ImageAdaptor< TImage, TAccessor >::SetOrigin (  const double  values[ImageDimension]  )  [virtual]

Set the origin of the image.

template<class TImage, class TAccessor> void itk::ImageAdaptor< TImage, TAccessor >::SetPixel (  const IndexType &  index, const PixelType &  value )  [inline]

Set a pixel. Definition at line 158 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> void itk::ImageAdaptor< TImage, TAccessor >::SetPixelAccessor (  const AccessorType &  accessor  )  [inline]

Sets the Data Accesor object Definition at line 238 of file itkImageAdaptor.h. References itk::ImageAdaptor< TImage, TAccessor >::AccessorType, and itk::ImageAdaptor< TImage, TAccessor >::Self.

template<class TImage, class TAccessor> void itk::ImageAdaptor< TImage, TAccessor >::SetPixelContainer (  PixelContainer *  container  )

Set the container to use. Note that this does not cause the DataObject to be modified.

template<class TImage, class TAccessor> virtual void itk::ImageAdaptor< TImage, TAccessor >::SetRequestedRegion (  DataObject *  data  )  [virtual]

Set the requested region from this data object to match the requested region of the data object passed in as a parameter. This method implements the API from DataObject. The data object parameter must be castable to an ImageBase.

template<class TImage, class TAccessor> virtual void itk::ImageAdaptor< TImage, TAccessor >::SetRequestedRegion (  const RegionType &  region  )  [virtual]

Set the region object that defines the size and starting index for the region of the image requested. See also: ImageRegion, SetLargestPossibleRegion(), SetBufferedRegion()

template<class TImage, class TAccessor> virtual void itk::ImageAdaptor< TImage, TAccessor >::SetRequestedRegionToLargestPossibleRegion (   )  [virtual]

Return the Data Accesor object

template<class TImage, class TAccessor> virtual void itk::ImageAdaptor< TImage, TAccessor >::SetSpacing (  const float  values[ImageDimension]  )  [virtual]

Set the spacing (size of a pixel) of the image.

template<class TImage, class TAccessor> virtual void itk::ImageAdaptor< TImage, TAccessor >::SetSpacing (  const double  values[ImageDimension]  )  [virtual]

Set the spacing (size of a pixel) of the image.

template<class TImage, class TAccessor> virtual void itk::ImageAdaptor< TImage, TAccessor >::Update (   )  [virtual]

Return the Data Accesor object

template<class TImage, class TAccessor> virtual void itk::ImageAdaptor< TImage, TAccessor >::UpdateOutputInformation (   )  [virtual]

Return the Data Accesor object

---

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

• itkImageAdaptor.h

---