ITK  4.13.0
Insight Segmentation and Registration Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
itk::Statistics::ImageToListSampleAdaptor< TImage > Class Template Reference

#include <itkImageToListSampleAdaptor.h>

+ Inheritance diagram for itk::Statistics::ImageToListSampleAdaptor< TImage >:
+ Collaboration diagram for itk::Statistics::ImageToListSampleAdaptor< TImage >:

Detailed Description

template<typename TImage>
class itk::Statistics::ImageToListSampleAdaptor< TImage >

This class provides ListSample interface to ITK Image.

After calling SetImage( const Image * ) method to plug in the image object, users can use Sample interfaces to access Image data. The resulting data are a list of measurement vectors.

The measurment vector type is determined from the image pixel type. This class handles images with scalar, fixed array or variable length vector pixel types.

See Also
Sample, ListSample
Wiki Examples:
Examples:
Examples/Statistics/ImageHistogram1.cxx, Examples/Statistics/ImageToListSampleAdaptor.cxx, Examples/Statistics/ScalarImageKmeansModelEstimator.cxx, and WikiExamples/Statistics/ImageToListSampleAdaptor.cxx.

Definition at line 53 of file itkImageToListSampleAdaptor.h.

Classes

class  ConstIterator
 
class  Iterator
 

Public Types

typedef
Superclass::AbsoluteFrequencyType 
AbsoluteFrequencyType
 
typedef SmartPointer< const SelfConstPointer
 
typedef
ImageRegionConstIterator
< ImageType
ImageConstIteratorType
 
typedef ImageType::ConstPointer ImageConstPointer
 
typedef ImageRegionIterator
< ImageType
ImageIteratorType
 
typedef ImageType::Pointer ImagePointer
 
typedef TImage ImageType
 
typedef ImageType::IndexType IndexType
 
typedef
Superclass::InstanceIdentifier 
InstanceIdentifier
 
typedef
MeasurementVectorPixelTraits
< PixelType
MeasurementPixelTraitsType
 
typedef
MeasurementVectorTraitsType::ValueType 
MeasurementType
 
typedef
Superclass::MeasurementVectorSizeType 
MeasurementVectorSizeType
 
typedef
MeasurementVectorTraitsTypes
< MeasurementVectorType
MeasurementVectorTraitsType
 
typedef
MeasurementPixelTraitsType::MeasurementVectorType 
MeasurementVectorType
 
typedef
ImageType::PixelContainerConstPointer 
PixelContainerConstPointer
 
typedef PixelTraits< typename
TImage::PixelType > 
PixelTraitsType
 
typedef ImageType::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef ImageToListSampleAdaptor Self
 
typedef ListSample< typename
MeasurementVectorPixelTraits
< typename TImage::PixelType >
::MeasurementVectorType
Superclass
 
typedef
Superclass::TotalAbsoluteFrequencyType 
TotalAbsoluteFrequencyType
 
typedef MeasurementVectorType ValueType
 
- Public Types inherited from itk::Statistics::ListSample< MeasurementVectorPixelTraits< TImage::PixelType >::MeasurementVectorType >
typedef
Superclass::AbsoluteFrequencyType 
AbsoluteFrequencyType
 
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::InstanceIdentifier 
InstanceIdentifier
 
typedef std::vector
< MeasurementVectorType
InternalDataContainerType
 
typedef Superclass::MeasurementType MeasurementType
 
typedef
Superclass::MeasurementVectorSizeType 
MeasurementVectorSizeType
 
typedef
Superclass::MeasurementVectorType 
MeasurementVectorType
 
typedef SmartPointer< SelfPointer
 
typedef ListSample Self
 
typedef Sample
< MeasurementVectorPixelTraits
< TImage::PixelType >
::MeasurementVectorType
Superclass
 
typedef
Superclass::TotalAbsoluteFrequencyType 
TotalAbsoluteFrequencyType
 
typedef MeasurementVectorType ValueType
 
- Public Types inherited from itk::Statistics::Sample< MeasurementVectorPixelTraits< TImage::PixelType >::MeasurementVectorType >
typedef
MeasurementVectorTraits::AbsoluteFrequencyType 
AbsoluteFrequencyType
 
typedef SmartPointer< const SelfConstPointer
 
typedef
MeasurementVectorTraits::InstanceIdentifier 
InstanceIdentifier
 
typedef
MeasurementVectorTraitsTypes
< MeasurementVectorType >
::ValueType 
MeasurementType
 
typedef unsigned int MeasurementVectorSizeType
 
