ITK  4.3.0
Insight Segmentation and Registration Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::Statistics::ListSample< TMeasurementVector > Class Template Reference

#include <itkListSample.h>

+ Inheritance diagram for itk::Statistics::ListSample< TMeasurementVector >:
+ Collaboration diagram for itk::Statistics::ListSample< TMeasurementVector >:

Detailed Description

template<class TMeasurementVector>
class itk::Statistics::ListSample< TMeasurementVector >

This class is the native implementation of the a Sample with an STL container.

ListSample stores measurements in a list type structure (as opposed to a Histogram, etc.). ListSample allows duplicate measurements. ListSample is not sorted.

ListSample does not allow the user to specify the frequency of a measurement directly. The GetFrequency() methods returns 1 if the measurement exists in the list, 0 otherwise.

See Also
Sample, Histogram
Wiki Examples:

Definition at line 51 of file itkListSample.h.

Classes

class  ConstIterator
 Const Iterator. More...
 
class  Iterator
 Iterator. More...
 

Public Types

typedef
Superclass::AbsoluteFrequencyType 
AbsoluteFrequencyType
 
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::InstanceIdentifier 
InstanceIdentifier
 
typedef std::vector
< MeasurementVectorType
InternalDataContainerType
 
typedef Superclass::MeasurementType MeasurementType
 
typedef
Superclass::MeasurementVectorSizeType 
MeasurementVectorSizeType
 
typedef
Superclass::MeasurementVectorType 
MeasurementVectorType
 
typedef SmartPointer< SelfPointer
 
typedef ListSample Self
 
typedef Sample
< TMeasurementVector > 
Superclass
 
typedef
Superclass::TotalAbsoluteFrequencyType 
TotalAbsoluteFrequencyType
 
typedef MeasurementVectorType ValueType
 
- Public Types inherited from itk::Statistics::Sample< TMeasurementVector >
typedef
MeasurementVectorTraits::AbsoluteFrequencyType 
AbsoluteFrequencyType
 
typedef SmartPointer< const SelfConstPointer
 
typedef
MeasurementVectorTraits::InstanceIdentifier 
InstanceIdentifier
 
typedef
MeasurementVectorTraitsTypes
< MeasurementVectorType >
::ValueType 
MeasurementType
 
typedef unsigned int MeasurementVectorSizeType
 
typedef TMeasurementVector MeasurementVectorType
 
typedef SmartPointer< SelfPointer
 
typedef Sample Self
 
typedef DataObject Superclass
 
typedef NumericTraits
< AbsoluteFrequencyType >
::AccumulateType 
TotalAbsoluteFrequencyType
 
- Public Types inherited from itk::DataObject
typedef SmartPointer< const SelfConstPointer
 
typedef std::string DataObjectIdentifierType
 
typedef std::vector< Pointer >
::size_type 
DataObjectPointerArraySizeType
 
typedef SmartPointer< SelfPointer
 
typedef DataObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

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 MeasurementVectorTypeGetMeasurementVector (InstanceIdentifier id) const
 
virtual const char * GetNameOfClass () 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< TMeasurementVector >
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 ()
 
SmartPointerForwardReference
< ProcessObject
GetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () 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 ModifiedTimeTypeGetPipelineMTime ()
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStampGetRealTimeStamp ()
 
- 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 (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) 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
 
virtual void Register () const
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () 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 ()
 

Protected Member Functions

 ListSample ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
virtual ~ListSample ()
 
- Protected Member Functions inherited from itk::Statistics::Sample< TMeasurementVector >
void PrintSelf (std::ostream &os, Indent indent) const
 
 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

 ListSample (const Self &)
 
void operator= (const Self &)
 

Private Attributes

InternalDataContainerType m_InternalContainer
 

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<class TMeasurementVector>
typedef Superclass::AbsoluteFrequencyType itk::Statistics::ListSample< TMeasurementVector >::AbsoluteFrequencyType

Definition at line 70 of file itkListSample.h.

template<class TMeasurementVector>
typedef SmartPointer< const Self > itk::Statistics::ListSample< TMeasurementVector >::ConstPointer

Definition at line 58 of file itkListSample.h.

template<class TMeasurementVector>
typedef Superclass::InstanceIdentifier itk::Statistics::ListSample< TMeasurementVector >::InstanceIdentifier

Definition at line 72 of file itkListSample.h.

template<class TMeasurementVector>
typedef std::vector< MeasurementVectorType > itk::Statistics::ListSample< TMeasurementVector >::InternalDataContainerType

internal data container type

Definition at line 79 of file itkListSample.h.

template<class TMeasurementVector>
typedef Superclass::MeasurementType itk::Statistics::ListSample< TMeasurementVector >::MeasurementType

Definition at line 69 of file itkListSample.h.

template<class TMeasurementVector>
typedef Superclass::MeasurementVectorSizeType itk::Statistics::ListSample< TMeasurementVector >::MeasurementVectorSizeType

Definition at line 68 of file itkListSample.h.

template<class TMeasurementVector>
typedef Superclass::MeasurementVectorType itk::Statistics::ListSample< TMeasurementVector >::MeasurementVectorType

Typedefs inherited from the superclass

Definition at line 64 of file itkListSample.h.

template<class TMeasurementVector>
typedef SmartPointer< Self > itk::Statistics::ListSample< TMeasurementVector >::Pointer

Definition at line 57 of file itkListSample.h.

template<class TMeasurementVector>
typedef ListSample itk::Statistics::ListSample< TMeasurementVector >::Self

Standard class typedef.

Definition at line 55 of file itkListSample.h.

template<class TMeasurementVector>
typedef Sample< TMeasurementVector > itk::Statistics::ListSample< TMeasurementVector >::Superclass

