itk::Statistics::ListSample< TMeasurementVector > Class Template Reference

#include <itkListSample.h>

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

[legend]Collaboration diagram for itk::Statistics::ListSample< TMeasurementVector >:

[legend]List of all members.

---

Detailed Description

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

This class is the native implementation of the ListSampleBase.

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

ListSampleBase 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:

ListSampleBase, Histogram

Definition at line 46 of file itkListSample.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::FrequencyType	FrequencyType
typedef Superclass::InstanceIdentifier	InstanceIdentifier
typedef std::vector< MeasurementVectorType >	InternalDataContainerType
typedef Superclass::MeasurementType	MeasurementType
typedef Superclass::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef Superclass::MeasurementVectorType	MeasurementVectorType
typedef SmartPointer< Self >	Pointer
typedef Superclass::SearchResultVectorType	SearchResultVectorType
typedef ListSample	Self
typedef ListSampleBase< TMeasurementVector >	Superclass
typedef Superclass::TotalFrequencyType	TotalFrequencyType
typedef MeasurementVectorType	ValueType
Public Member Functions
returns an iterator that points to the beginning of the container *ConstIterator	Begin () const
returns an iterator that points to the beginning of the container *Iterator	Begin ()
void	Clear ()
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
returns an iterator that points to the end of the container *ConstIterator	End () const
returns an iterator that points to the end of the container *Iterator	End ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
FrequencyType	GetFrequency (const InstanceIdentifier &id) const
const MeasurementVectorType &	GetMeasurementVector (const InstanceIdentifier &id) const
virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
TotalFrequencyType	GetTotalFrequency () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
void	PushBack (MeasurementVectorType mv)
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	Resize (unsigned int n)
void	Search (MeasurementVectorType center, double radius, SearchResultVectorType &result) const
void	SetDebug (bool debugFlag) const
void	SetMeasurement (const InstanceIdentifier &id, const unsigned int &dim, const MeasurementType &value)
void	SetMeasurementVector (const InstanceIdentifier &id, const MeasurementVectorType &mv)
Set Get macros for the length of the measurement vector *virtual void	SetMeasurementVectorSize (const MeasurementVectorSizeType s)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
unsigned int	Size () const
virtual void	UnRegister () const
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
Allow people to add remove invoke observers(callbacks) to any ITK *object.This is an implementation of the subject/observer design *pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Protected Member Functions
	ListSample ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~ListSample ()
Protected Attributes
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Methods invoked by virtual 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.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const
Classes
class	ConstIterator
class	Iterator

---

Member Typedef Documentation

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

Reimplemented from itk::Statistics::Sample< TMeasurementVector >. Definition at line 53 of file itkListSample.h.

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

Frequency value type Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 64 of file itkListSample.h.

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

InstanceIdentifier typedef. This identifier is a unique sequential id for each measurement vector in a Sample subclass. Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 66 of file itkListSample.h.

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

internal data container type Definition at line 75 of file itkListSample.h.

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