typedef
MeasurementVectorPixelTraits
< TImage::PixelType >
::MeasurementVectorType 
MeasurementVectorType
 
typedef SmartPointer< SelfPointer
 
typedef Sample Self
 
typedef DataObject Superclass
 
typedef NumericTraits
< AbsoluteFrequencyType >
::AccumulateType 
TotalAbsoluteFrequencyType
 
- Public Types inherited from itk::DataObject
typedef SmartPointer< const SelfConstPointer
 
typedef std::string DataObjectIdentifierType
 
typedef std::vector< Pointer >
::size_type 
DataObjectPointerArraySizeType
 
typedef SmartPointer< SelfPointer
 
typedef DataObject 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
 
AbsoluteFrequencyType GetFrequency (InstanceIdentifier id) const override
 
const TImage * GetImage () const
 
virtual const
MeasurementVectorType
GetMeasurementVector (InstanceIdentifier id) const override
 
virtual MeasurementVectorSizeType GetMeasurementVectorSize () const override
 
virtual const char * GetNameOfClass () const
 
TotalAbsoluteFrequencyType GetTotalFrequency () const override
 
void SetImage (const TImage *image)
 
InstanceIdentifier Size () const override
 
Iterator Begin ()
 
- Public Member Functions inherited from itk::Statistics::ListSample< MeasurementVectorPixelTraits< TImage::PixelType >::MeasurementVectorType >
Iterator Begin ()
 
ConstIterator Begin () const
 
void Clear ()
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
Iterator End ()
 
ConstIterator End () const
 
AbsoluteFrequencyType GetFrequency (InstanceIdentifier id) const override
 
const MeasurementVectorTypeGetMeasurementVector (InstanceIdentifier id) const override
 
TotalAbsoluteFrequencyType GetTotalFrequency () const override
 
virtual void Graft (const DataObject *thatObject) override
 
void PushBack (const MeasurementVectorType &mv)
 
void Resize (InstanceIdentifier newsize)
 
void SetMeasurement (InstanceIdentifier id, unsigned int dim, const MeasurementType &value)
 
void SetMeasurementVector (InstanceIdentifier id, const MeasurementVectorType &mv)
 
InstanceIdentifier Size () const override
 
- Public Member Functions inherited from itk::Statistics::Sample< MeasurementVectorPixelTraits< TImage::PixelType >::MeasurementVectorType >
virtual AbsoluteFrequencyType GetFrequency (InstanceIdentifier id) const =0
 
virtual const
MeasurementVectorType
GetMeasurementVector (InstanceIdentifier id) const =0
 
virtual void SetMeasurementVectorSize (MeasurementVectorSizeType s)
 
- Public Member Functions inherited from itk::DataObject
virtual void CopyInformation (const DataObject *)
 
virtual void DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointerForwardReference
< ProcessObject
GetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void Initialize ()
 
virtual void PrepareForNewData ()
 
virtual void PropagateRequestedRegion ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOff ()
 
virtual void ReleaseDataFlagOn ()
 
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion ()
 
virtual void ResetPipeline ()
 
void SetReleaseDataFlag (bool flag)
 
virtual void SetRequestedRegion (const DataObject *)
 
virtual void SetRequestedRegionToLargestPossibleRegion ()
 
bool ShouldIReleaseData () const
 
virtual void Update ()
 
virtual void UpdateOutputData ()
 
virtual void UpdateOutputInformation ()
 
virtual bool VerifyRequestedRegion ()
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual const ModifiedTimeTypeGetPipelineMTime () const
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStampGetRealTimeStamp () 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::Statistics::ListSample< MeasurementVectorPixelTraits< TImage::PixelType >::MeasurementVectorType >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::DataObject
static bool GetGlobalReleaseDataFlag ()
 
static void GlobalReleaseDataFlagOff ()
 
static void GlobalReleaseDataFlagOn ()
 
static void SetGlobalReleaseDataFlag (bool val)
 
- 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 ()
 
ImageConstPointer m_Image
 
MeasurementVectorType m_MeasurementVectorInternal
 
Iterator End ()
 
ConstIterator Begin () const
 
ConstIterator End () const
 
 ImageToListSampleAdaptor ()
 
virtual ~ImageToListSampleAdaptor () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- Protected Member Functions inherited from itk::Statistics::ListSample< MeasurementVectorPixelTraits< TImage::PixelType >::MeasurementVectorType >
 ListSample ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual ~ListSample () override
 
