itk::ClassifierBase< TDataContainer > Class Template Reference
[Pixel Classification Filters]

#include <itkClassifierBase.h>

Inheritance diagram for itk::ClassifierBase< TDataContainer >:

[legend]

Collaboration diagram for itk::ClassifierBase< TDataContainer >:

[legend]

List of all members.

Detailed Description

template<class TDataContainer>
class itk::ClassifierBase< TDataContainer >

Base class for classifier object.

ClassifierBase is the base class for the classifier objects. It provides the basic function definitions that are inherent to a classifier objects.

This is the SuperClass for the classifier framework. This is an abstract class defining an interface for all the classification objects available through the classifier framework in the ITK toolkit.

The basic functionality of the classifier framework base class is to classify each data point in given a data set to one of the N classes where N is either specified by the user or automatically determined using methods such as k-means clustering techniques.

The classifier framework supports two types of data where (1) The input is a series of data points that needs to be classified. These points may be in the form of images where the pixels can be viewed as a list and the spatial location of the pixels in not of a concern. This classification can be carried out via the use of SampleClassifier.

(2)The input is specifically an image and the pixels cannot be viewed as as a list of pixels since the spatial location of the pixel in needed for various algorithmic implementation such as Markov Random Field based approached. This type of data can be classified via the use of GeneralImageClassifierBase.

User will call The Update() function to run the classification proces

The user must generate the membership function before asking for data to be classified. One can automatically generate the membership function from the training data via the use of itkImageModelEstimator class. The membershio functions have to be populated by using the AddMembershipFunction If membership functions are not set prior to calling for classification, an exception in thrown.

As the method name indicates, you can have more than one membership function. 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 fourth 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. To plug in the decision rule, use SetDecisionRule method.

Before you call the Update method to start the classification process, you should plug in all necessary parts ( one or more membership functions, a decision rule, the unclassified data).

This class is templated over the container type.

Definition at line 86 of file itkClassifierBase.h.


Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef DecisionRuleBase	DecisionRuleType
typedef TDataContainer::ValueType	MeasurementVectorType
typedef MembershipFunctionType::Pointer	MembershipFunctionPointer
typedef std::vector < MembershipFunctionPointer >	MembershipFunctionPointerVector
typedef Statistics::MembershipFunctionBase < MeasurementVectorType >	MembershipFunctionType
typedef SmartPointer< Self >	Pointer
typedef ClassifierBase	Self
typedef LightProcessObject	Superclass
Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
unsigned int	AddMembershipFunction (MembershipFunctionType *function)
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
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual const unsigned int &	GetNumberOfClasses ()
unsigned int	GetNumberOfMembershipFunctions ()
virtual int	GetReferenceCount () 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	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetNumberOfClasses (unsigned int _arg)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
void	Update ()
virtual void	UpdateOutputData ()
void	UpdateProgress (float amount)

unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)

virtual const float &	GetProgress ()

virtual void	SetProgress (float _arg)
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Types

typedef int	InternalReferenceCountType
Protected Member Functions
	ClassifierBase ()
virtual void	GenerateData ()=0
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
	~ClassifierBase ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

Member Typedef Documentation

typedef SmartPointer<const Self> itk::LightProcessObject::ConstPointer [inherited]

Reimplemented from itk::Object.

Definition at line 78 of file itkLightProcessObject.h.

template<class TDataContainer>

typedef DecisionRuleBase itk::ClassifierBase< TDataContainer >::DecisionRuleType

Type alias for decision rule

Reimplemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >.

Definition at line 114 of file itkClassifierBase.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

template<class TDataContainer>

typedef TDataContainer::ValueType itk::ClassifierBase< TDataContainer >::MeasurementVectorType

Sets the decision rule

Reimplemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::Statistics::SampleClassifier< TSample >, and itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >.

Definition at line 100 of file itkClassifierBase.h.

template<class TDataContainer>

typedef MembershipFunctionType::Pointer itk::ClassifierBase< TDataContainer >::MembershipFunctionPointer

Reimplemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >.

Definition at line 108 of file itkClassifierBase.h.

template<class TDataContainer>

typedef std::vector< MembershipFunctionPointer > itk::ClassifierBase< TDataContainer >::MembershipFunctionPointerVector

Reimplemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::Statistics::SampleClassifier< TSample >, and itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >.

Definition at line 111 of file itkClassifierBase.h.

template<class TDataContainer>

typedef Statistics::MembershipFunctionBase< MeasurementVectorType > itk::ClassifierBase< TDataContainer >::MembershipFunctionType

Typedefs for membership funciton

Reimplemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >.

Definition at line 107 of file itkClassifierBase.h.

typedef SmartPointer<Self> itk::LightProcessObject::Pointer [inherited]

Reimplemented from itk::Object.

Definition at line 77 of file itkLightProcessObject.h.

template<class TDataContainer>

typedef ClassifierBase itk::ClassifierBase< TDataContainer >::Self

Standard class typedefs.

Reimplemented from itk::LightProcessObject.

Reimplemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::Statistics::SampleClassifier< TSample >, and itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >.

Definition at line 90 of file itkClassifierBase.h.

template<class TDataContainer>

typedef LightProcessObject itk::ClassifierBase< TDataContainer >::Superclass

Reimplemented from itk::LightProcessObject.

Reimplemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::Statistics::SampleClassifier< TSample >, and itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >.

Definition at line 91 of file itkClassifierBase.h.

Constructor & Destructor Documentation

template<class TDataContainer>

itk::ClassifierBase< TDataContainer >::ClassifierBase ( ) [protected]

template<class TDataContainer>