Definition at line 56 of file itkListSample.h.

template<class TMeasurementVector>
typedef Superclass::TotalAbsoluteFrequencyType itk::Statistics::ListSample< TMeasurementVector >::TotalAbsoluteFrequencyType

Definition at line 71 of file itkListSample.h.

template<class TMeasurementVector>
typedef MeasurementVectorType itk::Statistics::ListSample< TMeasurementVector >::ValueType

Value type of a measurement (component of the measurement vector)

Definition at line 76 of file itkListSample.h.

Constructor & Destructor Documentation

template<class TMeasurementVector>
itk::Statistics::ListSample< TMeasurementVector >::ListSample ( )
protected
template<class TMeasurementVector>
virtual itk::Statistics::ListSample< TMeasurementVector >::~ListSample ( )
inlineprotectedvirtual

Definition at line 276 of file itkListSample.h.

template<class TMeasurementVector>
itk::Statistics::ListSample< TMeasurementVector >::ListSample ( const Self )
private

Member Function Documentation

template<class TMeasurementVector>
Iterator itk::Statistics::ListSample< TMeasurementVector >::Begin ( void  )
inline

returns an iterator that points to the beginning of the container

Definition at line 242 of file itkListSample.h.

Referenced by itk::Statistics::ListSample< TMeasurementVector >::ConstIterator::ConstIterator().

template<class TMeasurementVector>
ConstIterator itk::Statistics::ListSample< TMeasurementVector >::Begin ( void  ) const
inline

returns an iterator that points to the beginning of the container

Definition at line 258 of file itkListSample.h.

template<class TMeasurementVector>
void itk::Statistics::ListSample< TMeasurementVector >::Clear ( )

Removes all the elements in the Sample

template<class TMeasurementVector>
virtual::itk::LightObject::Pointer itk::Statistics::ListSample< TMeasurementVector >::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<class TMeasurementVector>
Iterator itk::Statistics::ListSample< TMeasurementVector >::End ( void  )
inline

returns an iterator that points to the end of the container

Definition at line 250 of file itkListSample.h.

template<class TMeasurementVector>
ConstIterator itk::Statistics::ListSample< TMeasurementVector >::End ( void  ) const
inline

returns an iterator that points to the end of the container

Definition at line 266 of file itkListSample.h.

template<class TMeasurementVector>
AbsoluteFrequencyType itk::Statistics::ListSample< TMeasurementVector >::GetFrequency ( InstanceIdentifier  id) const
virtual

Get the frequency of a measurement. Returns 1 if the measurement exist.

Implements itk::Statistics::Sample< TMeasurementVector >.

template<class TMeasurementVector>
const MeasurementVectorType& itk::Statistics::ListSample< TMeasurementVector >::GetMeasurementVector ( InstanceIdentifier  id) const
virtual

Get the measurement associated with the specified InstanceIdentifier

Implements itk::Statistics::Sample< TMeasurementVector >.

template<class TMeasurementVector>
virtual const char* itk::Statistics::ListSample< TMeasurementVector >::GetNameOfClass ( ) const
virtual
template<class TMeasurementVector>
TotalAbsoluteFrequencyType itk::Statistics::ListSample< TMeasurementVector >::GetTotalFrequency ( ) const
virtual

Get the total frequency of the sample. This is equivalent to the size of the sample.

Implements itk::Statistics::Sample< TMeasurementVector >.

template<class TMeasurementVector>
virtual void itk::Statistics::ListSample< TMeasurementVector >::Graft ( const DataObject thatObject)
virtual

Method to graft another sample

Reimplemented from itk::Statistics::Sample< TMeasurementVector >.

template<class TMeasurementVector>
static Pointer itk::Statistics::ListSample< TMeasurementVector >::New ( )
static

Method for creation through the object factory.

template<class TMeasurementVector>
void itk::Statistics::ListSample< TMeasurementVector >::operator= ( const Self )
private
template<class TMeasurementVector>
void itk::Statistics::ListSample< TMeasurementVector >::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::DataObject.

template<class TMeasurementVector>
void itk::Statistics::ListSample< TMeasurementVector >::PushBack ( const MeasurementVectorType mv)

Inserts a measurement at the end of the list

template<class TMeasurementVector>
void itk::Statistics::ListSample< TMeasurementVector >::Resize ( InstanceIdentifier  newsize)

Resize the container. Using Resize() and then SetMeasurementVector() is about nine times faster than usign PushBack() continuously. Which means that whenever the total number of Measurement vectors is known, the users should prefer calling Resize() first and then set the values by calling SetMeasurementVector(). On the other hand, if the number of measurement vectors is not known from the beginning, then calling PushBack() sequentially is a convenient option.

template<class TMeasurementVector>
void itk::Statistics::ListSample< TMeasurementVector >::SetMeasurement ( InstanceIdentifier  id,
unsigned int  dim,
const MeasurementType value 
)

Set a component a measurement to a particular value.

template<class TMeasurementVector>
void itk::Statistics::ListSample< TMeasurementVector >::SetMeasurementVector ( InstanceIdentifier  id,
const MeasurementVectorType mv 
)

Replace a measurement with a different measurement

template<class TMeasurementVector>
InstanceIdentifier itk::Statistics::ListSample< TMeasurementVector >::Size ( ) const
virtual

Get the number of measurement vectors in the sample

Implements itk::Statistics::Sample< TMeasurementVector >.

Member Data Documentation

template<class TMeasurementVector>
InternalDataContainerType itk::Statistics::ListSample< TMeasurementVector >::m_InternalContainer
private

Definition at line 283 of file itkListSample.h.


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