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

#include <itkSampleClassifier.h>

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

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

[legend]List of all members.

---

Detailed Description

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

Integration point for MembershipCalculator, DecisionRule, and target sample data.

The first template argument is the type of the target sample data that this classifier will assign a class label for each measurement vector. The second one is the type of a membership value calculator for each. A membership calculator represents a specific knowledge about a class. In other words, it should tell us how "likely" is that a measurement vector (pattern) belong to the class. The third argument is the type of decision rule. The main role of a decision rule is comparing the return values of the membership calculators. However, decision rule can include some prior knowledge that can improve the result.

Before you call the GenerateData method to start the classification process, you should plug in all necessary parts ( one or more membership calculators, a decision rule, and a target sample data). To plug in the decision rule, you use SetDecisionRule method, for the target sample data, SetSample method, and for the membership calculators, use AddMembershipCalculator method.

As the method name indicates, you can have more than one membership calculator. One for each classes. The order you put the membership calculator becomes the class label for the class that is represented by the membership calculator.

The classification result is stored in a vector of Subsample object. Each class has its own class sample (Subsample object) that has InstanceIdentifiers for all measurement vectors belong to the class. The InstanceIdentifiers come from the target sample data. Therefore, the Subsample objects act as separate class masks.

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 GetSample().GetMeasurementVectorSize() instead.

Definition at line 73 of file itkSampleClassifier.h.

Public Types
typedef unsigned int	ClassLabelType
typedef std::vector< ClassLabelType >	ClassLabelVectorType
typedef SmartPointer< const Self >	ConstPointer
typedef DecisionRuleBase	DecisionRuleType
typedef TSample::MeasurementType	MeasurementType
typedef TSample::MeasurementVectorType	MeasurementVectorType
typedef MembershipFunctionType::Pointer	MembershipFunctionPointer
typedef Superclass::MembershipFunctionPointerVector	MembershipFunctionPointerVector
typedef Statistics::MembershipFunctionBase< MeasurementVectorType >	MembershipFunctionType
typedef MembershipSample< TSample >	OutputType
typedef SmartPointer< Self >	Pointer
typedef SampleClassifier	Self
typedef ClassifierBase< TSample >	Superclass
Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
unsigned int	AddMembershipFunction (MembershipFunctionType *function)
Get the execution progress of a process object The progress is *a floating number	between (0, 1)
Set the execution progress of a process object The progress is *a floating number	between (0, 1)
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual const bool &	GetAbortGenerateData ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
DecisionRuleType *	GetDecisionRule (void)
const MembershipFunctionType *	GetMembershipFunction (unsigned int index) const
ClassLabelVectorType &	GetMembershipFunctionClassLabels ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
Standard macros *virtual const char *	GetNameOfClass () const
virtual const unsigned int &	GetNumberOfClasses ()
unsigned int	GetNumberOfMembershipFunctions ()
OutputType *	GetOutput ()
meaning *the filter has completed execution *virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
const TSample *	GetSample () 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)
virtual void	SetAbortGenerateData (bool _arg)
void	SetDebug (bool debugFlag) const
void	SetDecisionRule (DecisionRuleType *ptrToDecisionRule)
void	SetMembershipFunctionClassLabels (ClassLabelVectorType &labels)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetNumberOfClasses (unsigned int _arg)
meaning *the filter has completed execution *virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
void	SetSample (const TSample *sample)
virtual void	UnRegister () const
void	Update ()
virtual void	UpdateOutputData ()
void	UpdateProgress (float amount)
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
Get the execution progress of a process object The progress is *a floating number meaning no	progress
Set the execution progress of a process object The progress is *a floating number meaning no	progress
Protected Member Functions
	ClassifierBase ()
void	GenerateData ()
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
	SampleClassifier ()
virtual	~SampleClassifier ()
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

---

Member Typedef Documentation

template<class TSample> typedef unsigned int itk::Statistics::SampleClassifier< TSample >::ClassLabelType

Reimplemented in itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >. Definition at line 100 of file itkSampleClassifier.h.

template<class TSample> typedef std::vector< ClassLabelType > itk::Statistics::SampleClassifier< TSample >::ClassLabelVectorType

Reimplemented in itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >. Definition at line 101 of file itkSampleClassifier.h.

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

Reimplemented from itk::LightProcessObject. Reimplemented in itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >. Definition at line 81 of file itkSampleClassifier.h.

typedef DecisionRuleBase itk::ClassifierBase< TSample >::DecisionRuleType [inherited]

Type alias for decision rule Definition at line 114 of file itkClassifierBase.h.

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

typedefs from TSample object Reimplemented in itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >. Definition at line 92 of file itkSampleClassifier.h.

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

Sets the decision rule Reimplemented from itk::ClassifierBase< TSample >. Reimplemented in itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >. Definition at line 93 of file itkSampleClassifier.h.

typedef MembershipFunctionType::Pointer itk::ClassifierBase< TSample >::MembershipFunctionPointer [inherited]

Definition at line 108 of file itkClassifierBase.h.

template<class TSample> typedef Superclass::MembershipFunctionPointerVector itk::Statistics::SampleClassifier< TSample >::MembershipFunctionPointerVector

typedefs from Superclass Reimplemented from itk::ClassifierBase< TSample >. Reimplemented in itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >. Definition at line 98 of file itkSampleClassifier.h.

typedef Statistics::MembershipFunctionBase< MeasurementVectorType > itk::ClassifierBase< TSample >::MembershipFunctionType [inherited]

Typedefs for membership funciton Definition at line 107 of file itkClassifierBase.h.

template<class TSample> typedef MembershipSample< TSample > itk::Statistics::SampleClassifier< TSample >::OutputType

