itk::Statistics::PointSetToListAdaptor< TPointSet > Class Template Reference

#include <itkPointSetToListAdaptor.h>

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

[legend]Collaboration diagram for itk::Statistics::PointSetToListAdaptor< TPointSet >:

[legend]List of all members.

---

Detailed Description

template<class TPointSet>
class itk::Statistics::PointSetToListAdaptor< TPointSet >

This class provides ListSampleBase interfaces 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 measurment vectors. In other words, PointSet's points are equal to measurement vectors. This class totally ignores PointsDataContainer.

See also:

Sample, ListSampleBase, DefaultStaticMeshTraits, PointSet

Definition at line 43 of file itkPointSetToListAdaptor.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::FrequencyType	FrequencyType
typedef TPointSet::PointIdentifier	InstanceIdentifier
typedef Superclass::MeasurementType	MeasurementType
typedef Superclass::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef Superclass::MeasurementVectorType	MeasurementVectorType
typedef SmartPointer< Self >	Pointer
typedef TPointSet::PointsContainerIterator	PointsContainerIterator
typedef TPointSet::PointsContainerPointer	PointsContainerPointer
typedef TPointSet::Pointer	PointSetPointer
typedef TPointSet	PointSetType
typedef TPointSet::PointType	PointType
typedef std::vector< InstanceIdentifier >	SearchResultVectorType
typedef PointSetToListAdaptor	Self
typedef ListSampleBase< typename TPointSet::PointType >	Superclass
typedef Superclass::TotalFrequencyType	TotalFrequencyType
typedef MeasurementVectorType	ValueType
Public Member Functions
returns a const 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 ()
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
MeasurementVectorSizeType	GetMeasurementVectorSize () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
TPointSet *	GetPointSet ()
virtual int	GetReferenceCount () const
TotalFrequencyType	GetTotalFrequency () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
	itkStaticConstMacro (MeasurementVectorSize, unsigned int, TPointSet::PointDimension)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
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	SetMeasurementVectorSize (const MeasurementVectorSizeType s)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetPointSet (TPointSet *pointSet)
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
	ListSampleBase ()
	PointSetToListAdaptor ()
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
	Sample ()
virtual	~PointSetToListAdaptor ()
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 TPointSet> typedef SmartPointer<const Self> itk::Statistics::PointSetToListAdaptor< TPointSet >::ConstPointer

Reimplemented from itk::Statistics::Sample< TPointSet::PointType >. Definition at line 51 of file itkPointSetToListAdaptor.h.

template<class TPointSet> typedef Superclass::FrequencyType itk::Statistics::PointSetToListAdaptor< TPointSet >::FrequencyType

Frequency value type Reimplemented from itk::Statistics::ListSampleBase< TPointSet::PointType >. Definition at line 77 of file itkPointSetToListAdaptor.h.

template<class TPointSet> typedef TPointSet::PointIdentifier itk::Statistics::PointSetToListAdaptor< TPointSet >::InstanceIdentifier

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

template<class TPointSet> typedef Superclass::MeasurementType itk::Statistics::PointSetToListAdaptor< TPointSet >::MeasurementType

Superclass typedefs for Measurement vector, measurement, Instance Identifier, frequency, size, size element value Reimplemented from itk::Statistics::ListSampleBase< TPointSet::PointType >. Definition at line 74 of file itkPointSetToListAdaptor.h.

template<class TPointSet> typedef Superclass::MeasurementVectorSizeType itk::Statistics::PointSetToListAdaptor< TPointSet >::MeasurementVectorSizeType

Typedef for the length of each measurement vector Reimplemented from itk::Statistics::ListSampleBase< TPointSet::PointType >. Definition at line 79 of file itkPointSetToListAdaptor.h.

template<class TPointSet> typedef Superclass::MeasurementVectorType itk::Statistics::PointSetToListAdaptor< TPointSet >::MeasurementVectorType

Typedefs inherited from the superclass Reimplemented from itk::Statistics::ListSampleBase< TPointSet::PointType >. Definition at line 75 of file itkPointSetToListAdaptor.h.

template<class TPointSet> typedef SmartPointer< Self > itk::Statistics::PointSetToListAdaptor< TPointSet >::Pointer

Reimplemented from itk::Statistics::Sample< TPointSet::PointType >. Definition at line 50 of file itkPointSetToListAdaptor.h.

template<class TPointSet> typedef TPointSet::PointsContainerIterator itk::Statistics::PointSetToListAdaptor< TPointSet >::PointsContainerIterator

Definition at line 68 of file itkPointSetToListAdaptor.h.

template<class TPointSet> typedef TPointSet::PointsContainerPointer itk::Statistics::PointSetToListAdaptor< TPointSet >::PointsContainerPointer

Definition at line 67 of file itkPointSetToListAdaptor.h.

template<class TPointSet> typedef TPointSet::Pointer itk::Statistics::PointSetToListAdaptor< TPointSet >::PointSetPointer

Definition at line 65 of file itkPointSetToListAdaptor.h.

template<class TPointSet> typedef TPointSet itk::Statistics::PointSetToListAdaptor< TPointSet >::PointSetType

PointSet typedefs Definition at line 64 of file itkPointSetToListAdaptor.h.

template<class TPointSet> typedef TPointSet::PointType itk::Statistics::PointSetToListAdaptor< TPointSet >::PointType

Definition at line 69 of file itkPointSetToListAdaptor.h.

typedef std::vector< InstanceIdentifier > itk::Statistics::ListSampleBase< TPointSet::PointType >::SearchResultVectorType [inherited]

