itk::NthElementImageAdaptor< TImage, TOutputPixelType > Class Template Reference
[Image Adaptors]

#include <itkNthElementImageAdaptor.h>

Inheritance diagram for itk::NthElementImageAdaptor< TImage, TOutputPixelType >:

[legend]Collaboration diagram for itk::NthElementImageAdaptor< TImage, TOutputPixelType >:

[legend]List of all members.

---

Detailed Description

template<class TImage, class TOutputPixelType>
class itk::NthElementImageAdaptor< TImage, TOutputPixelType >

Presents an image as being composed of the N-th element of its pixels.

It assumes that the pixels are of container type and have in their API an operator[]( unsigned int ) defined.

Additional casting is performed according to the input and output image types following C++ default casting rules.

Definition at line 56 of file itkNthElementImageAdaptor.h.

Public Types
typedef DefaultPixelAccessorFunctor< Self >	AccessorFunctorType
typedef TAccessor	AccessorType
typedef SmartPointer< const Self >	ConstPointer
typedef WeakPointer< const Self >	ConstWeakPointer
typedef Superclass::IndexType	IndexType
typedef IndexType::IndexValueType	IndexValueType
typedef TImage	InternalImageType
typedef InternalPixelType *	InternalPixelPointerType
typedef TAccessor::InternalType	InternalPixelType
typedef PixelType	IOPixelType
typedef Superclass::OffsetType	OffsetType
typedef OffsetType::OffsetValueType	OffsetValueType
typedef TImage::PixelContainer	PixelContainer
typedef TImage::PixelContainerConstPointer	PixelContainerConstPointer
typedef TImage::PixelContainerPointer	PixelContainerPointer
typedef TAccessor::ExternalType	PixelType
typedef SmartPointer< Self >	Pointer
typedef Superclass::PointType	PointType
typedef Superclass::RegionType	RegionType
typedef NthElementImageAdaptor	Self
typedef Superclass::SizeType	SizeType
typedef SizeType::SizeValueType	SizeValueType
typedef Superclass::SpacingType	SpacingType
typedef NthElementImageAdaptorHelper< TImage, TOutputPixelType >::Super	Superclass
Public Member Functions
void	Allocate ()
IndexType	ComputeIndex (OffsetValueType offset) const
virtual void	CopyInformation (const DataObject *data)
virtual const RegionType &	GetBufferedRegion () const
const InternalPixelType *	GetBufferPointer () const
Return a pointer to the beginning of the buffer This is used by *the image iterator class *InternalPixelType *	GetBufferPointer ()
virtual const RegionType &	GetLargestPossibleRegion () const
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
const OffsetValueType *	GetOffsetTable () const
virtual const PointType &	GetOrigin () const
PixelType	GetPixel (const IndexType &index) const
const AccessorType &	GetPixelAccessor (void) const
AccessorType &	GetPixelAccessor (void)
PixelContainerPointer	GetPixelContainer ()
virtual const RegionType &	GetRequestedRegion () const
virtual const SpacingType &	GetSpacing () const
virtual void	Graft (const DataObject *data)
virtual void	Initialize ()
	itkStaticConstMacro (ImageDimension, unsigned int, TImage::ImageDimension)
virtual void	Modified () const
PixelType	operator[] (const IndexType &index) const
virtual void	PropagateRequestedRegion () throw (InvalidRequestedRegionError)
Select the element number to be accessed *void	SelectNthElement (unsigned int nth)
virtual void	SetBufferedRegion (const RegionType &region)
virtual void	SetImage (TImage *)
virtual void	SetLargestPossibleRegion (const RegionType &region)
virtual void	SetOrigin (const float *values)
virtual void	SetOrigin (const double *values)
Set the origin of the image *virtual void	SetOrigin (const PointType values)
void	SetPixel (const IndexType &index, const PixelType &value)
void	SetPixelAccessor (const AccessorType &accessor)
void	SetPixelContainer (PixelContainer *container)
virtual void	SetRequestedRegion (DataObject *data)
virtual void	SetRequestedRegion (const RegionType &region)
virtual void	SetRequestedRegionToLargestPossibleRegion ()
virtual void	SetSpacing (const float *values)
virtual void	SetSpacing (const double *values)
Set the	spacing (size of a pixel) of the image.*/virtual void SetSpacing(const SpacingType values)
Return the Data Accesor object *virtual void	Update ()
virtual void	UpdateOutputData ()
Methods to update the pipeline Called internally by the *pipeline mechanism *virtual void	UpdateOutputInformation ()
virtual bool	VerifyRequestedRegion ()
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
	NthElementImageAdaptor ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~NthElementImageAdaptor ()

