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

#include <itkVectorContainerToListSampleAdaptor.h>

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

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

Classes
class	ConstIterator
class	Iterator

Public Types
using	AbsoluteFrequencyType = typename Superclass::AbsoluteFrequencyType
using	ConstPointer = SmartPointer< const Self >
using	InstanceIdentifier = typename Superclass::InstanceIdentifier
using	MeasurementType = typename Superclass::MeasurementType
using	MeasurementVectorSizeType = typename Superclass::MeasurementVectorSizeType
using	MeasurementVectorType = typename Superclass::MeasurementVectorType
using	Pointer = SmartPointer< Self >
using	Self = VectorContainerToListSampleAdaptor
using	Superclass = ListSample< typename TVectorContainer::Element >
using	TotalAbsoluteFrequencyType = typename Superclass::TotalAbsoluteFrequencyType
using	ValueType = MeasurementVectorType
using	VectorContainerConstIterator = typename TVectorContainer::ConstIterator
using	VectorContainerConstPointer = typename TVectorContainer::ConstPointer
using	VectorContainerIterator = typename TVectorContainer::Iterator
using	VectorContainerPointer = typename TVectorContainer::Pointer
using	VectorContainerType = TVectorContainer
Public Types inherited from itk::Statistics::ListSample< TVectorContainer::Element >
using	AbsoluteFrequencyType = typename Superclass::AbsoluteFrequencyType
using	ConstPointer = SmartPointer< const Self >
using	InstanceIdentifier = typename Superclass::InstanceIdentifier
using	InternalDataContainerType = std::vector< MeasurementVectorType >
using	MeasurementType = typename Superclass::MeasurementType
using	MeasurementVectorSizeType = typename Superclass::MeasurementVectorSizeType
using	MeasurementVectorType = typename Superclass::MeasurementVectorType
using	Pointer = SmartPointer< Self >
using	Self = ListSample
using	Superclass = Sample< TVectorContainer::Element >
using	TotalAbsoluteFrequencyType = typename Superclass::TotalAbsoluteFrequencyType
using	ValueType = MeasurementVectorType
Public Types inherited from itk::Statistics::Sample< TVectorContainer::Element >
using	AbsoluteFrequencyType = MeasurementVectorTraits::AbsoluteFrequencyType
using	ConstPointer = SmartPointer< const Self >
using	InstanceIdentifier = typename MeasurementVectorTraits::InstanceIdentifier
using	MeasurementType = typename MeasurementVectorTraitsTypes< MeasurementVectorType >::ValueType
using	MeasurementVectorSizeType = unsigned int
using	MeasurementVectorType = TVectorContainer::Element
using	Pointer = SmartPointer< Self >
using	Self = Sample
using	Superclass = DataObject
using	TotalAbsoluteFrequencyType = NumericTraits< AbsoluteFrequencyType >::AccumulateType
Public Types inherited from itk::DataObject
using	ConstPointer = SmartPointer< const Self >
using	DataObjectIdentifierType = std::string
using	DataObjectPointerArraySizeType = std::vector< Pointer >::size_type
using	Pointer = SmartPointer< Self >
using	Self = DataObject
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
virtual const char *	GetNameOfClass () const
Public Member Functions inherited from itk::Statistics::ListSample< TVectorContainer::Element >
Iterator	Begin ()
ConstIterator	Begin () const
void	Clear ()
virtual ::itk::LightObject::Pointer	CreateAnother () const
Iterator	End ()
ConstIterator	End () const
AbsoluteFrequencyType	GetFrequency (InstanceIdentifier instanceId) const override
const MeasurementVectorType &	GetMeasurementVector (InstanceIdentifier instanceId) const override
TotalAbsoluteFrequencyType	GetTotalFrequency () const override
void	Graft (const DataObject *thatObject) override
void	PushBack (const MeasurementVectorType &mv)
void	Resize (InstanceIdentifier newsize)
void	SetMeasurement (InstanceIdentifier instanceId, unsigned int dim, const MeasurementType &value)
void	SetMeasurementVector (InstanceIdentifier instanceId, const MeasurementVectorType &mv)
InstanceIdentifier	Size () const override
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
void	Graft (const DataObject *thatObject) override
virtual void	SetMeasurementVectorSize (MeasurementVectorSizeType s)
Public Member Functions inherited from itk::DataObject
void	DisconnectPipeline ()
bool	GetDataReleased () const
virtual const bool &	GetReleaseDataFlag () const
SmartPointer< ProcessObject >	GetSource () const
DataObjectPointerArraySizeType	GetSourceOutputIndex () const
const DataObjectIdentifierType &	GetSourceOutputName () const
virtual void	Initialize ()
virtual void	PropagateRequestedRegion ()
void	ReleaseData ()
virtual void	ReleaseDataFlagOff ()
virtual void	ReleaseDataFlagOn ()
virtual void	ResetPipeline ()
void	SetReleaseDataFlag (bool flag)
bool	ShouldIReleaseData () const
virtual void	Update ()
virtual void	UpdateOutputData ()
virtual void	UpdateOutputInformation ()
void	SetPipelineMTime (ModifiedTimeType time)
virtual const ModifiedTimeType &	GetPipelineMTime () const
virtual ModifiedTimeType	GetUpdateMTime () const
virtual void	SetRealTimeStamp (RealTimeStamp _arg)
virtual const RealTimeStamp &	GetRealTimeStamp () const
virtual void	PrepareForNewData ()
virtual void	DataHasBeenGenerated ()
virtual void	SetRequestedRegionToLargestPossibleRegion ()
virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()
virtual bool	VerifyRequestedRegion ()
virtual void	CopyInformation (const DataObject *)
virtual void	SetRequestedRegion (const DataObject *)
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () 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
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
Pointer	Clone () const
virtual void	Delete ()
virtual int	GetReferenceCount () const
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 Pointer	New ()
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 val)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	MeasurementVectorSize = TVectorContainer::Element::Dimension
VectorContainerConstPointer	m_VectorContainer
virtual void	SetVectorContainer (VectorContainerType *_arg)
virtual const VectorContainerType *	GetVectorContainer () const
InstanceIdentifier	Size () const override
const MeasurementVectorType &	GetMeasurementVector (InstanceIdentifier) const override
AbsoluteFrequencyType	GetFrequency (InstanceIdentifier) const override
TotalAbsoluteFrequencyType	GetTotalFrequency () const override
Iterator	Begin ()
Iterator	End ()
ConstIterator	Begin () const
ConstIterator	End () const
	VectorContainerToListSampleAdaptor ()
	~VectorContainerToListSampleAdaptor () override=default
