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

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

#include <itkImageToListAdaptor.h>

Inheritance diagram for itk::Statistics::ImageToListAdaptor:

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

[legend]List of all members.

Public Types
typedef ImageToListAdaptor	Self
typedef ListSample< typename TImage::PixelType >	Superclass
typedef SmartPointer< Self >	Pointer
typedef TImage	ImageType
typedef ImageType::Pointer	ImagePointer
typedef ImageType::IndexType	IndexType
typedef ImageType::PixelType	PixelType
typedef ImageType::PixelContainerPointer	PixelContainerPointer
typedef ImageType::PixelContainer::ElementIdentifier	InstanceIdentifier
typedef ImageRegionIterator< ImageType >	IteratorType
typedef PixelTraits< typename TImage::PixelType >	PixelTraitsType
typedef PixelTraitsType::ValueType	MeasurementType
typedef PixelType	MeasurementVectorType
typedef MeasurementVectorType	ValueType
typedef Superclass::FrequencyType	FrequencyType
Public Methods
virtual const char *	GetClassName () const
	itkStaticConstMacro (MeasurementVectorSize, unsigned int, PixelTraitsType::Dimension)
void	SetImage (ImagePointer image)
ImagePointer	GetImage ()
unsigned int	Size () const
unsigned int	Size (const unsigned int &dimension) const
unsigned int	GetNumberOfInstances () const
void	SetMeasurementVector (const InstanceIdentifier id, const MeasurementVectorType &measurementVector)
MeasurementVectorType &	GetMeasurementVector (const InstanceIdentifier &id)
void	SetMeasurement (const InstanceIdentifier &id, const unsigned int &dim, const MeasurementType &value)
FrequencyType	GetFrequency (const InstanceIdentifier &id) const
FrequencyType	GetTotalFrequency (const unsigned int &dimension) const
Iterator	Begin ()
Iterator	End ()
Static Public Methods
Pointer	New ()
Protected Methods
	ImageToListAdaptor ()
virtual	~ImageToListAdaptor ()
void	PrintSelf (std::ostream &os, Indent indent) const
Friends
class	Iterator

---

Detailed Description

template<class TImage>
class itk::Statistics::ImageToListAdaptor< TImage >

This class provides ListSample interfaces to ITK Image.

After calling SetImage(Image::Pointer) 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, ListSample

Definition at line 61 of file itkImageToListAdaptor.h.

---

Member Typedef Documentation

template<class TImage> typedef Superclass::FrequencyType itk::Statistics::ImageToListAdaptor< TImage >::FrequencyType

Reimplemented from itk::Statistics::ListSample< TImage::PixelType >. Definition at line 98 of file itkImageToListAdaptor.h.

template<class TImage> typedef ImageType::Pointer itk::Statistics::ImageToListAdaptor< TImage >::ImagePointer

Definition at line 78 of file itkImageToListAdaptor.h.

template<class TImage> typedef TImage itk::Statistics::ImageToListAdaptor< TImage >::ImageType

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

template<class TImage> typedef ImageType::IndexType itk::Statistics::ImageToListAdaptor< TImage >::IndexType

Definition at line 79 of file itkImageToListAdaptor.h.

template<class TImage> typedef ImageType::PixelContainer::ElementIdentifier itk::Statistics::ImageToListAdaptor< TImage >::InstanceIdentifier

Reimplemented from itk::Statistics::ListSample< TImage::PixelType >. Definition at line 83 of file itkImageToListAdaptor.h.

template<class TImage> typedef ImageRegionIterator< ImageType > itk::Statistics::ImageToListAdaptor< TImage >::IteratorType

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

template<class TImage> typedef PixelTraitsType::ValueType itk::Statistics::ImageToListAdaptor< TImage >::MeasurementType

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

template<class TImage> typedef PixelType itk::Statistics::ImageToListAdaptor< TImage >::MeasurementVectorType

Reimplemented from itk::Statistics::ListSample< TImage::PixelType >. Definition at line 96 of file itkImageToListAdaptor.h.

template<class TImage> typedef ImageType::PixelContainerPointer itk::Statistics::ImageToListAdaptor< TImage >::PixelContainerPointer

Definition at line 81 of file itkImageToListAdaptor.h.

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

Definition at line 87 of file itkImageToListAdaptor.h.

template<class TImage> typedef ImageType::PixelType itk::Statistics::ImageToListAdaptor< TImage >::PixelType