Vector of InstanceIdentifiers used for returning search results. Definition at line 67 of file itkListSampleBase.h.

template<class TPointSet> typedef PointSetToListAdaptor itk::Statistics::PointSetToListAdaptor< TPointSet >::Self

Standard class typedefs Reimplemented from itk::Statistics::ListSampleBase< TPointSet::PointType >. Definition at line 48 of file itkPointSetToListAdaptor.h.

template<class TPointSet> typedef ListSampleBase< typename TPointSet::PointType > itk::Statistics::PointSetToListAdaptor< TPointSet >::Superclass

Reimplemented from itk::Statistics::ListSampleBase< TPointSet::PointType >. Definition at line 49 of file itkPointSetToListAdaptor.h.

template<class TPointSet> typedef Superclass::TotalFrequencyType itk::Statistics::PointSetToListAdaptor< TPointSet >::TotalFrequencyType

Total frequency type Reimplemented from itk::Statistics::Sample< TPointSet::PointType >. Definition at line 78 of file itkPointSetToListAdaptor.h.

template<class TPointSet> typedef MeasurementVectorType itk::Statistics::PointSetToListAdaptor< TPointSet >::ValueType

Definition at line 76 of file itkPointSetToListAdaptor.h.

---

Constructor & Destructor Documentation

template<class TPointSet> itk::Statistics::PointSetToListAdaptor< TPointSet >::PointSetToListAdaptor (   )  [protected]

template<class TPointSet> virtual itk::Statistics::PointSetToListAdaptor< TPointSet >::~PointSetToListAdaptor (   )  [inline, protected, virtual]

Definition at line 248 of file itkPointSetToListAdaptor.h.

---

Member Function Documentation

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

Definition at line 230 of file itkPointSetToListAdaptor.h.

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

Definition at line 214 of file itkPointSetToListAdaptor.h.

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

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

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 TPointSet> returns an iterator that points to the end of the container* ConstIterator itk::Statistics::PointSetToListAdaptor< TPointSet >::End (  void   )  const [inline]

Definition at line 238 of file itkPointSetToListAdaptor.h.

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

Definition at line 222 of file itkPointSetToListAdaptor.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 TPointSet> FrequencyType itk::Statistics::PointSetToListAdaptor< TPointSet >::GetFrequency (  const InstanceIdentifier &  id  )  const [virtual]

returns 1 as other subclasses of ListSampleBase does Implements itk::Statistics::Sample< TPointSet::PointType >.

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

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

returns the measurement vector that is specified by the instance identifier argument. Implements itk::Statistics::Sample< TPointSet::PointType >.

template<class TPointSet> MeasurementVectorSizeType itk::Statistics::PointSetToListAdaptor< TPointSet >::GetMeasurementVectorSize (   )  const [inline, virtual]

Reimplemented from itk::Statistics::Sample< TPointSet::PointType >. Definition at line 117 of file itkPointSetToListAdaptor.h.

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 TPointSet> virtual const char* itk::Statistics::PointSetToListAdaptor< TPointSet >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Statistics::ListSampleBase< TPointSet::PointType >.

template<class TPointSet> TPointSet* itk::Statistics::PointSetToListAdaptor< TPointSet >::GetPointSet (   )

Method to get the point set

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 TPointSet> TotalFrequencyType itk::Statistics::PointSetToListAdaptor< TPointSet >::GetTotalFrequency (   )  const [virtual]

returns the size of this container Implements itk::Statistics::Sample< TPointSet::PointType >.

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.

template<class TPointSet> itk::Statistics::PointSetToListAdaptor< TPointSet >::itkStaticConstMacro (  MeasurementVectorSize  , unsigned  int, TPointSet::PointDimension  )

the number of components in a measurement vector

itk::Statistics::ListSampleBase< TPointSet::PointType >::ListSampleBase (   )  [inline, protected, inherited]

Definition at line 116 of file itkListSampleBase.h.

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 TPointSet> static Pointer itk::Statistics::PointSetToListAdaptor< TPointSet >::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 TPointSet> void itk::Statistics::PointSetToListAdaptor< TPointSet >::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< TPointSet::PointType >.

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

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.

itk::Statistics::Sample< TPointSet::PointType >::Sample (   )  [inline, protected, inherited]

Definition at line 130 of file itkSample.h.

void itk::Statistics::ListSampleBase< TPointSet::PointType >::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 TPointSet> void itk::Statistics::PointSetToListAdaptor< TPointSet >::SetMeasurement (  const InstanceIdentifier &  id, const unsigned int &  dim, const MeasurementType &  value )

sets the "dim" dimensional component value of the measurement vector that is specified by "id".

template<class TPointSet> void itk::Statistics::PointSetToListAdaptor< TPointSet >::SetMeasurementVectorSize (  const MeasurementVectorSizeType  s  )  [inline, virtual]

Reimplemented from itk::Statistics::Sample< TPointSet::PointType >. Definition at line 106 of file itkPointSetToListAdaptor.h. References itkExceptionMacro.

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

Returns: Set the MetaDataDictionary

template<class TPointSet> void itk::Statistics::PointSetToListAdaptor< TPointSet >::SetPointSet (  TPointSet *  pointSet  )

Method to set the point set

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

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

template<class TPointSet> unsigned int itk::Statistics::PointSetToListAdaptor< TPointSet >::Size (   )  const [virtual]

returns the number of measurement vectors in this container Implements itk::Statistics::Sample< TPointSet::PointType >.

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:

• itkPointSetToListAdaptor.h

---