itk::ClassifierBase< TDataContainer >::~ClassifierBase ( ) [protected]

Member Function Documentation

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

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

Turn on and off the AbortGenerateData flag.

template<class TDataContainer>

unsigned int itk::ClassifierBase< TDataContainer >::AddMembershipFunction ( MembershipFunctionType * function )

Stores a membership function of a class in its internal vector

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[inherited]`

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

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::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

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 TDataContainer>

virtual void itk::ClassifierBase< TDataContainer >::GenerateData ( ) [protected, pure virtual]

The real classification logic implementaion. All the subclasses of this class should implement this method.

Reimplemented from itk::LightProcessObject.

Implemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::Statistics::SampleClassifier< TSample >, and 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.

template<class TDataContainer>

DecisionRuleType* itk::ClassifierBase< TDataContainer >::GetDecisionRule ( void ) [inline]

Gets the pointer to the decision rule being used.

Definition at line 125 of file itkClassifierBase.h.

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

template<class TDataContainer>

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

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.

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.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

template<class TDataContainer>

virtual const char* itk::ClassifierBase< TDataContainer >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::LightProcessObject.

Reimplemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::Statistics::SampleClassifier< TSample >, and itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >.

template<class TDataContainer>

virtual const unsigned int& itk::ClassifierBase< TDataContainer >::GetNumberOfClasses ( ) [virtual]

Gets the number of classes.

template<class TDataContainer>

unsigned int itk::ClassifierBase< TDataContainer >::GetNumberOfMembershipFunctions ( ) [inline]

Gets the number of membership functions

Definition at line 140 of file itkClassifierBase.h.

virtual const float& itk::LightProcessObject::GetProgress ( ) [virtual, inherited]

Get the execution progress of a process object. The progress is a floating number between (0,1), 0 meaning no progress; 1 meaning the filter has completed execution.

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

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.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::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

static Pointer itk::LightProcessObject::New ( ) [static, inherited]

Method for creation through the object factory.

Reimplemented from itk::Object.

Reimplemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >, itk::AnalyzeImageIO, itk::BioRadImageIO, itk::BMPImageIO, itk::Brains2MaskImageIO, itk::DicomImageIO, itk::DICOMImageIO2, itk::GDCMImageIO, itk::GE4ImageIO, itk::GE5ImageIO, itk::GEAdwImageIO, itk::GiplImageIO, itk::IPLCommonImageIO, itk::JPEGImageIO, itk::LSMImageIO, itk::MetaArrayReader, itk::MetaArrayWriter, itk::MetaImageIO, itk::NiftiImageIO, itk::NrrdImageIO, itk::PNGImageIO, itk::PolygonGroupSpatialObjectXMLFileReader, itk::PolygonGroupSpatialObjectXMLFileWriter, itk::RawImageIO< TPixel, VImageDimension >, itk::SiemensVisionImageIO, itk::StimulateImageIO, itk::TIFFImageIO, itk::TransformFileReader, itk::TransformFileWriter, itk::VTKImageIO, itk::Statistics::BackPropagationLayer< TMeasurementVector, TTargetVector >, itk::Statistics::BatchSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::Statistics::CompletelyConnectedWeightSet< TMeasurementVector, TTargetVector >, itk::Statistics::ErrorBackPropagationLearningFunctionBase< LayerType, TTargetVector >, itk::Statistics::ErrorBackPropagationLearningWithMomentum< LayerType, TTargetVector >, itk::Statistics::IterativeSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >, itk::Statistics::RBFBackPropagationLearningFunction< LayerType, TTargetVector >, itk::Statistics::RBFLayer< TMeasurementVector, TTargetVector >, itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >, itk::Statistics::SampleClassifier< TSample >, itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >, itk::Bruker2DSEQImageIO, itk::MatlabTransformIO, itk::MINC2ImageIO, itk::PhilipsPAR, itk::PhilipsRECImageIO, itk::TransformFileReader, itk::TransformFileWriter, itk::TxtTransformIO, and itk::VoxBoCUBImageIO.

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

Cause the object to print itself out.

Referenced by itk::WeakPointer< itk::ProcessObject >::Print(), and itk::SmartPointer< itk::MutualInformationImageToImageMetric >::Print().

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

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

template<class TDataContainer>

void itk::ClassifierBase< TDataContainer >::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::LightProcessObject.

Reimplemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::Statistics::SampleClassifier< TSample >, and 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.

template<class TDataContainer>

void itk::ClassifierBase< TDataContainer >::SetDecisionRule ( DecisionRuleType * ptrToDecisionRule ) [inline]

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.

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

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

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

Returns:: Set the MetaDataDictionary

template<class TDataContainer>

virtual void itk::ClassifierBase< TDataContainer >::SetNumberOfClasses ( unsigned int _arg ) [virtual]

Sets the number of classes.

virtual void itk::LightProcessObject::SetProgress ( float _arg ) [virtual, inherited]

Set the execution progress of a process object. The progress is a floating number between (0,1), 0 meaning no progress; 1 meaning the filter has completed execution.

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

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

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

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

Referenced by itk::SmartPointer< itk::MutualInformationImageToImageMetric >::operator=().

template<class TDataContainer>

void itk::ClassifierBase< TDataContainer >::Update ( )

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

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

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

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

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

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

itkClassifierBase.h

itk::ClassifierBase< TDataContainer > Class Template Reference [Pixel Classification Filters]

Detailed Description

template<class TDataContainer> class itk::ClassifierBase< TDataContainer >

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

itk::ClassifierBase< TDataContainer > Class Template Reference
[Pixel Classification Filters]

template<class TDataContainer>
class itk::ClassifierBase< TDataContainer >