ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Private Member Functions | Private Attributes
itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage > Class Template Reference
Module ITKStatistics

The class takes an image as input and generates a list sample as output. More...

#include <itkImageToListSampleFilter.h>

Inheritance diagram for itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >:
Collaboration diagram for itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >:

List of all members.

Public Types

typedef SmartPointer< const Self > ConstPointer
typedef ImageType::ConstPointer ImageConstPointer
typedef ImageType::Pointer ImagePointer
typedef TImage ImageType
typedef ListSample
< MeasurementVectorType > 		ListSampleType
typedef MaskImageType::ConstPointer MaskImageConstPointer
typedef MaskImageType::Pointer MaskImagePointer
typedef TMaskImage MaskImageType
typedef MaskImageType::PixelType MaskPixelType
typedef
MeasurementVectorPixelTraits
< PixelType >
::MeasurementVectorType 		MeasurementVectorType
typedef ImageType::PixelType PixelType
typedef SmartPointer< Self > Pointer
typedef ImageToListSampleFilter Self
typedef ProcessObject Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
const ImageType * GetInput () const
const MaskImageType * GetMaskImage () const
unsigned int GetMeasurementVectorSize () const
virtual const char * GetNameOfClass () const
const ListSampleType * GetOutput () const
void SetInput (const ImageType *image)
void SetMaskImage (const MaskImageType *image)

Static Public Member Functions

static Pointer New ()

Protected Types

typedef DataObject::Pointer DataObjectPointer
typedef
ProcessObject::DataObjectPointerArraySizeType 		DataObjectPointerArraySizeType

Protected Member Functions

virtual void GenerateData ()
virtual void GenerateInputRequestedRegion () throw ( InvalidRequestedRegionError )
virtual void GenerateOutputInformation ()
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)

Private Member Functions

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

Private Attributes

MaskPixelType m_MaskValue
virtual void SetMaskValue (MaskPixelType _arg)
virtual MaskPixelType GetMaskValue () const
 ImageToListSampleFilter ()
virtual ~ImageToListSampleFilter ()
void PrintSelf (std::ostream &os, Indent indent) const

Detailed Description

template<class TImage, class TMaskImage = TImage>
class itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >

The class takes an image as input and generates a list sample as output.

There are differences between this class and ImageToListSampleAdaptor. This class is not an adaptor. It creates a new list sample and does not provide a pseudo interface to the actual image to make it look like a list sample.

The class optionally allows you to specify a mask image as an input. The list sample (if a mask is specified) is constructed from pixels that are within the mask

Todo:
In future allow the filter to take a Spatial object as input so a generic spatial object like an ellipse etc can be used as a mask. Sure the ImageMaskSpatialObject can represent image masks too, so why not make SpatialObjects the default. I think the ImageMaskSpatialObject is slow in terms of inefficient iteration through the image.
See also:
ImageToListSampleAdaptor

Definition at line 55 of file itkImageToListSampleFilter.h.

Member Typedef Documentation

template<class TImage , class TMaskImage = TImage>
typedef SmartPointer< const Self > itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::ConstPointer

Reimplemented from itk::ProcessObject.

Definition at line 63 of file itkImageToListSampleFilter.h.

template<class TImage , class TMaskImage = TImage>
typedef DataObject::Pointer itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::DataObjectPointer [protected]

Standard itk::ProcessObject subclass method.

Reimplemented from itk::ProcessObject.

Definition at line 120 of file itkImageToListSampleFilter.h.

template<class TImage , class TMaskImage = TImage>
typedef ProcessObject::DataObjectPointerArraySizeType itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::DataObjectPointerArraySizeType [protected]

Reimplemented from itk::ProcessObject.

Definition at line 121 of file itkImageToListSampleFilter.h.

template<class TImage , class TMaskImage = TImage>
typedef ImageType::ConstPointer itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::ImageConstPointer

Definition at line 74 of file itkImageToListSampleFilter.h.

template<class TImage , class TMaskImage = TImage>
typedef ImageType::Pointer itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::ImagePointer

Definition at line 73 of file itkImageToListSampleFilter.h.

template<class TImage , class TMaskImage = TImage>
typedef TImage itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::ImageType

Image typedefs

Definition at line 69 of file itkImageToListSampleFilter.h.

template<class TImage , class TMaskImage = TImage>
typedef ListSample< MeasurementVectorType > itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::ListSampleType

Type of the output list sample

Definition at line 86 of file itkImageToListSampleFilter.h.

template<class TImage , class TMaskImage = TImage>
typedef MaskImageType::ConstPointer itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::MaskImageConstPointer

Definition at line 82 of file itkImageToListSampleFilter.h.

template<class TImage , class TMaskImage = TImage>
typedef MaskImageType::Pointer itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::MaskImagePointer

Definition at line 81 of file itkImageToListSampleFilter.h.

template<class TImage , class TMaskImage = TImage>
typedef TMaskImage itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::MaskImageType

Mask Image typedefs

Definition at line 80 of file itkImageToListSampleFilter.h.

template<class TImage , class TMaskImage = TImage>
typedef MaskImageType::PixelType itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::MaskPixelType

