itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector > Class Template Reference

This class provides ListSampleBase interfaces to ITK Image. More...

#include <itkImageToListAdaptor.h>

Inheritance diagram for itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >:

[legend]Collaboration diagram for itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >:

[legend]List of all members.

Public Types
typedef ImageToListAdaptor	Self
typedef ListSampleBase< TMeasurementVector >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TImage	ImageType
typedef ImageType::Pointer	ImagePointer
typedef ImageType::ConstPointer	ImageConstPointer
typedef ImageType::IndexType	IndexType
typedef ImageType::PixelType	PixelType
typedef ImageType::PixelContainerConstPointer	PixelContainerConstPointer
typedef ImageType::PixelContainer::ElementIdentifier	InstanceIdentifier
typedef ImageRegionIterator< ImageType >	IteratorType
typedef PixelTraits< typename TImage::PixelType >	PixelTraitsType
typedef PixelTraitsType::ValueType	MeasurementType
typedef Superclass::FrequencyType	FrequencyType
typedef TMeasurementVector	MeasurementVectorType
typedef MeasurementVectorType	ValueType
Public Member Functions
virtual const char *	GetClassName () const
	itkStaticConstMacro (MeasurementVectorSize, unsigned int, PixelTraitsType::Dimension)
void	SetImage (const TImage *image)
const TImage *	GetImage () const
unsigned int	Size () const
virtual const MeasurementVectorType &	GetMeasurementVector (const InstanceIdentifier &id) const
FrequencyType	GetFrequency (const InstanceIdentifier &id) const
FrequencyType	GetTotalFrequency () const
Iterator	Begin ()
Iterator	End ()
ConstIterator	Begin () const
ConstIterator	End () const
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	ImageToListAdaptor ()
virtual	~ImageToListAdaptor ()
void	PrintSelf (std::ostream &os, Indent indent) const
Protected Attributes
PixelContainerConstPointer	m_PixelContainer
bool	m_UseBuffer
TImage::IndexType	m_ImageBeginIndex
TImage::IndexType	m_ImageEndIndex

---

Detailed Description

template<class TImage, class TMeasurementVector = typename TImage::PixelType>
class itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >

This class provides ListSampleBase interfaces to ITK Image.

After calling SetImage( const Image * ) method to plug in the image object, users can use Sample interfaces to access Image data. However, the resulting data are a list of measurement vectors. The type of data is measurement vector. For example, if the pixel type of Image object is STL vector< float > and each pixel has two different types of measurements, intensity and gradient magnitude, this adaptor has measurement vector of type ITK Point< float, 2>, and one element of the Point is intensity and the other is gradient magnitude.

There are two concepts of dimensions for this container. One is for Image object, and the other is for measurement vector dimension. Only when using ITK Index to access data, the former concept is applicable Otherwise, dimensions means dimensions of measurement vectors.

From the above example, there were two elements in a pixel and each pixel provides [] operator for accessing its elements. However, in many cases, The pixel might be a scalar value such as int or float. In this case, The pixel doesn't support [] operator. To deal with this problem, This class has two companion classes, ScalarAccessor and VectorAccessor. If the pixel type is a scalar type, then you don't have change the third template argument. If you have pixel type is vector one and supports [] operator, then replace third argument with VectorAccessor

See also:

Sample, ListSampleBase

Definition at line 65 of file itkImageToListAdaptor.h.

---

Member Typedef Documentation

template<class TImage, class TMeasurementVector = typename TImage::PixelType> typedef SmartPointer<const Self> itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::ConstPointer

Reimplemented from itk::Statistics::Sample< TMeasurementVector >. Definition at line 73 of file itkImageToListAdaptor.h. Referenced by itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::ConstIterator::ConstIterator().

template<class TImage, class TMeasurementVector = typename TImage::PixelType> typedef Superclass::FrequencyType itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::FrequencyType

frequency value typedef Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 102 of file itkImageToListAdaptor.h. Referenced by itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::ConstIterator::GetFrequency(), and itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::Iterator::GetFrequency().

template<class TImage, class TMeasurementVector = typename TImage::PixelType> typedef ImageType::ConstPointer itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::ImageConstPointer

Definition at line 84 of file itkImageToListAdaptor.h.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> typedef ImageType::Pointer itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::ImagePointer

Definition at line 83 of file itkImageToListAdaptor.h.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> typedef TImage itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::ImageType

Image typedefs Definition at line 82 of file itkImageToListAdaptor.h.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> typedef ImageType::IndexType itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::IndexType

Definition at line 85 of file itkImageToListAdaptor.h.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> typedef ImageType::PixelContainer::ElementIdentifier itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::InstanceIdentifier

Instance Identifier typedef support this identifier will be unique sequential id for each measurement vector in a Sample subclass. Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 89 of file itkImageToListAdaptor.h. Referenced by itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::ConstIterator::ConstIterator(), itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::ConstIterator::GetInstanceIdentifier(), itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::Iterator::GetInstanceIdentifier(), and itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::Iterator::Iterator().

