itk::Statistics::MembershipSample< TSample > Class Template Reference

#include <itkMembershipSample.h>

Inheritance diagram for itk::Statistics::MembershipSample< TSample >:

[legend]Collaboration diagram for itk::Statistics::MembershipSample< TSample >:

[legend]List of all members.

---

Detailed Description

template<class TSample>
class itk::Statistics::MembershipSample< TSample >

Container for storing the instance-identifiers of other sample with their associated class labels.

This class does not store any measurement data. In a sense, you can think it as an additional information to basic samples (such as Histogram, PointSetListSampleAdaptor, and ImageToListAdaptor). The additional information is a class label for a measurement vector. Obviously without such basic types of sample, this one is meaningless. You can call any basic methods that has been defined in the Sample class such as GetMeasurementVector and GetFrequency. You can query the class label for an instance using an instance-identifier. Another new and important method is the GetClassSample method. With a given class label, it returns a pointer to the Subsample object that has all the instance-identifiers of instances that belong to the class.

This class is templated over the type of the basic sample. To use all the method, you should first plug in a basic type sample using the SetSample method

Recent API changes: The static const macro to get the length of a measurement vector, 'MeasurementVectorSize' has been removed to allow the length of a measurement vector to be specified at run time. Please use the function GetMeasurementVectorSize() instead.

Definition at line 57 of file itkMembershipSample.h.

Public Types
typedef itk::hash_map< InstanceIdentifier, unsigned int >	ClassLabelHolderType
typedef ClassSampleType::ConstPointer	ClassSampleConstPointer
typedef ClassSampleType::Pointer	ClassSamplePointer
typedef Subsample< TSample >	ClassSampleType
typedef SmartPointer< const Self >	ConstPointer
typedef TSample::FrequencyType	FrequencyType
typedef TSample::InstanceIdentifier	InstanceIdentifier
typedef TSample::MeasurementType	MeasurementType
typedef unsigned int	MeasurementVectorSizeType
typedef TSample::MeasurementVectorType	MeasurementVectorType
typedef SmartPointer< Self >	Pointer
typedef MembershipSample	Self
typedef Sample< typename TSample::MeasurementVectorType >	Superclass
typedef TSample::TotalFrequencyType	TotalFrequencyType
typedef std::vector< unsigned int >	UniqueClassLabelsType
Public Member Functions
void	AddInstance (const unsigned int &classLabel, const InstanceIdentifier &id)
ConstIterator	Begin () const
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
ConstIterator	End () const
unsigned int	GetClassLabel (const InstanceIdentifier &id) const
ClassLabelHolderType *	GetClassLabels ()
const ClassSampleType *	GetClassSample (const unsigned int &classLabel) const
unsigned int	GetClassSampleSize (const unsigned int &classLabel) const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
FrequencyType	GetFrequency (const InstanceIdentifier &id) const
int	GetInternalClassLabel (const unsigned int classLabel) const
MeasurementType	GetMeasurement (const InstanceIdentifier &id, const unsigned int &dimension)
const MeasurementVectorType &	GetMeasurementVector (const InstanceIdentifier &id) const
virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
Standard macros *virtual const char *	GetNameOfClass () const
unsigned int	GetNumberOfClasses () const
virtual int	GetReferenceCount () const
const TSample *	GetSample () 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
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	Resize (unsigned int n)
void	SetDebug (bool debugFlag) const
Set Get macros for the length of the measurement vector *virtual void	SetMeasurementVectorSize (const MeasurementVectorSizeType s)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetNumberOfClasses (unsigned int numberOfClasses)
virtual void	SetReferenceCount (int)
void	SetSample (const TSample *sample)
unsigned int	Size (void) 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
	MembershipSample ()
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	~MembershipSample ()
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

---

Member Typedef Documentation

template<class TSample> typedef itk::hash_map< InstanceIdentifier, unsigned int> itk::Statistics::MembershipSample< TSample >::ClassLabelHolderType