void	PrintSelf (std::ostream &os, Indent indent) const override

Additional Inherited Members
Protected Member Functions inherited from itk::Statistics::ListSample< TVectorContainer::Element >
	ListSample ()=default
void	PrintSelf (std::ostream &os, Indent indent) const override
	~ListSample () override=default
Protected Member Functions inherited from itk::Statistics::Sample< TVectorContainer::Element >
void	PrintSelf (std::ostream &os, Indent indent) const override
	Sample ()
	~Sample () override=default
Protected Member Functions inherited from itk::DataObject
	DataObject ()
	~DataObject () override
virtual void	PropagateResetPipeline ()
Protected Member Functions inherited from itk::Object
	Object ()
	~Object () override
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &timeStamp)
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
std::atomic< int >	m_ReferenceCount

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 measurement 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.

Member Typedef Documentation

AbsoluteFrequencyType

template<typename TVectorContainer >

using itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::AbsoluteFrequencyType = typename Superclass::AbsoluteFrequencyType

Definition at line 77 of file itkVectorContainerToListSampleAdaptor.h.

ConstPointer

template<typename TVectorContainer >

using itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::ConstPointer = SmartPointer<const Self>

Definition at line 55 of file itkVectorContainerToListSampleAdaptor.h.

InstanceIdentifier

template<typename TVectorContainer >

using itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::InstanceIdentifier = typename Superclass::InstanceIdentifier

Definition at line 80 of file itkVectorContainerToListSampleAdaptor.h.

MeasurementType

template<typename TVectorContainer >

using itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::MeasurementType = typename Superclass::MeasurementType

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

Definition at line 75 of file itkVectorContainerToListSampleAdaptor.h.

MeasurementVectorSizeType

template<typename TVectorContainer >

using itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::MeasurementVectorSizeType = typename Superclass::MeasurementVectorSizeType

Definition at line 79 of file itkVectorContainerToListSampleAdaptor.h.

MeasurementVectorType

template<typename TVectorContainer >

using itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::MeasurementVectorType = typename Superclass::MeasurementVectorType

Definition at line 76 of file itkVectorContainerToListSampleAdaptor.h.