Definition at line 83 of file itkImageToListSampleFilter.h.

template<class TImage , class TMaskImage = TImage>
typedef MeasurementVectorPixelTraits< PixelType >::MeasurementVectorType itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::MeasurementVectorType

Definition at line 77 of file itkImageToListSampleFilter.h.

template<class TImage , class TMaskImage = TImage>
typedef ImageType::PixelType itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::PixelType

Definition at line 75 of file itkImageToListSampleFilter.h.

template<class TImage , class TMaskImage = TImage>
typedef SmartPointer< Self > itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::Pointer

Reimplemented from itk::ProcessObject.

Definition at line 62 of file itkImageToListSampleFilter.h.

template<class TImage , class TMaskImage = TImage>
typedef ImageToListSampleFilter itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::Self

Standard class typedefs

Reimplemented from itk::ProcessObject.

Definition at line 60 of file itkImageToListSampleFilter.h.

template<class TImage , class TMaskImage = TImage>
typedef ProcessObject itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::Superclass

Reimplemented from itk::ProcessObject.

Definition at line 61 of file itkImageToListSampleFilter.h.

Constructor & Destructor Documentation

template<class TImage , class TMaskImage = TImage>
itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::ImageToListSampleFilter ( ) [protected]

Set the pixel value treated as on in the mask. If a mask has been specified, only pixels with this value will be added to the list sample, if no mask has been specified all pixels will be added as measurement vectors to the list sample.

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

Set the pixel value treated as on in the mask. If a mask has been specified, only pixels with this value will be added to the list sample, if no mask has been specified all pixels will be added as measurement vectors to the list sample.

Definition at line 115 of file itkImageToListSampleFilter.h.

template<class TImage , class TMaskImage = TImage>
itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::ImageToListSampleFilter ( const Self &  ) [private]

Member Function Documentation

template<class TImage , class TMaskImage = TImage>
virtual::itk::LightObject::Pointer itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::CreateAnother ( void  ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<class TImage , class TMaskImage = TImage>
virtual void itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GenerateData ( ) [protected, virtual]

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

template<class TImage , class TMaskImage = TImage>
virtual void itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GenerateInputRequestedRegion ( ) throw ( InvalidRequestedRegionError ) [protected, virtual]

This method ensures that a mask image if specified has requested regions that at least contain the input image's buffered region.

Reimplemented from itk::ProcessObject.

template<class TImage , class TMaskImage = TImage>
virtual void itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GenerateOutputInformation ( ) [protected, virtual]

Generate the information decribing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Reimplemented from itk::ProcessObject.

template<class TImage , class TMaskImage = TImage>
const ImageType* itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GetInput ( ) const
template<class TImage , class TMaskImage = TImage>
const MaskImageType* itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GetMaskImage ( ) const
template<class TImage , class TMaskImage = TImage>
virtual MaskPixelType itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GetMaskValue ( ) const [virtual]

Set the pixel value treated as on in the mask. If a mask has been specified, only pixels with this value will be added to the list sample, if no mask has been specified all pixels will be added as measurement vectors to the list sample.

template<class TImage , class TMaskImage = TImage>
unsigned int itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GetMeasurementVectorSize ( ) const

return the number of components of the input image

template<class TImage , class TMaskImage = TImage>
virtual const char* itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

template<class TImage , class TMaskImage = TImage>
const ListSampleType* itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GetOutput ( ) const

Method to get the list sample, the generated output. Note that this does not invoke Update(). You should have called update on this class to get any meaningful output.

template<class TImage , class TMaskImage = TImage>
virtual DataObjectPointer itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::MakeOutput ( DataObjectPointerArraySizeType  idx) [protected, virtual]

Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a itkSmartPointer to a DataObject. ImageSource and MeshSource override this method to create the correct type of image and mesh respectively. If a filter has multiple outputs of different types, then that filter must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

template<class TImage , class TMaskImage = TImage>
static Pointer itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TImage , class TMaskImage = TImage>
void itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::operator= ( const Self &  ) [private]

Time when GenerateOutputInformation was last called.

Reimplemented from itk::ProcessObject.

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

Set the pixel value treated as on in the mask. If a mask has been specified, only pixels with this value will be added to the list sample, if no mask has been specified all pixels will be added as measurement vectors to the list sample.

Reimplemented from itk::ProcessObject.

template<class TImage , class TMaskImage = TImage>
void itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::SetInput ( const ImageType *  image)
template<class TImage , class TMaskImage = TImage>
void itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::SetMaskImage ( const MaskImageType *  image)

Method to set/get the mask

template<class TImage , class TMaskImage = TImage>
virtual void itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::SetMaskValue ( MaskPixelType  _arg) [virtual]

Set the pixel value treated as on in the mask. If a mask has been specified, only pixels with this value will be added to the list sample, if no mask has been specified all pixels will be added as measurement vectors to the list sample.

Member Data Documentation

template<class TImage , class TMaskImage = TImage>
MaskPixelType itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::m_MaskValue [private]

Definition at line 139 of file itkImageToListSampleFilter.h.

The documentation for this class was generated from the following file:
Generated on Mon Dec 19 2011 01:51:51 for ITK by doxygen 1.7.4