ITK  5.1.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | 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 >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ImageConstPointer = typename ImageType::ConstPointer
 
using ImagePointer = typename ImageType::Pointer
 
using ImageType = TImage
 
using ListSampleType = ListSample< MeasurementVectorType >
 
using MaskImageConstPointer = typename MaskImageType::ConstPointer
 
using MaskImagePointer = typename MaskImageType::Pointer
 
using MaskImageType = TMaskImage
 
using MaskPixelType = typename MaskImageType::PixelType
 
using MeasurementVectorType = typename MeasurementVectorPixelTraits< PixelType >::MeasurementVectorType
 
using PixelType = typename ImageType::PixelType
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToListSampleFilter
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

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)
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual const float & GetProgress () const
 
void UpdateProgress (float progress)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputInformation ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual void ResetPipeline ()
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
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 SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- 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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
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 ()
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
 
MaskPixelType m_MaskValue
 
virtual void SetMaskValue (MaskPixelType _arg)
 
virtual MaskPixelType GetMaskValue () const
 
 ImageToListSampleFilter ()
 
 ~ImageToListSampleFilter () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
void GenerateData () override
 
void GenerateInputRequestedRegion () override
 
void GenerateOutputInformation () override
 

Additional Inherited Members

- Protected Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PopBackInput ()
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void PopFrontInput ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
virtual void VerifyPreconditions () ITKv5_CONST
 
virtual void VerifyInputInformation () ITKv5_CONST
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- Protected Attributes inherited from itk::ProcessObject
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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
Examples
SphinxExamples/src/Numerics/Statistics/DistributionOfPixelsUsingGMM/Code.cxx.

Definition at line 56 of file itkImageToListSampleFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 65 of file itkImageToListSampleFilter.h.

◆ DataObjectPointer

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

Standard itk::ProcessObject subclass method.

Definition at line 129 of file itkImageToListSampleFilter.h.

◆ DataObjectPointerArraySizeType

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

Standard itk::ProcessObject subclass method.

Definition at line 130 of file itkImageToListSampleFilter.h.

◆ ImageConstPointer

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

Definition at line 76 of file itkImageToListSampleFilter.h.

◆ ImagePointer

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

Definition at line 75 of file itkImageToListSampleFilter.h.

◆ ImageType

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

Image type alias

Definition at line 74 of file itkImageToListSampleFilter.h.

◆ ListSampleType

template<typename TImage , typename TMaskImage = TImage>
using itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::ListSampleType = ListSample<MeasurementVectorType>

Type of the output list sample

Definition at line 87 of file itkImageToListSampleFilter.h.

◆ MaskImageConstPointer

template<typename TImage , typename TMaskImage = TImage>
using itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::MaskImageConstPointer = typename MaskImageType::ConstPointer

Definition at line 83 of file itkImageToListSampleFilter.h.

◆ MaskImagePointer

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

Definition at line 82 of file itkImageToListSampleFilter.h.

◆ MaskImageType

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

Mask Image type alias

Definition at line 81 of file itkImageToListSampleFilter.h.

◆ MaskPixelType

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

Definition at line 84 of file itkImageToListSampleFilter.h.

◆ MeasurementVectorType

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

Definition at line 78 of file itkImageToListSampleFilter.h.

◆ PixelType

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

Definition at line 77 of file itkImageToListSampleFilter.h.

◆ Pointer

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

Definition at line 64 of file itkImageToListSampleFilter.h.

◆ Self

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

Standard class type aliases

Definition at line 62 of file itkImageToListSampleFilter.h.

◆ Superclass

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

Definition at line 63 of file itkImageToListSampleFilter.h.

Constructor & Destructor Documentation

◆ ImageToListSampleFilter()

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

Standard itk::ProcessObject subclass method.

◆ ~ImageToListSampleFilter()

template<typename TImage , typename TMaskImage = TImage>
itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::~ImageToListSampleFilter ( )
overrideprotecteddefault

Standard itk::ProcessObject subclass method.

Member Function Documentation

◆ CreateAnother()

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.

◆ GenerateData()

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

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

◆ GenerateInputRequestedRegion()

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

◆ GenerateOutputInformation()

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

Standard itk::ProcessObject subclass method.

Reimplemented from itk::ProcessObject.

◆ GetInput()

template<typename TImage , typename TMaskImage = TImage>
const ImageType* itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GetInput ( ) const

◆ GetMaskImage()

template<typename TImage , typename TMaskImage = TImage>
const MaskImageType* itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GetMaskImage ( ) const

◆ GetMaskValue()

template<typename TImage , typename TMaskImage = TImage>
virtual MaskPixelType itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GetMaskValue ( ) const
virtual

Standard itk::ProcessObject subclass method.

◆ GetMeasurementVectorSize()

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

return the number of components of the input image

◆ GetNameOfClass()

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.

◆ GetOutput()

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.

◆ MakeOutput()

template<typename TImage , typename TMaskImage = TImage>
DataObjectPointer itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::MakeOutput ( DataObjectPointerArraySizeType  idx)
overrideprotectedvirtual

Standard itk::ProcessObject subclass method.

Reimplemented from itk::ProcessObject.

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

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

Standard itk::ProcessObject subclass method.

Reimplemented from itk::ProcessObject.

◆ SetInput()

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

◆ SetMaskImage()

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

Method to set/get the mask

◆ SetMaskValue()

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

◆ m_MaskValue

template<typename TImage , typename TMaskImage = TImage>
MaskPixelType itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::m_MaskValue
private

Standard itk::ProcessObject subclass method.

Definition at line 148 of file itkImageToListSampleFilter.h.


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