#include <itkVectorContainerToListSampleAdaptor.h>

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.

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

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

Classes
class	ConstIterator

class	Iterator

Public Types
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = VectorContainerToListSampleAdaptor

using	Superclass = ListSample< typename TVectorContainer::Element >

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	ConstPointer = SmartPointer< const Self >

using	InternalDataContainerType = std::vector< MeasurementVectorType >

using	Pointer = SmartPointer< Self >

using	Self = ListSample

using	Superclass = Sample< TVectorContainer::Element >

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
ConstIterator	Begin () const

Iterator	End ()

AbsoluteFrequencyType	GetFrequency (InstanceIdentifier) const override

const MeasurementVectorType &	GetMeasurementVector (InstanceIdentifier) const override

const char *	GetNameOfClass () const override

TotalAbsoluteFrequencyType	GetTotalFrequency () const override

InstanceIdentifier	Size () const override


virtual void	SetVectorContainer (VectorContainerType *_arg)

virtual const VectorContainerType *	GetVectorContainer () const


Iterator	Begin ()


ConstIterator	End () const

Public Member Functions inherited from itk::Statistics::ListSample< TVectorContainer::Element >
Iterator	Begin ()

ConstIterator	Begin () const

void	Clear ()

Iterator	End ()

ConstIterator	End () const

AbsoluteFrequencyType	GetFrequency (InstanceIdentifier instanceId) const override

const MeasurementVectorType &	GetMeasurementVector (InstanceIdentifier instanceId) const override

const char *	GetNameOfClass () 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

const char *	GetNameOfClass () const override

virtual TotalAbsoluteFrequencyType	GetTotalFrequency () const=0

void	Graft (const DataObject *thatObject) override

virtual InstanceIdentifier	Size () 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

const char *	GetNameOfClass () const override

virtual const bool &	GetReleaseDataFlag () const

SmartPointer< ProcessObject >	GetSource () const

DataObjectPointerArraySizeType	GetSourceOutputIndex () const

const DataObjectIdentifierType &	GetSourceOutputName () const

virtual ModifiedTimeType	GetUpdateMTime () const

virtual void	Graft (const DataObject *)

virtual void	Initialize ()

virtual void	PrepareForNewData ()

virtual void	PropagateRequestedRegion ()

void	ReleaseData ()

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 ()

void	UpdateSource () const

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 *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

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

const char *	GetNameOfClass () const override

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) const

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 Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

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

Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const override

	VectorContainerToListSampleAdaptor ()

	~VectorContainerToListSampleAdaptor () override=default

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 ()

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	PropagateResetPipeline ()

	~DataObject () override

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~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	PrintSelf (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Attributes
VectorContainerConstPointer	m_VectorContainer {}

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<typename TVectorContainer >

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

Definition at line 55 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.

◆ 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

◆ ~VectorContainerToListSampleAdaptor()

template<typename TVectorContainer >

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

overrideprotecteddefault

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

◆ 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 228 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 249 of file itkVectorContainerToListSampleAdaptor.h.

◆ GetFrequency()

template<typename TVectorContainer >

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

overridevirtual

Returns 1 as other subclasses of ListSampleBase does.

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

◆ GetMeasurementVector()

template<typename TVectorContainer >

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

overridevirtual

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

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

◆ GetNameOfClass()

template<typename TVectorContainer >

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::DataObject.

◆ 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

Get/Set method for the point set 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

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

◆ SetVectorContainer()

template<typename TVectorContainer >

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

virtual

Get/Set method for the point set container which will be actually used for storing measurement vectors.

◆ 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

Definition at line 264 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

Detailed Description

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

◆ ValueType

◆ VectorContainerConstIterator

◆ VectorContainerConstPointer

◆ VectorContainerIterator

◆ VectorContainerPointer

◆ VectorContainerType

Constructor & Destructor Documentation

◆ VectorContainerToListSampleAdaptor()

◆ ~VectorContainerToListSampleAdaptor()

Member Function Documentation

◆ Begin() [1/2]

◆ Begin() [2/2]

◆ End() [1/2]

◆ End() [2/2]

◆ GetFrequency()

◆ GetMeasurementVector()

◆ GetNameOfClass()

◆ GetTotalFrequency()

◆ GetVectorContainer()

◆ New()

◆ PrintSelf()

◆ SetVectorContainer()

◆ Size()

Member Data Documentation

◆ m_VectorContainer

◆ MeasurementVectorSize