ITK  5.1.0
Insight Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
itk::Statistics::PointSetToListSampleAdaptor< TPointSet > Class Template Reference

#include <itkPointSetToListSampleAdaptor.h>

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

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 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 >
 
using TotalAbsoluteFrequencyType = typename Superclass::TotalAbsoluteFrequencyType
 
using ValueType = MeasurementVectorType
 
- Public Types inherited from itk::Statistics::ListSample< TPointSet::PointType >
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< TPointSet::PointType >
 
using TotalAbsoluteFrequencyType = typename Superclass::TotalAbsoluteFrequencyType
 
using ValueType = MeasurementVectorType
 
- Public Types inherited from itk::Statistics::Sample< TPointSet::PointType >
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 = TPointSet::PointType
 
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
 
AbsoluteFrequencyType GetFrequency (InstanceIdentifier id) const override
 
const MeasurementVectorTypeGetMeasurementVector (InstanceIdentifier id) const override
 
virtual const char * GetNameOfClass () const
 
const TPointSet * GetPointSet ()
 
TotalAbsoluteFrequencyType GetTotalFrequency () const override
 
void SetPointSet (const TPointSet *pointSet)
 
InstanceIdentifier Size () const override
 
- Public Member Functions inherited from itk::Statistics::ListSample< TPointSet::PointType >
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
 
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< TPointSet::PointType >
virtual AbsoluteFrequencyType GetFrequency (InstanceIdentifier id) const=0
 
virtual const MeasurementVectorTypeGetMeasurementVector (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< ProcessObjectGetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () 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 ModifiedTimeTypeGetPipelineMTime () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStampGetRealTimeStamp () 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
 
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
 
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
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< 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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
PointSetConstPointer m_PointSet
 
PointsContainerConstPointer m_PointsContainer
 
PointType m_TempPoint
 
Iterator Begin ()
 
Iterator End ()
 
ConstIterator Begin () const
 
ConstIterator End () const
 
 PointSetToListSampleAdaptor ()
 
 ~PointSetToListSampleAdaptor () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- Protected Member Functions inherited from itk::Statistics::ListSample< TPointSet::PointType >
 ListSample ()=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~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 ()
 
 ~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 &time)
 
- 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 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 46 of file itkPointSetToListSampleAdaptor.h.

Member Typedef Documentation

◆ AbsoluteFrequencyType

template<typename TPointSet >
using itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::AbsoluteFrequencyType = typename Superclass::AbsoluteFrequencyType

Definition at line 78 of file itkPointSetToListSampleAdaptor.h.

◆ ConstPointer

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

Definition at line 55 of file itkPointSetToListSampleAdaptor.h.

◆ InstanceIdentifier

template<typename TPointSet >
using itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::InstanceIdentifier = typename Superclass::InstanceIdentifier

Definition at line 81 of file itkPointSetToListSampleAdaptor.h.

◆ MeasurementType

template<typename TPointSet >
using itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::MeasurementType = typename Superclass::MeasurementType

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

Definition at line 76 of file itkPointSetToListSampleAdaptor.h.

◆ MeasurementVectorSizeType

template<typename TPointSet >
using itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::MeasurementVectorSizeType = typename Superclass::MeasurementVectorSizeType

Definition at line 80 of file itkPointSetToListSampleAdaptor.h.

◆ MeasurementVectorType

template<typename TPointSet >
using itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::MeasurementVectorType = typename Superclass::MeasurementVectorType

Definition at line 77 of file itkPointSetToListSampleAdaptor.h.

◆ Pointer

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

Definition at line 54 of file itkPointSetToListSampleAdaptor.h.

◆ PointsContainer

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

Definition at line 67 of file itkPointSetToListSampleAdaptor.h.

◆ PointsContainerConstIteratorType

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

Definition at line 71 of file itkPointSetToListSampleAdaptor.h.

◆ PointsContainerConstPointer

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

Definition at line 69 of file itkPointSetToListSampleAdaptor.h.

◆ PointsContainerIteratorType

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

Definition at line 70 of file itkPointSetToListSampleAdaptor.h.

◆ PointsContainerPointer

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

Definition at line 68 of file itkPointSetToListSampleAdaptor.h.

◆ PointSetConstPointer

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

Definition at line 66 of file itkPointSetToListSampleAdaptor.h.

◆ PointSetPointer

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

Definition at line 65 of file itkPointSetToListSampleAdaptor.h.

◆ PointSetType

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

PointSet type alias

Definition at line 64 of file itkPointSetToListSampleAdaptor.h.

◆ PointType

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

Definition at line 72 of file itkPointSetToListSampleAdaptor.h.

◆ Self

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

Standard class type aliases

Definition at line 52 of file itkPointSetToListSampleAdaptor.h.

◆ Superclass

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

Definition at line 53 of file itkPointSetToListSampleAdaptor.h.

◆ TotalAbsoluteFrequencyType

template<typename TPointSet >
using itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::TotalAbsoluteFrequencyType = typename Superclass::TotalAbsoluteFrequencyType

Definition at line 79 of file itkPointSetToListSampleAdaptor.h.

◆ ValueType

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

Definition at line 83 of file itkPointSetToListSampleAdaptor.h.

Constructor & Destructor Documentation

◆ PointSetToListSampleAdaptor()

template<typename TPointSet >
itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::PointSetToListSampleAdaptor ( )
protected

the PointSet data source pointer

◆ ~PointSetToListSampleAdaptor()

template<typename TPointSet >
itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::~PointSetToListSampleAdaptor ( )
overrideprotecteddefault

the PointSet data source pointer

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 227 of file itkPointSetToListSampleAdaptor.h.

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 249 of file itkPointSetToListSampleAdaptor.h.

◆ 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::Object.

◆ 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 238 of file itkPointSetToListSampleAdaptor.h.

◆ 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 258 of file itkPointSetToListSampleAdaptor.h.

◆ GetFrequency()

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

returns 1 as other subclasses of ListSampleBase does

◆ GetMeasurementVector()

template<typename TPointSet >
const MeasurementVectorType& itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::GetMeasurementVector ( InstanceIdentifier  id) const
override

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

◆ GetNameOfClass()

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

Run-time type information (and related methods).

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

◆ 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

Implements itk::Statistics::Sample< 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

the PointSet data source pointer

Reimplemented from itk::DataObject.

◆ 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

Implements itk::Statistics::Sample< 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 278 of file itkPointSetToListSampleAdaptor.h.

◆ m_PointSet

template<typename TPointSet >
PointSetConstPointer itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::m_PointSet
private

the PointSet data source pointer

Definition at line 274 of file itkPointSetToListSampleAdaptor.h.

◆ m_TempPoint

template<typename TPointSet >
PointType itk::Statistics::PointSetToListSampleAdaptor< TPointSet >::m_TempPoint
mutableprivate

temporary points for conversions

Definition at line 281 of file itkPointSetToListSampleAdaptor.h.


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