#include <itkPointSetToListSampleAdaptor.h>

Detailed Description

template<typename TPointSet>
class itk::Statistics::PointSetToListSampleAdaptor< TPointSet >

This class provides ListSample interface to ITK PointSet.

After calling SetPointSet(PointSet*) method to plug-in the PointSet object, users can use Sample interfaces to access PointSet data. This adaptor assumes that the PointsContainer is actual storage for measurement vectors. In other words, PointSet's dimension equals to the measurement vectors size. This class totally ignores PointsDataContainer.

See also: Sample, ListSample, PointSet

Examples: Examples/Statistics/PointSetToAdaptor.cxx, and Examples/Statistics/PointSetToListSampleAdaptor.cxx.

Definition at line 47 of file itkPointSetToListSampleAdaptor.h.

Inheritance diagram for itk::Statistics::PointSetToListSampleAdaptor< TPointSet >:

Collaboration diagram for itk::Statistics::PointSetToListSampleAdaptor< TPointSet >:

Classes
class	ConstIterator

class	Iterator

Public Types
typedef MeasurementVectorTraits::AbsoluteFrequencyType	AbsoluteFrequencyType

using	ConstPointer = SmartPointer<const Self>

typedef typename MeasurementVectorTraits::InstanceIdentifier	InstanceIdentifier

typedef typename MeasurementVectorTraitsTypes< MeasurementVectorType >::ValueType	MeasurementType

typedef unsigned int	MeasurementVectorSizeType

typedef typename TPointSet::PointType	MeasurementVectorType

using	Pointer = SmartPointer<Self>

using	PointsContainer = typename TPointSet::PointsContainer

using	PointsContainerConstIteratorType = typename TPointSet::PointsContainerConstIterator

using	PointsContainerConstPointer = typename TPointSet::PointsContainerConstPointer

using	PointsContainerIteratorType = typename TPointSet::PointsContainerIterator

using	PointsContainerPointer = typename TPointSet::PointsContainerPointer

using	PointSetConstPointer = typename TPointSet::ConstPointer

using	PointSetPointer = typename TPointSet::Pointer

using	PointSetType = TPointSet

using	PointType = typename TPointSet::PointType

using	Self = PointSetToListSampleAdaptor

using	Superclass = ListSample<typename TPointSet::PointType>

typedef NumericTraits< AbsoluteFrequencyType >::AccumulateType	TotalAbsoluteFrequencyType

using	ValueType = MeasurementVectorType

Public Types inherited from itk::Statistics::ListSample< TPointSet::PointType >
typedef MeasurementVectorTraits::AbsoluteFrequencyType	AbsoluteFrequencyType

using	AbsoluteFrequencyType

using	ConstPointer

typedef typename MeasurementVectorTraits::InstanceIdentifier	InstanceIdentifier

using	InstanceIdentifier

using	InternalDataContainerType

typedef typename MeasurementVectorTraitsTypes< MeasurementVectorType >::ValueType	MeasurementType

using	MeasurementType

typedef unsigned int	MeasurementVectorSizeType

using	MeasurementVectorSizeType

typedef TPointSet::PointType	MeasurementVectorType

using	MeasurementVectorType

using	Pointer

using	Self

using	Superclass

typedef NumericTraits< AbsoluteFrequencyType >::AccumulateType	TotalAbsoluteFrequencyType

using	TotalAbsoluteFrequencyType

using	ValueType

Public Types inherited from itk::Statistics::Sample< TPointSet::PointType >
using	AbsoluteFrequencyType

using	ConstPointer

using	InstanceIdentifier

using	MeasurementType

using	MeasurementVectorSizeType

using	MeasurementVectorType

using	Pointer

using	Self

using	Superclass

using	TotalAbsoluteFrequencyType

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

virtual::itk::LightObject::Pointer	CreateAnother () const

Iterator	End ()

ConstIterator	End () const

AbsoluteFrequencyType	GetFrequency (InstanceIdentifier id) const override

const MeasurementVectorType &	GetMeasurementVector (InstanceIdentifier identifier) const override

const char *	GetNameOfClass () const override

const TPointSet *	GetPointSet ()

TotalAbsoluteFrequencyType	GetTotalFrequency () const override

void	SetPointSet (const TPointSet *pointSet)

InstanceIdentifier	Size () const override


Iterator	Begin ()

Public Member Functions inherited from itk::Statistics::ListSample< TPointSet::PointType >
Iterator	Begin ()

ConstIterator	Begin () const

void	Clear ()

Iterator	End ()

ConstIterator	End () const

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)

Public Member Functions inherited from itk::Statistics::Sample< TPointSet::PointType >
virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const

const char *	GetNameOfClass () const override

void	Graft (const DataObject *thatObject) override

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

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

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

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) 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 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< TPointSet::PointType >
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 ()