Definition at line 80 of file itkImageToListAdaptor.h.

template<class TImage> typedef SmartPointer< Self > itk::Statistics::ImageToListAdaptor< TImage >::Pointer

Reimplemented from itk::Statistics::Sample< TImage::PixelType >. Definition at line 68 of file itkImageToListAdaptor.h.

template<class TImage> typedef ImageToListAdaptor itk::Statistics::ImageToListAdaptor< TImage >::Self

Standard class typedefs Reimplemented from itk::Statistics::ListSample< TImage::PixelType >. Definition at line 66 of file itkImageToListAdaptor.h.

template<class TImage> typedef ListSample< typename TImage::PixelType > itk::Statistics::ImageToListAdaptor< TImage >::Superclass

Reimplemented from itk::Statistics::ListSample< TImage::PixelType >. Definition at line 67 of file itkImageToListAdaptor.h.

template<class TImage> typedef MeasurementVectorType itk::Statistics::ImageToListAdaptor< TImage >::ValueType

Definition at line 97 of file itkImageToListAdaptor.h.

---

Constructor & Destructor Documentation

template<class TImage> itk::Statistics::ImageToListAdaptor< TImage >::ImageToListAdaptor (    )  [inline, protected]

Definition at line 205 of file itkImageToListAdaptor.h.

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

Definition at line 206 of file itkImageToListAdaptor.h.

---

Member Function Documentation

template<class TImage> Iterator itk::Statistics::ImageToListAdaptor< TImage >::Begin (  void    )  [inline]

Definition at line 129 of file itkImageToListAdaptor.h.

template<class TImage> Iterator itk::Statistics::ImageToListAdaptor< TImage >::End (  void    )  [inline]

Definition at line 135 of file itkImageToListAdaptor.h.

template<class TImage> virtual const char* itk::Statistics::ImageToListAdaptor< TImage >::GetClassName (    )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Statistics::ListSample< TImage::PixelType >.

template<class TImage> FrequencyType itk::Statistics::ImageToListAdaptor< TImage >::GetFrequency (  const InstanceIdentifier &    id )  const [virtual]

Implements itk::Statistics::Sample< TImage::PixelType >.

template<class TImage> ImagePointer itk::Statistics::ImageToListAdaptor< TImage >::GetImage (    )

Method to get the image

template<class TImage> MeasurementVectorType& itk::Statistics::ImageToListAdaptor< TImage >::GetMeasurementVector (  const InstanceIdentifier &    id )  [virtual]

Implements itk::Statistics::Sample< TImage::PixelType >.

template<class TImage> unsigned int itk::Statistics::ImageToListAdaptor< TImage >::GetNumberOfInstances (    )  const [virtual]

Implements itk::Statistics::Sample< TImage::PixelType >.

template<class TImage> FrequencyType itk::Statistics::ImageToListAdaptor< TImage >::GetTotalFrequency (  const unsigned int &    dimension )  const [virtual]

Implements itk::Statistics::Sample< TImage::PixelType >.

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

the number of components in a measurement vector

template<class TImage> Pointer itk::Statistics::ImageToListAdaptor< TImage >::New (    )  [static]

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

template<class TImage> void itk::Statistics::ImageToListAdaptor< TImage >::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::ListSample< TImage::PixelType >.

template<class TImage> void itk::Statistics::ImageToListAdaptor< TImage >::SetImage (  ImagePointer    image )

Method to set the image

template<class TImage> void itk::Statistics::ImageToListAdaptor< TImage >::SetMeasurement (  const InstanceIdentifier &    id, const unsigned int &    dim, const MeasurementType &    value )

template<class TImage> void itk::Statistics::ImageToListAdaptor< TImage >::SetMeasurementVector (  const InstanceIdentifier    id, const MeasurementVectorType &    measurementVector )

template<class TImage> unsigned int itk::Statistics::ImageToListAdaptor< TImage >::Size (  const unsigned int &    dimension )  const [virtual]

Implements itk::Statistics::Sample< TImage::PixelType >.

template<class TImage> unsigned int itk::Statistics::ImageToListAdaptor< TImage >::Size (    )  const [virtual]

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

---

Friends And Related Function Documentation

template<class TImage> friend class Iterator [friend]

Definition at line 127 of file itkImageToListAdaptor.h.

---

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

• itkImageToListAdaptor.h

---