ValueType of a measurement (ValueType of a component of the MeasurementVector Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 63 of file itkListSample.h.

template<class TMeasurementVector> typedef Superclass::MeasurementVectorSizeType itk::Statistics::ListSampleBase< TMeasurementVector >::MeasurementVectorSizeType [inherited]

Typedef for the length of each measurement vector Reimplemented from itk::Statistics::Sample< TMeasurementVector >. Reimplemented in itk::Statistics::ImageToCooccurrenceListAdaptor< TImage >, itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >, itk::Statistics::JointDomainImageToListAdaptor, itk::Statistics::PointSetToListAdaptor< TPointSet >, itk::Statistics::ScalarImageToListAdaptor< TImage >, itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 2 > >, itk::Statistics::ImageToListAdaptor< TImage, ImageJointDomainTraits< TImage >::MeasurementVectorType >, and itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 1 > >. Definition at line 60 of file itkListSampleBase.h.

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

Typedefs inherited from the superclass Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 59 of file itkListSample.h.

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

Reimplemented from itk::Statistics::Sample< TMeasurementVector >. Definition at line 52 of file itkListSample.h.

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

Vector of InstanceIdentifiers used for returning search results. Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 67 of file itkListSample.h.

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

Standard class typedef. Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 50 of file itkListSample.h.

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

Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 51 of file itkListSample.h.

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

Total frequency type Reimplemented from itk::Statistics::Sample< TMeasurementVector >. Definition at line 65 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 71 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 (   )  [inline, protected, virtual]

Definition at line 287 of file itkListSample.h.

---

Member Function Documentation

template<class TMeasurementVector> returns an iterator that points to the beginning of the container* ConstIterator itk::Statistics::ListSample< TMeasurementVector >::Begin (  void   )  const [inline]

Definition at line 270 of file itkListSample.h.

template<class TMeasurementVector> returns an iterator that points to the beginning of the container* Iterator itk::Statistics::ListSample< TMeasurementVector >::Begin (  void   )  [inline]

Definition at line 254 of file itkListSample.h.

static void itk::LightObject::BreakOnError (   )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

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

Removes all the elements in the Sample Definition at line 86 of file itkListSample.h.

virtual LightObject::Pointer itk::Object::CreateAnother (   )  const [virtual, inherited]

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

virtual void itk::Object::DebugOff (   )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (   )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

template<class TMeasurementVector> returns an iterator that points to the end of the container* ConstIterator itk::Statistics::ListSample< TMeasurementVector >::End (  void   )  const [inline]

Definition at line 278 of file itkListSample.h.

template<class TMeasurementVector> returns an iterator that points to the end of the container* Iterator itk::Statistics::ListSample< TMeasurementVector >::End (  void   )  [inline]

Definition at line 262 of file itkListSample.h.

Command* itk::Object::GetCommand (  unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug (   )  const [inherited]

Get the value of the debug flag.

template<class TMeasurementVector> FrequencyType itk::Statistics::ListSample< TMeasurementVector >::GetFrequency (  const InstanceIdentifier &  id  )  const [virtual]

Get the frequency of a measurement. Returns 1 if the measurement exist. Implements itk::Statistics::Sample< TMeasurementVector >.

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]

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

Get the measurement associated with the specified InstanceIdentifier Implements itk::Statistics::Sample< TMeasurementVector >.

template<class TMeasurementVector> virtual MeasurementVectorSizeType itk::Statistics::Sample< TMeasurementVector >::GetMeasurementVectorSize (   )  const [virtual, inherited]

Reimplemented in itk::Statistics::Histogram, itk::Statistics::ImageToCooccurrenceListAdaptor< TImage >, itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >, itk::Statistics::JointDomainImageToListAdaptor, itk::Statistics::PointSetToListAdaptor< TPointSet >, itk::Statistics::ScalarImageToListAdaptor< TImage >, itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 2 > >, itk::Statistics::ImageToListAdaptor< TImage, ImageJointDomainTraits< TImage >::MeasurementVectorType >, and itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 1 > >.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  const [inherited]

Returns: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  [inherited]

Returns: A reference to this objects MetaDataDictionary. Warning: This reference may be changed.

virtual unsigned long itk::Object::GetMTime (   )  const [virtual, inherited]

Return this objects modified time. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

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

Standard macros Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >.

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

template<class TMeasurementVector> TotalFrequencyType itk::Statistics::ListSample< TMeasurementVector >::GetTotalFrequency (   )  const [inline, virtual]

Get the total frequency of the sample. This is equivalent to the size of the sample. Implements itk::Statistics::Sample< TMeasurementVector >. Definition at line 116 of file itkListSample.h.

static void itk::Object::GlobalWarningDisplayOff (   )  [inline, static, inherited]

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (   )  [inline, static, inherited]

Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver (  const EventObject &  event  )  const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent (  const EventObject &   )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent (  const EventObject &   )  [inherited]

Call Execute on all the Commands observing this event id.

virtual void itk::Object::Modified (   )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

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

Method for creation through the object factory. Reimplemented from itk::Object.

void itk::LightObject::Print (  std::ostream &  os, Indent  indent = 0 )  const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers (  std::ostream &  os, Indent  indent )  const [protected, inherited]

template<class TMeasurementVector> void itk::Statistics::ListSample< TMeasurementVector >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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::ListSampleBase< TMeasurementVector >.

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

template<class TMeasurementVector> void itk::Statistics::ListSample< TMeasurementVector >::PushBack (  MeasurementVectorType  mv  )  [inline]

Inserts a measurement at the end of the list Definition at line 90 of file itkListSample.h.

virtual void itk::Object::Register (   )  const [virtual, inherited]

Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (   )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver (  unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

template<class TMeasurementVector> void itk::Statistics::ListSample< TMeasurementVector >::Resize (  unsigned int  n  )  [inline]

Resize the container. If this sample is connected to a Subsample or MembershipSample, then this function won't change the size of this container, instead, it will throw exception. Therefore, resize the container before using the sample in a Subsample or MembershipSample. Definition at line 82 of file itkListSample.h.

template<class TMeasurementVector> void itk::Statistics::ListSampleBase< TMeasurementVector >::Search (  MeasurementVectorType  center, double  radius, SearchResultVectorType &  result )  const [inline, inherited]

Search for measurements within the specified radius of a search point. A vector of InstanceIdentifiers is returned. Definition at line 71 of file itkListSampleBase.h.

void itk::Object::SetDebug (  bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

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

Set a component a measurement to a particular value.

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

Replace a measurement with a different measurement

template<class TMeasurementVector> Set Get macros for the length of the measurement vector* virtual void itk::Statistics::Sample< TMeasurementVector >::SetMeasurementVectorSize (  const MeasurementVectorSizeType  s  )  [inline, virtual, inherited]

Reimplemented in itk::Statistics::Histogram, itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >, itk::Statistics::JointDomainImageToListAdaptor, itk::Statistics::PointSetToListAdaptor< TPointSet >, itk::Statistics::ScalarImageToListAdaptor< TImage >, itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 2 > >, itk::Statistics::ImageToListAdaptor< TImage, ImageJointDomainTraits< TImage >::MeasurementVectorType >, and itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 1 > >. Definition at line 113 of file itkSample.h.

void itk::Object::SetMetaDataDictionary (  const MetaDataDictionary &  rhs  )  [inherited]

Returns: Set the MetaDataDictionary

virtual void itk::Object::SetReferenceCount (  int   )  [virtual, inherited]

Sets the reference count (use with care) Reimplemented from itk::LightObject.

template<class TMeasurementVector> unsigned int itk::Statistics::ListSample< TMeasurementVector >::Size (  void   )  const [inline, virtual]

Get the number of measurement vectors in the sample Implements itk::Statistics::Sample< TMeasurementVector >. Definition at line 94 of file itkListSample.h.

virtual void itk::Object::UnRegister (   )  const [virtual, inherited]

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

---

Member Data Documentation

Allow people to add remove invoke observers (callbacks) to any ITK * object. This is an implementation of the subject/observer design * pattern. An observer is added by specifying an event to respond to * and an itk unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

---

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

• itkListSample.h

---