ITK  4.8.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 | List of all members
itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage > Class Template Reference

#include <itkImageToListSampleFilter.h>

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

Detailed Description

template<typename TImage, typename 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.

Public Types

typedef SmartPointer< const SelfConstPointer
 
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< SelfPointer
 
typedef ImageToListSampleFilter Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
const ImageTypeGetInput () const
 
const MaskImageTypeGetMaskImage () const
 
unsigned int GetMeasurementVectorSize () const
 
virtual const char * GetNameOfClass () const
 
const ListSampleTypeGetOutput () const
 
void SetInput (const ImageType *image)
 
void SetMaskImage (const MaskImageType *image)
 
virtual void SetMaskValue (MaskPixelType _arg)
 
virtual MaskPixelType GetMaskValue () const
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Types

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

Protected Member Functions

virtual void GenerateData () override
 
virtual void GenerateInputRequestedRegion () override
 
virtual void GenerateOutputInformation () override
 
 ImageToListSampleFilter ()
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual ~ImageToListSampleFilter ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

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

Private Attributes

MaskPixelType m_MaskValue
 

Additional Inherited Members

- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

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

Definition at line 63 of file itkImageToListSampleFilter.h.

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

Standard itk::ProcessObject subclass method.

Definition at line 121 of file itkImageToListSampleFilter.h.

template<typename TImage , typename TMaskImage = TImage>
typedef ProcessObject::DataObjectPointerArraySizeType itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::DataObjectPointerArraySizeType
protected

Definition at line 122 of file itkImageToListSampleFilter.h.

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

Definition at line 74 of file itkImageToListSampleFilter.h.

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

Definition at line 73 of file itkImageToListSampleFilter.h.

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

Image typedefs

Definition at line 69 of file itkImageToListSampleFilter.h.

template<typename TImage , typename 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<typename TImage , typename TMaskImage = TImage>
typedef MaskImageType::ConstPointer itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::MaskImageConstPointer

Definition at line 82 of file itkImageToListSampleFilter.h.

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

Definition at line 81 of file itkImageToListSampleFilter.h.

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

Mask Image typedefs

Definition at line 80 of file itkImageToListSampleFilter.h.

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

Definition at line 83 of file itkImageToListSampleFilter.h.

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

Definition at line 77 of file itkImageToListSampleFilter.h.

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

Definition at line 75 of file itkImageToListSampleFilter.h.

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

Definition at line 62 of file itkImageToListSampleFilter.h.

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

Standard class typedefs

Definition at line 60 of file itkImageToListSampleFilter.h.

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

Definition at line 61 of file itkImageToListSampleFilter.h.

Constructor & Destructor Documentation

template<typename TImage , typename TMaskImage = TImage>
itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::ImageToListSampleFilter ( )
protected
template<typename TImage , typename TMaskImage = TImage>
virtual itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::~ImageToListSampleFilter ( )
inlineprotectedvirtual

Definition at line 117 of file itkImageToListSampleFilter.h.

template<typename TImage , typename TMaskImage = TImage>
itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::ImageToListSampleFilter ( const Self )
private

Member Function Documentation

template<typename TImage , typename TMaskImage = TImage>
virtual::itk::LightObject::Pointer itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::CreateAnother ( ) 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<typename TImage , typename TMaskImage = TImage>
virtual void itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GenerateData ( )
overrideprotectedvirtual

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

template<typename TImage , typename TMaskImage = TImage>
virtual void itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GenerateInputRequestedRegion ( )
overrideprotectedvirtual

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<typename TImage , typename TMaskImage = TImage>
virtual void itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GenerateOutputInformation ( )
overrideprotectedvirtual

Generate the information describing 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<typename TImage , typename TMaskImage = TImage>
const ImageType* itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GetInput ( ) const
template<typename TImage , typename TMaskImage = TImage>
const MaskImageType* itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GetMaskImage ( ) const
template<typename TImage , typename 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<typename TImage , typename TMaskImage = TImage>
unsigned int itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GetMeasurementVectorSize ( ) const

return the number of components of the input image

template<typename TImage , typename 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<typename TImage , typename 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<typename TImage , typename TMaskImage = TImage>
virtual DataObjectPointer itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::MakeOutput ( DataObjectPointerArraySizeType  idx)
overrideprotectedvirtual

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<typename TImage , typename TMaskImage = TImage>
static Pointer itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::New ( )
static

Method for creation through the object factory.

template<typename TImage , typename TMaskImage = TImage>
void itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::operator= ( const Self )
private
template<typename TImage , typename TMaskImage = TImage>
virtual void itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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::ProcessObject.

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

Method to set/get the mask

template<typename TImage , typename 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<typename TImage , typename 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: