itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer > Class Template Reference

#include <itkVectorContainerToListSampleAdaptor.h>

Inheritance diagram for itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >:

Collaboration diagram for itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >:

Detailed Description

template<typename TVectorContainer>
class itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >

This class provides ListSample interface to ITK VectorContainer.

After calling SetVectorContainer(VectorContainer*) method to plug-in the VectorContainer object, users can use Sample interfaces to access VectorContainer data. This adaptor assumes that the VectorContainer is actual storage for measurment vectors. In other words, VectorContainer's element dimension equals to the measurement vectors size.

See Also

Sample, ListSample, VectorContainer

Definition at line 46 of file itkVectorContainerToListSampleAdaptor.h.

Classes
class	ConstIterator
class	Iterator

Public Types
typedef Superclass::AbsoluteFrequencyType	AbsoluteFrequencyType
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InstanceIdentifier	InstanceIdentifier
typedef Superclass::MeasurementType	MeasurementType
typedef Superclass::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef Superclass::MeasurementVectorType	MeasurementVectorType
typedef SmartPointer< Self >	Pointer
typedef VectorContainerToListSampleAdaptor	Self
typedef ListSample< typename TVectorContainer::Element >	Superclass
typedef Superclass::TotalAbsoluteFrequencyType	TotalAbsoluteFrequencyType
typedef MeasurementVectorType	ValueType
typedef TVectorContainer::ConstIterator	VectorContainerConstIterator
typedef TVectorContainer::ConstPointer	VectorContainerConstPointer
typedef TVectorContainer::Iterator	VectorContainerIterator
typedef TVectorContainer::Pointer	VectorContainerPointer
typedef TVectorContainer	VectorContainerType
Public Types inherited from itk::Statistics::ListSample< TVectorContainer::Element >
typedef Superclass::AbsoluteFrequencyType	AbsoluteFrequencyType
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InstanceIdentifier	InstanceIdentifier
typedef std::vector < MeasurementVectorType >	InternalDataContainerType
typedef Superclass::MeasurementType	MeasurementType
typedef Superclass::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef Superclass::MeasurementVectorType	MeasurementVectorType
typedef SmartPointer< Self >	Pointer
typedef ListSample	Self
typedef Sample < TVectorContainer::Element >	Superclass
typedef Superclass::TotalAbsoluteFrequencyType	TotalAbsoluteFrequencyType
typedef MeasurementVectorType	ValueType
Public Types inherited from itk::Statistics::Sample< TVectorContainer::Element >
typedef MeasurementVectorTraits::AbsoluteFrequencyType	AbsoluteFrequencyType
typedef SmartPointer< const Self >	ConstPointer
typedef MeasurementVectorTraits::InstanceIdentifier	InstanceIdentifier
typedef MeasurementVectorTraitsTypes < MeasurementVectorType > ::ValueType	MeasurementType
typedef unsigned int	MeasurementVectorSizeType
typedef TVectorContainer::Element	MeasurementVectorType
typedef SmartPointer< Self >	Pointer
typedef Sample	Self
typedef DataObject	Superclass
typedef NumericTraits < AbsoluteFrequencyType > ::AccumulateType	TotalAbsoluteFrequencyType
Public Types inherited from itk::DataObject
typedef SmartPointer< const Self >	ConstPointer
typedef std::string	DataObjectIdentifierType
typedef std::vector< Pointer > ::size_type	DataObjectPointerArraySizeType
typedef SmartPointer< Self >	Pointer
typedef DataObject	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
AbsoluteFrequencyType	GetFrequency (InstanceIdentifier) const
const MeasurementVectorType &	GetMeasurementVector (InstanceIdentifier) const
virtual const char *	GetNameOfClass () const
TotalAbsoluteFrequencyType	GetTotalFrequency () const
InstanceIdentifier	Size () const
virtual void	SetVectorContainer (VectorContainerType *_arg)
virtual const VectorContainerType *	GetVectorContainer () const
Iterator	Begin ()
Iterator	End ()
ConstIterator	Begin () const
ConstIterator	End () const
Public Member Functions inherited from itk::Statistics::ListSample< TVectorContainer::Element >
Iterator	Begin ()
ConstIterator	Begin () const
void	Clear ()
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
Iterator	End ()
ConstIterator	End () const
AbsoluteFrequencyType	GetFrequency (InstanceIdentifier id) const
const MeasurementVectorType &	GetMeasurementVector (InstanceIdentifier id) const
TotalAbsoluteFrequencyType	GetTotalFrequency () const
virtual void	Graft (const DataObject *thatObject)
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
Public Member Functions inherited from itk::Statistics::Sample< TVectorContainer::Element >
virtual AbsoluteFrequencyType	GetFrequency (InstanceIdentifier id) const =0
virtual const MeasurementVectorType &	GetMeasurementVector (InstanceIdentifier id) const =0
virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const
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 DataObjectIdentifierType &	GetSourceOutputName () 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 ModifiedTimeType &	GetPipelineMTime () const
virtual void	SetRealTimeStamp (RealTimeStamp _arg)
virtual const RealTimeStamp &	GetRealTimeStamp () 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
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const ITK_OVERRIDE
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int) ITK_OVERRIDE
virtual void	UnRegister () const ITK_OVERRIDE
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< TVectorContainer::Element >
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 ()

Static Public Attributes
static const unsigned int	MeasurementVectorSize = TVectorContainer::Element::Dimension

Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const
	VectorContainerToListSampleAdaptor ()
virtual	~VectorContainerToListSampleAdaptor ()
Protected Member Functions inherited from itk::Statistics::ListSample< TVectorContainer::Element >
	ListSample ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~ListSample ()
Protected Member Functions inherited from itk::Statistics::Sample< TVectorContainer::Element >
	Sample ()
virtual	~Sample ()
Protected Member Functions inherited from itk::DataObject
	DataObject ()
virtual void	PropagateResetPipeline ()
	~DataObject ()
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
void	operator= (const Self &)
	VectorContainerToListSampleAdaptor (const Self &)

Private Attributes
VectorContainerType::Element	m_TempPoint
VectorContainerConstPointer	m_VectorContainer

Additional Inherited Members
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType
Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

Member Typedef Documentation

template<typename TVectorContainer >

typedef Superclass::AbsoluteFrequencyType itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::AbsoluteFrequencyType

Definition at line 77 of file itkVectorContainerToListSampleAdaptor.h.

template<typename TVectorContainer >

typedef SmartPointer< const Self > itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::ConstPointer

Definition at line 54 of file itkVectorContainerToListSampleAdaptor.h.

template<typename TVectorContainer >

typedef Superclass::InstanceIdentifier itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::InstanceIdentifier

Definition at line 80 of file itkVectorContainerToListSampleAdaptor.h.

template<typename TVectorContainer >

typedef Superclass::MeasurementType itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::MeasurementType

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

Definition at line 75 of file itkVectorContainerToListSampleAdaptor.h.

template<typename TVectorContainer >

typedef Superclass::MeasurementVectorSizeType itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::MeasurementVectorSizeType

Definition at line 79 of file itkVectorContainerToListSampleAdaptor.h.

template<typename TVectorContainer >

typedef Superclass::MeasurementVectorType itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::MeasurementVectorType

Definition at line 76 of file itkVectorContainerToListSampleAdaptor.h.

template<typename TVectorContainer >

typedef SmartPointer< Self > itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::Pointer

Definition at line 53 of file itkVectorContainerToListSampleAdaptor.h.

template<typename TVectorContainer >

typedef VectorContainerToListSampleAdaptor itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::Self

Standard class typedefs

Definition at line 51 of file itkVectorContainerToListSampleAdaptor.h.

template<typename TVectorContainer >

typedef ListSample<typename TVectorContainer::Element> itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::Superclass

Definition at line 52 of file itkVectorContainerToListSampleAdaptor.h.

template<typename TVectorContainer >

typedef Superclass::TotalAbsoluteFrequencyType itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::TotalAbsoluteFrequencyType

Definition at line 78 of file itkVectorContainerToListSampleAdaptor.h.

template<typename TVectorContainer >

typedef MeasurementVectorType itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::ValueType

Definition at line 82 of file itkVectorContainerToListSampleAdaptor.h.

template<typename TVectorContainer >

typedef TVectorContainer::ConstIterator itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::VectorContainerConstIterator

Definition at line 71 of file itkVectorContainerToListSampleAdaptor.h.

template<typename TVectorContainer >

typedef TVectorContainer::ConstPointer itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::VectorContainerConstPointer

Definition at line 69 of file itkVectorContainerToListSampleAdaptor.h.

template<typename TVectorContainer >