- Protected Member Functions inherited from itk::Statistics::Sample< MeasurementVectorPixelTraits< TImage::PixelType >::MeasurementVectorType >
 Sample ()
 
virtual ~Sample () override
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
virtual void PropagateResetPipeline ()
 
virtual ~DataObject () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object () override
 
- 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::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TImage >
typedef Superclass::AbsoluteFrequencyType itk::Statistics::ImageToListSampleAdaptor< TImage >::AbsoluteFrequencyType

Definition at line 95 of file itkImageToListSampleAdaptor.h.

template<typename TImage >
typedef SmartPointer< const Self > itk::Statistics::ImageToListSampleAdaptor< TImage >::ConstPointer

Definition at line 65 of file itkImageToListSampleAdaptor.h.

Definition at line 83 of file itkImageToListSampleAdaptor.h.

template<typename TImage >
typedef ImageType::ConstPointer itk::Statistics::ImageToListSampleAdaptor< TImage >::ImageConstPointer

Definition at line 76 of file itkImageToListSampleAdaptor.h.

Image Iterator typedef support

Definition at line 82 of file itkImageToListSampleAdaptor.h.

template<typename TImage >
typedef ImageType::Pointer itk::Statistics::ImageToListSampleAdaptor< TImage >::ImagePointer

Definition at line 75 of file itkImageToListSampleAdaptor.h.

template<typename TImage >
typedef TImage itk::Statistics::ImageToListSampleAdaptor< TImage >::ImageType

Image typedefs

Definition at line 71 of file itkImageToListSampleAdaptor.h.

template<typename TImage >
typedef ImageType::IndexType itk::Statistics::ImageToListSampleAdaptor< TImage >::IndexType

Definition at line 77 of file itkImageToListSampleAdaptor.h.

template<typename TImage >
typedef Superclass::InstanceIdentifier itk::Statistics::ImageToListSampleAdaptor< TImage >::InstanceIdentifier

Definition at line 98 of file itkImageToListSampleAdaptor.h.

Superclass typedefs for Measurement vector, measurement, Instance Identifier, frequency, size, size element value

Definition at line 89 of file itkImageToListSampleAdaptor.h.

Definition at line 93 of file itkImageToListSampleAdaptor.h.

template<typename TImage >
typedef Superclass::MeasurementVectorSizeType itk::Statistics::ImageToListSampleAdaptor< TImage >::MeasurementVectorSizeType

Definition at line 97 of file itkImageToListSampleAdaptor.h.

Definition at line 92 of file itkImageToListSampleAdaptor.h.

Definition at line 90 of file itkImageToListSampleAdaptor.h.

template<typename TImage >
typedef ImageType::PixelContainerConstPointer itk::Statistics::ImageToListSampleAdaptor< TImage >::PixelContainerConstPointer

Definition at line 79 of file itkImageToListSampleAdaptor.h.

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

Definition at line 84 of file itkImageToListSampleAdaptor.h.

template<typename TImage >
typedef ImageType::PixelType itk::Statistics::ImageToListSampleAdaptor< TImage >::PixelType

Definition at line 78 of file itkImageToListSampleAdaptor.h.

template<typename TImage >
typedef SmartPointer< Self > itk::Statistics::ImageToListSampleAdaptor< TImage >::Pointer

Definition at line 64 of file itkImageToListSampleAdaptor.h.

template<typename TImage >
typedef ImageToListSampleAdaptor itk::Statistics::ImageToListSampleAdaptor< TImage >::Self

Standard class typedefs

Definition at line 58 of file itkImageToListSampleAdaptor.h.

template<typename TImage >
typedef ListSample< typename MeasurementVectorPixelTraits< typename TImage::PixelType >::MeasurementVectorType > itk::Statistics::ImageToListSampleAdaptor< TImage >::Superclass

Definition at line 62 of file itkImageToListSampleAdaptor.h.

template<typename TImage >
typedef Superclass::TotalAbsoluteFrequencyType itk::Statistics::ImageToListSampleAdaptor< TImage >::TotalAbsoluteFrequencyType

Definition at line 96 of file itkImageToListSampleAdaptor.h.

template<typename TImage >
typedef MeasurementVectorType itk::Statistics::ImageToListSampleAdaptor< TImage >::ValueType

Definition at line 100 of file itkImageToListSampleAdaptor.h.

Constructor & Destructor Documentation

template<typename TImage >
itk::Statistics::ImageToListSampleAdaptor< TImage >::ImageToListSampleAdaptor ( )
protected