Pointer

template<typename TVectorContainer >

using itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::Pointer = SmartPointer<Self>

Definition at line 54 of file itkVectorContainerToListSampleAdaptor.h.

Self

template<typename TVectorContainer >

using itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::Self = VectorContainerToListSampleAdaptor

Standard class type aliases

Definition at line 52 of file itkVectorContainerToListSampleAdaptor.h.

Superclass

template<typename TVectorContainer >

using itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::Superclass = ListSample<typename TVectorContainer::Element>

Definition at line 53 of file itkVectorContainerToListSampleAdaptor.h.

TotalAbsoluteFrequencyType

template<typename TVectorContainer >

using itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::TotalAbsoluteFrequencyType = typename Superclass::TotalAbsoluteFrequencyType

Definition at line 78 of file itkVectorContainerToListSampleAdaptor.h.

ValueType

template<typename TVectorContainer >

using itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::ValueType = MeasurementVectorType

Definition at line 82 of file itkVectorContainerToListSampleAdaptor.h.

VectorContainerConstIterator

template<typename TVectorContainer >

using itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::VectorContainerConstIterator = typename TVectorContainer::ConstIterator

Definition at line 71 of file itkVectorContainerToListSampleAdaptor.h.

VectorContainerConstPointer

template<typename TVectorContainer >

using itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::VectorContainerConstPointer = typename TVectorContainer::ConstPointer

Definition at line 69 of file itkVectorContainerToListSampleAdaptor.h.

VectorContainerIterator

template<typename TVectorContainer >

using itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::VectorContainerIterator = typename TVectorContainer::Iterator

Definition at line 70 of file itkVectorContainerToListSampleAdaptor.h.

VectorContainerPointer

template<typename TVectorContainer >

using itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::VectorContainerPointer = typename TVectorContainer::Pointer

Definition at line 68 of file itkVectorContainerToListSampleAdaptor.h.

VectorContainerType

template<typename TVectorContainer >

using itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::VectorContainerType = TVectorContainer

VectorContainer type alias

Definition at line 67 of file itkVectorContainerToListSampleAdaptor.h.

Constructor & Destructor Documentation

VectorContainerToListSampleAdaptor()

template<typename TVectorContainer >

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

protected

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

~VectorContainerToListSampleAdaptor()

template<typename TVectorContainer >

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

overrideprotecteddefault

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

Member Function Documentation

Begin() [1/2]

template<typename TVectorContainer >

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

inline

returns an iterator that points to the beginning of the container

Definition at line 219 of file itkVectorContainerToListSampleAdaptor.h.

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

Begin() [2/2]

template<typename TVectorContainer >

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

inline

returns an iterator that points to the beginning of the container

Definition at line 243 of file itkVectorContainerToListSampleAdaptor.h.

CreateAnother()

template<typename TVectorContainer >

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

End() [1/2]

template<typename TVectorContainer >

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

inline

returns an iterator that points to the end of the container

Definition at line 231 of file itkVectorContainerToListSampleAdaptor.h.

End() [2/2]

template<typename TVectorContainer >

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

inline

returns an iterator that points to the end of the container

Definition at line 252 of file itkVectorContainerToListSampleAdaptor.h.

GetFrequency()

template<typename TVectorContainer >

AbsoluteFrequencyType itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::GetFrequency ( InstanceIdentifier  ) const

override

returns 1 as other subclasses of ListSampleBase does

GetMeasurementVector()

template<typename TVectorContainer >

const MeasurementVectorType& itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >::GetMeasurementVector ( InstanceIdentifier  ) const

override

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

GetNameOfClass()

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

GetTotalFrequency()

template<typename TVectorContainer >

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

overridevirtual

returns the size of this container

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

GetVectorContainer()

template<typename TVectorContainer >

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

virtual

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

New()

template<typename TVectorContainer >

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

static

Method for creation through the object factory.

PrintSelf()

template<typename TVectorContainer >

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

overrideprotectedvirtual

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

Reimplemented from itk::DataObject.

SetVectorContainer()

template<typename TVectorContainer >

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

virtual

Get/Set Method for the point set

Size()

template<typename TVectorContainer >

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

overridevirtual

returns the number of measurement vectors in this container

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

Member Data Documentation

m_VectorContainer

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 269 of file itkVectorContainerToListSampleAdaptor.h.

MeasurementVectorSize

template<typename TVectorContainer >

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

staticconstexpr

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