Output type for GetClassSample method Reimplemented in itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >. Definition at line 85 of file itkSampleClassifier.h.

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

Reimplemented from itk::LightProcessObject. Reimplemented in itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >. Definition at line 80 of file itkSampleClassifier.h.

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

Standard class typedef Reimplemented from itk::ClassifierBase< TSample >. Reimplemented in itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >. Definition at line 78 of file itkSampleClassifier.h.

template<class TSample> typedef ClassifierBase< TSample > itk::Statistics::SampleClassifier< TSample >::Superclass

Reimplemented from itk::ClassifierBase< TSample >. Reimplemented in itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >. Definition at line 79 of file itkSampleClassifier.h.

---

Constructor & Destructor Documentation

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

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

Definition at line 124 of file itkSampleClassifier.h.

---

Member Function Documentation

virtual void itk::LightProcessObject::AbortGenerateDataOff (   )  [virtual, inherited]

virtual void itk::LightProcessObject::AbortGenerateDataOn (   )  [virtual, inherited]

Turn on and off the AbortGenerateData flag.

unsigned int itk::ClassifierBase< TSample >::AddMembershipFunction (  MembershipFunctionType *  function  )  [inherited]

Stores a membership function of a class in its internal vector

Get the execution progress of a process object The progress is* a floating number itk::LightProcessObject::between (  0  , 1  )  [inherited]

Set the execution progress of a process object The progress is* a floating number itk::LightProcessObject::between (  0  , 1  )  [inherited]

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

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

itk::ClassifierBase< TSample >::ClassifierBase (   )  [protected, inherited]

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> void itk::Statistics::SampleClassifier< TSample >::GenerateData (   )  [protected, virtual]

Starts the classification process Implements itk::ClassifierBase< TSample >. Reimplemented in itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >.

virtual const bool& itk::LightProcessObject::GetAbortGenerateData (   )  [virtual, inherited]

Get the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

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.

DecisionRuleType* itk::ClassifierBase< TSample >::GetDecisionRule (  void   )  [inline, inherited]

Gets the pointer to the decision rule being used. Definition at line 125 of file itkClassifierBase.h.

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

const MembershipFunctionType* itk::ClassifierBase< TSample >::GetMembershipFunction (  unsigned int  index  )  const [inline, inherited]

Gets the MembershipFunction that are plugged in by the AddMembershipFunction method. The index is assigned according to the order each membership function has been added using the AddMemberShipFunction method Definition at line 134 of file itkClassifierBase.h.

template<class TSample> ClassLabelVectorType& itk::Statistics::SampleClassifier< TSample >::GetMembershipFunctionClassLabels (   )  [inline]

Gets the user given class labels Definition at line 116 of file itkSampleClassifier.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 TSample> Standard macros* virtual const char* itk::Statistics::SampleClassifier< TSample >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::ClassifierBase< TSample >. Reimplemented in itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >.

virtual const unsigned int& itk::ClassifierBase< TSample >::GetNumberOfClasses (   )  [virtual, inherited]

Gets the number of classes.

unsigned int itk::ClassifierBase< TSample >::GetNumberOfMembershipFunctions (   )  [inline, inherited]

Gets the number of membership functions Definition at line 140 of file itkClassifierBase.h.

template<class TSample> OutputType* itk::Statistics::SampleClassifier< TSample >::GetOutput (   )

Returns the classification result

meaning* the filter has completed execution* virtual const float& itk::LightProcessObject::GetProgress (   )  [virtual, inherited]

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::SampleClassifier< TSample >::GetSample (   )  const

Returns the target data

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::SampleClassifier< TSample >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::LightProcessObject. Reimplemented in itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >.

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::SampleClassifier< 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::ClassifierBase< TSample >. Reimplemented in itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >.

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.

virtual void itk::LightProcessObject::SetAbortGenerateData (  bool  _arg  )  [virtual, inherited]

Set the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

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

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

void itk::ClassifierBase< TSample >::SetDecisionRule (  DecisionRuleType *  ptrToDecisionRule  )  [inline, inherited]

Sets the pointer to the decision rule. Stores the decision rule that makes the real decision using informations from MembershipFunctions and other prior knowledge Definition at line 119 of file itkClassifierBase.h.

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 TSample> void itk::Statistics::SampleClassifier< TSample >::SetMembershipFunctionClassLabels (  ClassLabelVectorType &  labels  )

Sets the user given class labels for membership functions. If users do not provide class labels for membership functions by calling this function, then the index of the membership function vector for a membership function will be used as class label of measurement vectors belong to the membership function

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

Returns: Set the MetaDataDictionary

virtual void itk::ClassifierBase< TSample >::SetNumberOfClasses (  unsigned int  _arg  )  [virtual, inherited]

Sets the number of classes.

meaning* the filter has completed execution* virtual void itk::LightProcessObject::SetProgress (  float  _arg  )  [virtual, inherited]

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::SampleClassifier< TSample >::SetSample (  const TSample *  sample  )

Sets the target data that will be classified by this

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

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

void itk::ClassifierBase< TSample >::Update (  void   )  [inherited]

Starts the classification process

virtual void itk::LightProcessObject::UpdateOutputData (   )  [virtual, inherited]

Actually generate new output.

void itk::LightProcessObject::UpdateProgress (  float  amount  )  [inherited]

Update the progress of the process object. If a ProgressMethod exists, executes it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).

---

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]

Get the execution progress of a process object The progress is* a floating number meaning no itk::LightProcessObject::progress [inherited]

Definition at line 104 of file itkLightProcessObject.h.

Set the execution progress of a process object The progress is* a floating number meaning no itk::LightProcessObject::progress [inherited]

Definition at line 98 of file itkLightProcessObject.h.

---

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

• itkSampleClassifier.h

---