returns an iterator that points to the end of the container

template<typename TImage >
virtual itk::Statistics::ImageToListSampleAdaptor< TImage >::~ImageToListSampleAdaptor ( )
inlineoverrideprotectedvirtual

returns an iterator that points to the end of the container

Definition at line 298 of file itkImageToListSampleAdaptor.h.

Member Function Documentation

template<typename TImage >
Iterator itk::Statistics::ImageToListSampleAdaptor< TImage >::Begin ( )
inline

returns an iterator that points to the beginning of the container

Definition at line 250 of file itkImageToListSampleAdaptor.h.

References itk::ImageRegionConstIterator< TImage >::GoToBegin().

Referenced by itk::Statistics::ImageToListSampleAdaptor< TImage >::ConstIterator::ConstIterator().

template<typename TImage >
ConstIterator itk::Statistics::ImageToListSampleAdaptor< TImage >::Begin ( ) const
inline

returns an iterator that points to the beginning of the container

Definition at line 274 of file itkImageToListSampleAdaptor.h.

References itk::ImageRegionConstIterator< TImage >::GoToBegin().

template<typename TImage >
virtual::itk::LightObject::Pointer itk::Statistics::ImageToListSampleAdaptor< TImage >::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 >
Iterator itk::Statistics::ImageToListSampleAdaptor< TImage >::End ( )
inline

returns an iterator that points to the end of the container

Definition at line 261 of file itkImageToListSampleAdaptor.h.

References itk::ImageRegionConstIterator< TImage >::GoToEnd().

template<typename TImage >
ConstIterator itk::Statistics::ImageToListSampleAdaptor< TImage >::End ( ) const
inline

returns an iterator that points to the end of the container

Definition at line 285 of file itkImageToListSampleAdaptor.h.

References itk::ImageRegionConstIterator< TImage >::GoToEnd().

template<typename TImage >
AbsoluteFrequencyType itk::Statistics::ImageToListSampleAdaptor< TImage >::GetFrequency ( InstanceIdentifier  id) const
override

method to return frequency for a specified id

template<typename TImage >
const TImage* itk::Statistics::ImageToListSampleAdaptor< TImage >::GetImage ( ) const

Method to get the image

template<typename TImage >
virtual const MeasurementVectorType& itk::Statistics::ImageToListSampleAdaptor< TImage >::GetMeasurementVector ( InstanceIdentifier  id) const
overridevirtual

method to return measurement vector for a specified id

template<typename TImage >
virtual MeasurementVectorSizeType itk::Statistics::ImageToListSampleAdaptor< TImage >::GetMeasurementVectorSize ( ) const
inlineoverridevirtual

Get method for the length of the measurement vector

Reimplemented from itk::Statistics::Sample< MeasurementVectorPixelTraits< TImage::PixelType >::MeasurementVectorType >.

Definition at line 114 of file itkImageToListSampleAdaptor.h.

template<typename TImage >
virtual const char* itk::Statistics::ImageToListSampleAdaptor< TImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Statistics::ListSample< MeasurementVectorPixelTraits< TImage::PixelType >::MeasurementVectorType >.

template<typename TImage >
TotalAbsoluteFrequencyType itk::Statistics::ImageToListSampleAdaptor< TImage >::GetTotalFrequency ( ) const
overridevirtual
template<typename TImage >
static Pointer itk::Statistics::ImageToListSampleAdaptor< TImage >::New ( )
static

Method for creation through the object factory.

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

returns an iterator that points to the end of the container

Reimplemented from itk::Statistics::Sample< MeasurementVectorPixelTraits< TImage::PixelType >::MeasurementVectorType >.

template<typename TImage >
void itk::Statistics::ImageToListSampleAdaptor< TImage >::SetImage ( const TImage *  image)

Method to set the image

template<typename TImage >
InstanceIdentifier itk::Statistics::ImageToListSampleAdaptor< TImage >::Size ( ) const
overridevirtual

returns the number of measurement vectors in this container

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

Member Data Documentation

template<typename TImage >
ImageConstPointer itk::Statistics::ImageToListSampleAdaptor< TImage >::m_Image
private

returns an iterator that points to the end of the container

Definition at line 302 of file itkImageToListSampleAdaptor.h.

template<typename TImage >
MeasurementVectorType itk::Statistics::ImageToListSampleAdaptor< TImage >::m_MeasurementVectorInternal
mutableprivate

returns an iterator that points to the end of the container

Definition at line 305 of file itkImageToListSampleAdaptor.h.


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