Protected Member Functions
	PointSetToListSampleAdaptor ()

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

	~PointSetToListSampleAdaptor () override=default

Protected Member Functions inherited from itk::Statistics::ListSample< TPointSet::PointType >
	ListSample ()=default

	~ListSample () override=default

Protected Member Functions inherited from itk::Statistics::Sample< TPointSet::PointType >
void	PrintSelf (std::ostream &os, Indent indent) const override

	Sample ()

	~Sample () override=default

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

virtual void	PropagateResetPipeline ()

	~DataObject () override

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

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

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

virtual	~LightObject ()

Private Attributes
PointsContainerConstPointer	m_PointsContainer {}

PointSetConstPointer	m_PointSet {}

PointType	m_TempPoint {}

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

Member Typedef Documentation

◆ AbsoluteFrequencyType

template<typename TPointSet>

Frequency value type

◆ ConstPointer

template<typename TPointSet>

using itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::ConstPointer = SmartPointer<const Self>

Definition at line 56 of file itkPointSetToListSampleAdaptor.h.

◆ InstanceIdentifier

template<typename TPointSet>

InstanceIdentifier type alias. This identifier is a unique sequential id for each measurement vector in a Sample subclass.

◆ MeasurementType

template<typename TPointSet>

ValueType of a measurement (ValueType of a component of the MeasurementVector

◆ MeasurementVectorSizeType

template<typename TPointSet>

Type of the length of each measurement vector

◆ MeasurementVectorType

template<typename TPointSet>

MeasurementVector type alias support

◆ Pointer

template<typename TPointSet>

using itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::Pointer = SmartPointer<Self>

Definition at line 55 of file itkPointSetToListSampleAdaptor.h.

◆ PointsContainer

template<typename TPointSet>

using itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::PointsContainer = typename TPointSet::PointsContainer

Definition at line 68 of file itkPointSetToListSampleAdaptor.h.

◆ PointsContainerConstIteratorType

template<typename TPointSet>

using itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::PointsContainerConstIteratorType = typename TPointSet::PointsContainerConstIterator

Definition at line 72 of file itkPointSetToListSampleAdaptor.h.

◆ PointsContainerConstPointer

template<typename TPointSet>

using itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::PointsContainerConstPointer = typename TPointSet::PointsContainerConstPointer

Definition at line 70 of file itkPointSetToListSampleAdaptor.h.

◆ PointsContainerIteratorType

template<typename TPointSet>

using itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::PointsContainerIteratorType = typename TPointSet::PointsContainerIterator

Definition at line 71 of file itkPointSetToListSampleAdaptor.h.

◆ PointsContainerPointer

template<typename TPointSet>

using itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::PointsContainerPointer = typename TPointSet::PointsContainerPointer

Definition at line 69 of file itkPointSetToListSampleAdaptor.h.

◆ PointSetConstPointer

template<typename TPointSet>

using itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::PointSetConstPointer = typename TPointSet::ConstPointer

Definition at line 67 of file itkPointSetToListSampleAdaptor.h.

◆ PointSetPointer

template<typename TPointSet>

using itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::PointSetPointer = typename TPointSet::Pointer

Definition at line 66 of file itkPointSetToListSampleAdaptor.h.

◆ PointSetType

template<typename TPointSet>

using itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::PointSetType = TPointSet

PointSet type alias

Definition at line 65 of file itkPointSetToListSampleAdaptor.h.

◆ PointType

template<typename TPointSet>

using itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::PointType = typename TPointSet::PointType

Definition at line 73 of file itkPointSetToListSampleAdaptor.h.

◆ Self

template<typename TPointSet>

using itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::Self = PointSetToListSampleAdaptor

Standard class type aliases

Definition at line 53 of file itkPointSetToListSampleAdaptor.h.

◆ Superclass

template<typename TPointSet>

using itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::Superclass = ListSample<typename TPointSet::PointType>

Definition at line 54 of file itkPointSetToListSampleAdaptor.h.

◆ TotalAbsoluteFrequencyType

template<typename TPointSet>

Total frequency type

◆ ValueType

template<typename TPointSet>

using itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::ValueType = MeasurementVectorType

Definition at line 84 of file itkPointSetToListSampleAdaptor.h.

Constructor & Destructor Documentation

◆ PointSetToListSampleAdaptor()

template<typename TPointSet>

itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::PointSetToListSampleAdaptor ( )

protected

Referenced by GetNameOfClass().

◆ ~PointSetToListSampleAdaptor()

template<typename TPointSet>

itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::~PointSetToListSampleAdaptor ( )

overrideprotecteddefault

Member Function Documentation

◆ Begin() [1/2]

template<typename TPointSet>

Iterator itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::Begin ( )

inline

returns an iterator that points to the beginning of the container

Definition at line 223 of file itkPointSetToListSampleAdaptor.h.

References m_PointsContainer.

Referenced by itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::ConstIterator::ConstIterator().

◆ Begin() [2/2]

template<typename TPointSet>

ConstIterator itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::Begin ( ) const

inline

returns an iterator that points to the beginning of the container

Definition at line 247 of file itkPointSetToListSampleAdaptor.h.

References m_PointsContainer.

◆ CreateAnother()

template<typename TPointSet>

virtual::itk::LightObject::Pointer itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::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::Statistics::ListSample< TPointSet::PointType >.

◆ End() [1/2]

template<typename TPointSet>

Iterator itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::End ( )

inline

returns an iterator that points to the end of the container

Definition at line 235 of file itkPointSetToListSampleAdaptor.h.

References m_PointsContainer.

◆ End() [2/2]

template<typename TPointSet>

ConstIterator itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::End ( ) const

inline

returns an iterator that points to the end of the container

Definition at line 256 of file itkPointSetToListSampleAdaptor.h.

References m_PointsContainer.

◆ GetFrequency()

template<typename TPointSet>

AbsoluteFrequencyType itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::GetFrequency ( InstanceIdentifier id ) const

overridevirtual

returns 1 as other subclasses of ListSampleBase does

Reimplemented from itk::Statistics::ListSample< TPointSet::PointType >.

◆ GetMeasurementVector()

template<typename TPointSet>

const MeasurementVectorType & itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::GetMeasurementVector ( InstanceIdentifier identifier ) const

overridevirtual

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

Reimplemented from itk::Statistics::ListSample< TPointSet::PointType >.

◆ GetNameOfClass()

template<typename TPointSet>

const char * itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Statistics::ListSample< TPointSet::PointType >.

References PointSetToListSampleAdaptor().

◆ GetPointSet()

template<typename TPointSet>

const TPointSet * itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::GetPointSet ( )

Method to get the point set

◆ GetTotalFrequency()

template<typename TPointSet>

TotalAbsoluteFrequencyType itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::GetTotalFrequency ( ) const

overridevirtual

returns the size of this container

Reimplemented from itk::Statistics::ListSample< TPointSet::PointType >.

◆ New()

template<typename TPointSet>

static Pointer itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TPointSet>

void itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::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::Statistics::ListSample< TPointSet::PointType >.

◆ SetPointSet()

template<typename TPointSet>

void itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::SetPointSet ( const TPointSet * pointSet )

Method to set the point set

◆ Size()

template<typename TPointSet>

InstanceIdentifier itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::Size ( ) const

overridevirtual

returns the number of measurement vectors in this container

Reimplemented from itk::Statistics::ListSample< TPointSet::PointType >.

Member Data Documentation

◆ m_PointsContainer

template<typename TPointSet>

PointsContainerConstPointer itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::m_PointsContainer {}

private

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

Definition at line 276 of file itkPointSetToListSampleAdaptor.h.

Referenced by Begin(), Begin(), End(), and End().

◆ m_PointSet

template<typename TPointSet>

PointSetConstPointer itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::m_PointSet {}

private

the PointSet data source pointer

Definition at line 272 of file itkPointSetToListSampleAdaptor.h.

◆ m_TempPoint

template<typename TPointSet>

PointType itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::m_TempPoint {}

mutableprivate

temporary points for conversions

Definition at line 279 of file itkPointSetToListSampleAdaptor.h.

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

itkPointSetToListSampleAdaptor.h

Detailed Description

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ AbsoluteFrequencyType

◆ ConstPointer

◆ InstanceIdentifier

◆ MeasurementType

◆ MeasurementVectorSizeType

◆ MeasurementVectorType

◆ Pointer

◆ PointsContainer

◆ PointsContainerConstIteratorType

◆ PointsContainerConstPointer

◆ PointsContainerIteratorType

◆ PointsContainerPointer

◆ PointSetConstPointer

◆ PointSetPointer

◆ PointSetType

◆ PointType

◆ Self

◆ Superclass

◆ TotalAbsoluteFrequencyType

◆ ValueType

Constructor & Destructor Documentation

◆ PointSetToListSampleAdaptor()

◆ ~PointSetToListSampleAdaptor()

Member Function Documentation

◆ Begin() [1/2]

◆ Begin() [2/2]

◆ CreateAnother()

◆ End() [1/2]

◆ End() [2/2]

◆ GetFrequency()

◆ GetMeasurementVector()

◆ GetNameOfClass()

◆ GetPointSet()

◆ GetTotalFrequency()

◆ New()

◆ PrintSelf()

◆ SetPointSet()

◆ Size()

Member Data Documentation

◆ m_PointsContainer

◆ m_PointSet

◆ m_TempPoint