Typedef for the storage that holds a class label for each instance. The relationship between instances and class label is one-to-one Definition at line 87 of file itkMembershipSample.h.

template<class TSample> typedef ClassSampleType::ConstPointer itk::Statistics::MembershipSample< TSample >::ClassSampleConstPointer

Definition at line 93 of file itkMembershipSample.h.

template<class TSample> typedef ClassSampleType::Pointer itk::Statistics::MembershipSample< TSample >::ClassSamplePointer

Definition at line 92 of file itkMembershipSample.h.

template<class TSample> typedef Subsample< TSample > itk::Statistics::MembershipSample< TSample >::ClassSampleType

Typedef for each subsample that stores instance identifers of instances that belong to a class Definition at line 91 of file itkMembershipSample.h.

template<class TSample> typedef SmartPointer< const Self > itk::Statistics::MembershipSample< TSample >::ConstPointer

Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >. Definition at line 65 of file itkMembershipSample.h.

template<class TSample> typedef TSample::FrequencyType itk::Statistics::MembershipSample< TSample >::FrequencyType

Frequency value type Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >. Definition at line 77 of file itkMembershipSample.h.

template<class TSample> typedef TSample::InstanceIdentifier itk::Statistics::MembershipSample< TSample >::InstanceIdentifier

InstanceIdentifier typedef. This identifier is a unique sequential id for each measurement vector in a Sample subclass. Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >. Definition at line 76 of file itkMembershipSample.h.

template<class TSample> typedef TSample::MeasurementType itk::Statistics::MembershipSample< TSample >::MeasurementType

ValueType of a measurement (ValueType of a component of the MeasurementVector Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >. Definition at line 75 of file itkMembershipSample.h.

typedef unsigned int itk::Statistics::Sample< TSample::MeasurementVectorType >::MeasurementVectorSizeType [inherited]

Typedef for the length of each measurement vector Definition at line 93 of file itkSample.h.

template<class TSample> typedef TSample::MeasurementVectorType itk::Statistics::MembershipSample< TSample >::MeasurementVectorType

Typedefs for Measurement vector, measurement, Instance Identifier, frequency, size, size element value from the template argument TSample Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >. Definition at line 69 of file itkMembershipSample.h.

template<class TSample> typedef SmartPointer< Self > itk::Statistics::MembershipSample< TSample >::Pointer

Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >. Definition at line 64 of file itkMembershipSample.h.

template<class TSample> typedef MembershipSample itk::Statistics::MembershipSample< TSample >::Self

Standard class typedefs. Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >. Definition at line 62 of file itkMembershipSample.h.

template<class TSample> typedef Sample< typename TSample::MeasurementVectorType > itk::Statistics::MembershipSample< TSample >::Superclass

Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >. Definition at line 63 of file itkMembershipSample.h.

template<class TSample> typedef TSample::TotalFrequencyType itk::Statistics::MembershipSample< TSample >::TotalFrequencyType

Total frequency type Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >. Definition at line 78 of file itkMembershipSample.h.

template<class TSample> typedef std::vector< unsigned int > itk::Statistics::MembershipSample< TSample >::UniqueClassLabelsType

vector of unique class labels that will be used for mapping internal continuous class label with real class labels Definition at line 83 of file itkMembershipSample.h.

---

Constructor & Destructor Documentation

template<class TSample> itk::Statistics::MembershipSample< TSample >::MembershipSample (   )  [protected]

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

Definition at line 252 of file itkMembershipSample.h.

---

Member Function Documentation

template<class TSample> void itk::Statistics::MembershipSample< TSample >::AddInstance (  const unsigned int &  classLabel, const InstanceIdentifier &  id )

Adds an instance from the source sample to this container. The first argument is the class label for that instance. The second argument is the instance identifier from the source identifier that is going to be included this container.

template<class TSample> ConstIterator itk::Statistics::MembershipSample< TSample >::Begin (  void   )  const [inline]

Definition at line 238 of file itkMembershipSample.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 TSample> ConstIterator itk::Statistics::MembershipSample< TSample >::End (  void   )  const [inline]

Definition at line 244 of file itkMembershipSample.h. References itk::fem::this.

template<class TSample> unsigned int itk::Statistics::MembershipSample< TSample >::GetClassLabel (  const InstanceIdentifier &  id  )  const

Gets the class label for the instance that has the instance identifier, id.

template<class TSample> ClassLabelHolderType* itk::Statistics::MembershipSample< TSample >::GetClassLabels (   )  [inline]

Gets the class labels that corresponding to the each instance in this container. Definition at line 131 of file itkMembershipSample.h.

template<class TSample> const ClassSampleType* itk::Statistics::MembershipSample< TSample >::GetClassSample (  const unsigned int &  classLabel  )  const

Gets the Subsample that includes only the instances that belongs to the classLabel

template<class TSample> unsigned int itk::Statistics::MembershipSample< TSample >::GetClassSampleSize (  const unsigned int &  classLabel  )  const

Gets the number of instances that belong to the class label in this container

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 TSample> FrequencyType itk::Statistics::MembershipSample< TSample >::GetFrequency (  const InstanceIdentifier &  id  )  const [virtual]

returns the frequency of the instance which is identified by the 'id' Implements itk::Statistics::Sample< TSample::MeasurementVectorType >.

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

template<class TSample> int itk::Statistics::MembershipSample< TSample >::GetInternalClassLabel (  const unsigned int  classLabel  )  const

Gets the internal continuous class label from the class labels that are used for AddInstance method.

template<class TSample> MeasurementType itk::Statistics::MembershipSample< TSample >::GetMeasurement (  const InstanceIdentifier &  id, const unsigned int &  dimension )

returns the measurement element which is the 'n'-th element in the 'd' dimension of the measurement vector

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

retunrs the measurement of the instance which is identified by the 'id' Implements itk::Statistics::Sample< TSample::MeasurementVectorType >.

virtual MeasurementVectorSizeType itk::Statistics::Sample< TSample::MeasurementVectorType >::GetMeasurementVectorSize (   )  const [virtual, inherited]

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 TSample> Standard macros* virtual const char* itk::Statistics::MembershipSample< TSample >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods) Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >.