typedef TVectorContainer::Iterator itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::VectorContainerIterator

Definition at line 70 of file itkVectorContainerToListSampleAdaptor.h.

template<typename TVectorContainer >

typedef TVectorContainer::Pointer itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::VectorContainerPointer

Definition at line 68 of file itkVectorContainerToListSampleAdaptor.h.

template<typename TVectorContainer >

typedef TVectorContainer itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::VectorContainerType

VectorContainer typedefs

Definition at line 67 of file itkVectorContainerToListSampleAdaptor.h.

Constructor & Destructor Documentation

template<typename TVectorContainer >

itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::VectorContainerToListSampleAdaptor ( )

protected

template<typename TVectorContainer >

virtual itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::~VectorContainerToListSampleAdaptor ( )

inlineprotectedvirtual

Definition at line 255 of file itkVectorContainerToListSampleAdaptor.h.

template<typename TVectorContainer >

itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::VectorContainerToListSampleAdaptor ( const Self &  )

private

Member Function Documentation

template<typename TVectorContainer >

Iterator itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::Begin ( void  )

inline

returns an iterator that points to the beginning of the container

Definition at line 213 of file itkVectorContainerToListSampleAdaptor.h.

References itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::m_VectorContainer.

Referenced by itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::ConstIterator::ConstIterator().

template<typename TVectorContainer >

ConstIterator itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::Begin ( void  ) const

inline

returns an iterator that points to the beginning of the container

Definition at line 236 of file itkVectorContainerToListSampleAdaptor.h.

References itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::m_VectorContainer.

template<typename TVectorContainer >

virtual::itk::LightObject::Pointer itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::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<typename TVectorContainer >

Iterator itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::End ( void  )

inline

returns an iterator that points to the end of the container

Definition at line 224 of file itkVectorContainerToListSampleAdaptor.h.

References itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::m_VectorContainer.

template<typename TVectorContainer >

ConstIterator itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::End ( void  ) const

inline

returns an iterator that points to the end of the container

Definition at line 244 of file itkVectorContainerToListSampleAdaptor.h.

References itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::m_VectorContainer.

template<typename TVectorContainer >

AbsoluteFrequencyType itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::GetFrequency

(

InstanceIdentifier

)

const

returns 1 as other subclasses of ListSampleBase does

template<typename TVectorContainer >

const MeasurementVectorType& itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::GetMeasurementVector

(

InstanceIdentifier

)

const

returns the measurement vector that is specified by the instance identifier argument.

template<typename TVectorContainer >

virtual const char* itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::Statistics::ListSample< TVectorContainer::Element >.

template<typename TVectorContainer >

TotalAbsoluteFrequencyType itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::GetTotalFrequency ( ) const

virtual

returns the size of this container

Implements itk::Statistics::Sample< TVectorContainer::Element >.

template<typename TVectorContainer >

virtual const VectorContainerType* itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::GetVectorContainer ( ) const

virtual

Get/Set Method for the point set

template<typename TVectorContainer >

static Pointer itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::New ( )

static

Method for creation through the object factory.

template<typename TVectorContainer >

void itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::operator= ( const Self &  )

private

template<typename TVectorContainer >

void itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

protectedvirtual

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::Sample< TVectorContainer::Element >.

template<typename TVectorContainer >

virtual void itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::SetVectorContainer ( VectorContainerType *  _arg )

virtual

Get/Set Method for the point set

template<typename TVectorContainer >

InstanceIdentifier itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::Size ( ) const

virtual

returns the number of measurement vectors in this container

Implements itk::Statistics::Sample< TVectorContainer::Element >.

Member Data Documentation

template<typename TVectorContainer >

VectorContainerType::Element itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::m_TempPoint

mutableprivate

temporary points for conversions

Definition at line 267 of file itkVectorContainerToListSampleAdaptor.h.

template<typename TVectorContainer >

VectorContainerConstPointer itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::m_VectorContainer

private

the points container which will be actually used for storing measurement vectors

Definition at line 264 of file itkVectorContainerToListSampleAdaptor.h.

Referenced by itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::Begin(), and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::End().

template<typename TVectorContainer >

const unsigned int itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::MeasurementVectorSize = TVectorContainer::Element::Dimension

static

the number of components in a measurement vector

Definition at line 64 of file itkVectorContainerToListSampleAdaptor.h.

---

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

• itkVectorContainerToListSampleAdaptor.h