template<class TImage, class TMeasurementVector = typename TImage::PixelType> typedef ImageRegionIterator< ImageType > itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::IteratorType

Image Iterator typedef support Definition at line 92 of file itkImageToListAdaptor.h.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> typedef PixelTraitsType::ValueType itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::MeasurementType

Superclass typedefs for Measurement vector, measurement, Instance Identifier, frequency, size, size element value Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 101 of file itkImageToListAdaptor.h.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> typedef TMeasurementVector itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::MeasurementVectorType

Superclass typedefs for Measurement vector, measurement, Instance Identifier, frequency, size, size element value Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 104 of file itkImageToListAdaptor.h. Referenced by itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::ConstIterator::GetMeasurementVector(), and itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::Iterator::GetMeasurementVector().

template<class TImage, class TMeasurementVector = typename TImage::PixelType> typedef ImageType::PixelContainerConstPointer itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::PixelContainerConstPointer

Definition at line 87 of file itkImageToListAdaptor.h.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> typedef PixelTraits< typename TImage::PixelType > itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::PixelTraitsType

Definition at line 93 of file itkImageToListAdaptor.h.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> typedef ImageType::PixelType itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::PixelType

Definition at line 86 of file itkImageToListAdaptor.h.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> typedef SmartPointer< Self > itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::Pointer

Reimplemented from itk::Statistics::Sample< TMeasurementVector >. Definition at line 72 of file itkImageToListAdaptor.h. Referenced by itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::Iterator::Iterator().

template<class TImage, class TMeasurementVector = typename TImage::PixelType> typedef ImageToListAdaptor itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::Self

Standard class typedefs Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 70 of file itkImageToListAdaptor.h.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> typedef ListSampleBase< TMeasurementVector > itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::Superclass

Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 71 of file itkImageToListAdaptor.h.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> typedef MeasurementVectorType itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::ValueType

Definition at line 105 of file itkImageToListAdaptor.h.

---

Constructor & Destructor Documentation

template<class TImage, class TMeasurementVector = typename TImage::PixelType> itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::ImageToListAdaptor (   )  [protected]

template<class TImage, class TMeasurementVector = typename TImage::PixelType> virtual itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::~ImageToListAdaptor (   )  [inline, protected, virtual]

Definition at line 278 of file itkImageToListAdaptor.h.

---

Member Function Documentation

template<class TImage, class TMeasurementVector = typename TImage::PixelType> ConstIterator itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::Begin (  void   )  const [inline]

Definition at line 264 of file itkImageToListAdaptor.h.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> Iterator itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::Begin (  void   )  [inline]

Definition at line 252 of file itkImageToListAdaptor.h.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> ConstIterator itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::End (  void   )  const [inline]

Definition at line 270 of file itkImageToListAdaptor.h.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> Iterator itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::End (  void   )  [inline]

Definition at line 258 of file itkImageToListAdaptor.h.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> virtual const char* itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::GetClassName (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> FrequencyType itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::GetFrequency (  const InstanceIdentifier &  id  )  const [inline, virtual]

returns the frequency of the instance which is identified by the 'id' Implements itk::Statistics::Sample< TMeasurementVector >.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> const TImage* itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::GetImage (   )  const

Method to get the image

template<class TImage, class TMeasurementVector = typename TImage::PixelType> virtual const MeasurementVectorType& itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::GetMeasurementVector (  const InstanceIdentifier &  id  )  const [inline, virtual]

returns the measurement of the instance which is identified by the 'id' Implements itk::Statistics::Sample< TMeasurementVector >.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> FrequencyType itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::GetTotalFrequency (   )  const [virtual]

returns the total frequency for the 'd' dimension Implements itk::Statistics::Sample< TMeasurementVector >.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::itkStaticConstMacro (  MeasurementVectorSize  , unsigned  int, PixelTraitsType::Dimension  )

the number of components in a measurement vector

template<class TImage, class TMeasurementVector = typename TImage::PixelType> Pointer itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> void itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes. Reimplemented from itk::Statistics::Sample< TMeasurementVector >.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> void itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::SetImage (  const TImage *  image  )

Method to set the image

template<class TImage, class TMeasurementVector = typename TImage::PixelType> unsigned int itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::Size (   )  const [virtual]

returns the number of measurement vectors in this container Implements itk::Statistics::Sample< TMeasurementVector >.

---

Member Data Documentation

template<class TImage, class TMeasurementVector = typename TImage::PixelType> TImage::IndexType itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::m_ImageBeginIndex [protected]

Definition at line 283 of file itkImageToListAdaptor.h.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> TImage::IndexType itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::m_ImageEndIndex [protected]

Definition at line 284 of file itkImageToListAdaptor.h.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> PixelContainerConstPointer itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::m_PixelContainer [protected]

Definition at line 281 of file itkImageToListAdaptor.h.

template<class TImage, class TMeasurementVector = typename TImage::PixelType> bool itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >::m_UseBuffer [protected]

Definition at line 282 of file itkImageToListAdaptor.h.

---

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

• itkImageToListAdaptor.h

---