---

Member Typedef Documentation

template<class TImage, class TAccessor> typedef DefaultPixelAccessorFunctor< Self > itk::ImageAdaptor< TImage, TAccessor >::AccessorFunctorType [inherited]

typedef of the functor that chooses the appropriate accessor Image or VectorImage. Definition at line 90 of file itkImageAdaptor.h.

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

Accessor type that convert data between internal and external representations. Definition at line 86 of file itkImageAdaptor.h.

template<class TImage, class TOutputPixelType> typedef SmartPointer<const Self> itk::NthElementImageAdaptor< TImage, TOutputPixelType >::ConstPointer

Reimplemented from itk::ImageAdaptor< TImage, TAccessor >. Definition at line 63 of file itkNthElementImageAdaptor.h.

template<class TImage, class TAccessor> typedef WeakPointer<const Self> itk::ImageAdaptor< TImage, TAccessor >::ConstWeakPointer [inherited]

Definition at line 63 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> typedef Superclass::IndexType itk::ImageAdaptor< TImage, TAccessor >::IndexType [inherited]

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

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

Definition at line 94 of file itkImageAdaptor.h.

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

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

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

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

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

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

template<class TImage, class TAccessor> typedef PixelType itk::ImageAdaptor< TImage, TAccessor >::IOPixelType [inherited]

Reimplemented in itk::VectorImageToImageAdaptor. Definition at line 82 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> typedef Superclass::OffsetType itk::ImageAdaptor< TImage, TAccessor >::OffsetType [inherited]

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

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

Definition at line 102 of file itkImageAdaptor.h.

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

PixelContainer typedef support. Used to construct a container for the pixel data. Reimplemented in itk::RGBToVectorImageAdaptor< TImage >, itk::VectorImageToImageAdaptor, and itk::VectorToRGBImageAdaptor< TImage >. Definition at line 193 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> typedef TImage::PixelContainerConstPointer itk::ImageAdaptor< TImage, TAccessor >::PixelContainerConstPointer [inherited]

Reimplemented in itk::RGBToVectorImageAdaptor< TImage >, itk::VectorImageToImageAdaptor, and itk::VectorToRGBImageAdaptor< TImage >. Definition at line 195 of file itkImageAdaptor.h.

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

Reimplemented in itk::RGBToVectorImageAdaptor< TImage >, itk::VectorImageToImageAdaptor, and itk::VectorToRGBImageAdaptor< TImage >. Definition at line 194 of file itkImageAdaptor.h.

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

Pixel typedef support. Used to declare pixel type in filters or other operations. Reimplemented in itk::AddImageAdaptor< TImage >. Definition at line 72 of file itkImageAdaptor.h.

template<class TImage, class TOutputPixelType> typedef SmartPointer<Self> itk::NthElementImageAdaptor< TImage, TOutputPixelType >::Pointer

Reimplemented from itk::ImageAdaptor< TImage, TAccessor >. Definition at line 62 of file itkNthElementImageAdaptor.h.

template<class TImage, class TAccessor> typedef Superclass::PointType itk::ImageAdaptor< TImage, TAccessor >::PointType [inherited]

Origin typedef support. The origin is the geometric coordinates of the index (0,0). Definition at line 114 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> typedef Superclass::RegionType itk::ImageAdaptor< TImage, TAccessor >::RegionType [inherited]

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

template<class TImage, class TOutputPixelType> typedef NthElementImageAdaptor itk::NthElementImageAdaptor< TImage, TOutputPixelType >::Self

Standard class typedefs. Reimplemented from itk::ImageAdaptor< TImage, TAccessor >. Definition at line 60 of file itkNthElementImageAdaptor.h.

template<class TImage, class TAccessor> typedef Superclass::SizeType itk::ImageAdaptor< TImage, TAccessor >::SizeType [inherited]

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

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

Definition at line 98 of file itkImageAdaptor.h.

template<class TImage, class TAccessor> typedef Superclass::SpacingType itk::ImageAdaptor< TImage, TAccessor >::SpacingType [inherited]

Spacing typedef support. Spacing holds the size of a pixel. The spacing is the geometric distance between image samples. Definition at line 110 of file itkImageAdaptor.h.

template<class TImage, class TOutputPixelType> typedef NthElementImageAdaptorHelper<TImage, TOutputPixelType>::Super itk::NthElementImageAdaptor< TImage, TOutputPixelType >::Superclass