template<class TSample> unsigned int itk::Statistics::MembershipSample< TSample >::GetNumberOfClasses (   )  const

Gets the number of classes (class labels)

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 TSample> const TSample* itk::Statistics::MembershipSample< TSample >::GetSample (   )  const

Returns the source sample pointer

template<class TSample> TotalFrequencyType itk::Statistics::MembershipSample< TSample >::GetTotalFrequency (   )  const [virtual]

returns the total frequency for the 'd' dimension Implements itk::Statistics::Sample< TSample::MeasurementVectorType >.

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 TSample> static Pointer itk::Statistics::MembershipSample< TSample >::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 TSample> void itk::Statistics::MembershipSample< TSample >::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::Sample< TSample::MeasurementVectorType >.

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.

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

Definition at line 152 of file itkMembershipSample.h.

itk::Statistics::Sample< TSample::MeasurementVectorType >::Sample (   )  [inline, protected, inherited]

Definition at line 130 of file itkSample.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().

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

Definition at line 113 of file itkSample.h.

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

Returns: Set the MetaDataDictionary

template<class TSample> void itk::Statistics::MembershipSample< TSample >::SetNumberOfClasses (  unsigned int  numberOfClasses  )

Sets the number of classes (class labels)

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

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

template<class TSample> void itk::Statistics::MembershipSample< TSample >::SetSample (  const TSample *  sample  )

Plug in the actual sample data

template<class TSample> unsigned int itk::Statistics::MembershipSample< TSample >::Size (  void   )  const [virtual]

returns the number of elements in each dimension Implements itk::Statistics::Sample< TSample::MeasurementVectorType >.

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:

• itkMembershipSample.h

---