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

#include <itkListSample.h>

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

List of all members.

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 >
- Public Types inherited from itk::DataObject
typedef std::string DataObjectIdentifierType
typedef std::vector< Pointer >
::size_type 
DataObjectPointerArraySizeType
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

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 unsigned long 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 (unsigned long time)
virtual const unsigned long & GetPipelineMTime ()
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 unsigned long 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 >
 Sample ()
virtual ~Sample ()
- Protected Member Functions inherited from itk::DataObject
virtual void PropagateResetPipeline ()
 DataObject ()
 ~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

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.


Member Typedef Documentation

template<class TMeasurementVector>
typedef Superclass::AbsoluteFrequencyType itk::Statistics::ListSample< TMeasurementVector >::AbsoluteFrequencyType
template<class TMeasurementVector>
typedef SmartPointer< const Self > itk::Statistics::ListSample< TMeasurementVector >::ConstPointer
template<class TMeasurementVector>
typedef Superclass::InstanceIdentifier itk::Statistics::ListSample< TMeasurementVector >::InstanceIdentifier
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
template<class TMeasurementVector>
typedef Superclass::MeasurementVectorSizeType itk::Statistics::ListSample< TMeasurementVector >::MeasurementVectorSizeType
template<class TMeasurementVector>
typedef Superclass::MeasurementVectorType itk::Statistics::ListSample< TMeasurementVector >::MeasurementVectorType
template<class TMeasurementVector>
typedef SmartPointer< Self > itk::Statistics::ListSample< TMeasurementVector >::Pointer
template<class TMeasurementVector>
typedef ListSample itk::Statistics::ListSample< TMeasurementVector >::Self
template<class TMeasurementVector>
typedef Sample< TMeasurementVector > itk::Statistics::ListSample< TMeasurementVector >::Superclass
template<class TMeasurementVector>
typedef Superclass::TotalAbsoluteFrequencyType itk::Statistics::ListSample< TMeasurementVector >::TotalAbsoluteFrequencyType
template<class TMeasurementVector>
typedef MeasurementVectorType itk::Statistics::ListSample< TMeasurementVector >::ValueType

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 273 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
template<class TMeasurementVector>
ConstIterator itk::Statistics::ListSample< TMeasurementVector >::Begin ( void  ) const
inline
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.

Reimplemented in itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::ImageToNeighborhoodSampleAdaptor< TImage, TBoundaryCondition >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

template<class TMeasurementVector>
Iterator itk::Statistics::ListSample< TMeasurementVector >::End ( void  )
inline
template<class TMeasurementVector>
ConstIterator itk::Statistics::ListSample< TMeasurementVector >::End ( void  ) const
inline
template<class TMeasurementVector>
AbsoluteFrequencyType itk::Statistics::ListSample< TMeasurementVector >::GetFrequency ( InstanceIdentifier  id) const
virtual
template<class TMeasurementVector>
const MeasurementVectorType& itk::Statistics::ListSample< TMeasurementVector >::GetMeasurementVector ( InstanceIdentifier  id) const
virtual
template<class TMeasurementVector>
virtual const char* itk::Statistics::ListSample< TMeasurementVector >::GetNameOfClass ( ) const
virtual
template<class TMeasurementVector>
TotalAbsoluteFrequencyType itk::Statistics::ListSample< TMeasurementVector >::GetTotalFrequency ( ) const
virtual
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
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

Method for grafting the content of one data object into another one. This method is intended to be overloaded by derived classes. Each one of them should use dynamic_casting in order to verify that the grafted object is actually of the same type as the class on which the Graft() method was invoked.

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

Reimplemented in itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::ImageToNeighborhoodSampleAdaptor< TImage, TBoundaryCondition >, itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

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

Member Data Documentation

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

Definition at line 280 of file itkListSample.h.


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