Reimplemented from itk::ImageAdaptor< TImage, TAccessor >. Definition at line 61 of file itkNthElementImageAdaptor.h.

---

Constructor & Destructor Documentation

template<class TImage, class TOutputPixelType> itk::NthElementImageAdaptor< TImage, TOutputPixelType >::NthElementImageAdaptor (   )  [inline, protected]

Definition at line 78 of file itkNthElementImageAdaptor.h.

template<class TImage, class TOutputPixelType> virtual itk::NthElementImageAdaptor< TImage, TOutputPixelType >::~NthElementImageAdaptor (   )  [inline, protected, virtual]

Definition at line 79 of file itkNthElementImageAdaptor.h.

---

Member Function Documentation

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

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 [inherited]

Compute Index given an Offset

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

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

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 [inherited]

template<class TImage, class TAccessor> Return a pointer to the beginning of the buffer This is used by* the image iterator class* InternalPixelType* itk::ImageAdaptor< TImage, TAccessor >::GetBufferPointer (   )  [inherited]

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

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, inherited]

Delegate GetMTime to the Internal Image

template<class TImage, class TOutputPixelType> virtual const char* itk::NthElementImageAdaptor< TImage, TOutputPixelType >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::ImageAdaptor< TImage, TAccessor >.

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

Get the OffsetTable from the adapted image

template<class TImage, class TAccessor> virtual const PointType& itk::ImageAdaptor< TImage, TAccessor >::GetOrigin (   )  const [virtual, inherited]

Get the origin of the image. The origin is the geometric coordinates of the image origin. See also: SetOrigin()

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

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

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

Return the Data Accesor object Definition at line 262 of file itkImageAdaptor.h.

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

Return the Data Accesor object Definition at line 258 of file itkImageAdaptor.h.

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

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

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

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 SpacingType& itk::ImageAdaptor< TImage, TAccessor >::GetSpacing (   )  const [virtual, inherited]

Get the spacing (size of a pixel) of the image. The spacing is the geometric distance between image samples. See also: SetSpacing()

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

Graft the data and information from one image to another. This is a convenience method to setup a second image with all the meta information of another image and use the same pixel container. Note that this method is different than just using two SmartPointers to the same image since separate DataObjects are still maintained. This method is similar to ImageSource::GraftOutput(). The implementation in ImageBase simply calls CopyInformation() and copies the region ivars. The implementation here refers to the superclass' implementation and then copies over the pixel container.

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

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  )  [inherited]

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, inherited]

Delegate Modified to the Internal Image

template<class TImage, class TOutputPixelType> static Pointer itk::NthElementImageAdaptor< TImage, TOutputPixelType >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::ImageAdaptor< TImage, TAccessor >.

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

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

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

template<class TImage, class TAccessor> virtual void itk::ImageAdaptor< TImage, TAccessor >::PropagateRequestedRegion (   )  throw (InvalidRequestedRegionError) [virtual, inherited]

template<class TImage, class TOutputPixelType> Select the element number to be accessed* void itk::NthElementImageAdaptor< TImage, TOutputPixelType >::SelectNthElement (  unsigned int  nth  )  [inline]

Definition at line 72 of file itkNthElementImageAdaptor.h.

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

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, inherited]

Set Internal Image

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

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  )  [virtual, inherited]

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

template<class TImage, class TAccessor> Set the origin of the image* virtual void itk::ImageAdaptor< TImage, TAccessor >::SetOrigin (  const PointType  values  )  [virtual, inherited]

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

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

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

Sets the Data Accesor object Definition at line 266 of file itkImageAdaptor.h.

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

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, inherited]

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, inherited]

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, inherited]

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

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

template<class TImage, class TAccessor> Set the itk::ImageAdaptor< TImage, TAccessor >::spacing (  size of a  pixel  )  const [inherited]

template<class TImage, class TAccessor> Return the Data Accesor object* virtual void itk::ImageAdaptor< TImage, TAccessor >::Update (   )  [virtual, inherited]

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

template<class TImage, class TAccessor> Methods to update the pipeline Called internally by the* pipeline mechanism* virtual void itk::ImageAdaptor< TImage, TAccessor >::UpdateOutputInformation (   )  [virtual, inherited]

template<class TImage, class TAccessor> virtual bool itk::ImageAdaptor< TImage, TAccessor >::VerifyRequestedRegion (   )  [virtual, inherited]

---

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

• itkNthElementImageAdaptor.h

---