#include <itkImageClassifierBase.h>

Inheritance diagram for itk::ImageClassifierBase< TInputImage, TClassifiedImage >:

Collaboration diagram for itk::ImageClassifierBase< TInputImage, TClassifiedImage >:

Detailed Description

template<typename TInputImage, typename TClassifiedImage>
class itk::ImageClassifierBase< TInputImage, TClassifiedImage >

Base class for the ImageClassifierBase object.

itkImageClassifierBase is the base class for algorithms that take input data as images and preserve the image structure while performing classification. In other words, the data is not converted into a list, hence filters that require spatial information of a pixel can use the subclasses under this tree. It provides the basic function definitions that are inherent to an image classifier objects.

This is the SuperClass for the image classifier tree of the classifier framework. This is the class for all the classification objects available through the classifier framework in the ITK toolkit that hold the input image and the classified image data.

It is templated over the type of input image, classified image. The second template parameter allows templating over the classified image type. The name "image" indicates that the basic data structure used for storing data/results are derived from the ITK image class.

This object supports data handling of multiband images. The object accepts the input image in vector format only, where each pixel is a vector and each element of the vector corresponds to an entry from 1 particular band of a multiband dataset. A single band image is treated as a vector image with a single element for every vector. The classified image is treated as a single band scalar image.

This class stores the input and output data as its private members. Before you call the Classify method to start the classification process, you should plug in all necessary parts as described in the superclass documentation.

The core computation is carried out here. The function requires that the number of classes be set to a non zero value and the membership functions be populated. In addition, the number of classes should be equal to the number of membership functions.

Examples:: Examples/Segmentation/GibbsPriorImageFilter1.cxx, and Examples/Statistics/ScalarImageMarkovRandomField1.cxx.

Definition at line 71 of file itkImageClassifierBase.h.

Public Types
typedef ImageRegionIterator < TClassifiedImage >	ClassifiedImageIterator

typedef TClassifiedImage::PixelType	ClassifiedImagePixelType

typedef TClassifiedImage::Pointer	ClassifiedImagePointer

typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DecisionRuleType	DecisionRuleType

typedef ImageRegionConstIterator < TInputImage >	InputImageConstIterator

typedef TInputImage::ConstPointer	InputImageConstPointer

typedef TInputImage::PixelType	InputImagePixelType

typedef TInputImage::Pointer	InputImagePointer

typedef TInputImage	InputImageType

typedef Superclass::MeasurementVectorType	MeasurementVectorType

typedef Superclass::MembershipFunctionPointer	MembershipFunctionPointer

typedef Superclass::MembershipFunctionPointerVector	MembershipFunctionPointerVector

typedef Superclass::MembershipFunctionType	MembershipFunctionType

typedef SmartPointer< Self >	Pointer

typedef ImageClassifierBase	Self

typedef ClassifierBase < TInputImage >	Superclass

Public Types inherited from itk::ClassifierBase< TInputImage >
typedef Statistics::DecisionRule	DecisionRuleType

typedef TInputImage::ValueType	MeasurementVectorType

typedef MembershipFunctionType::Pointer	MembershipFunctionPointer

typedef std::vector < MembershipFunctionPointer >	MembershipFunctionPointerVector

typedef Statistics::MembershipFunctionBase < MeasurementVectorType >	MembershipFunctionType

typedef ClassifierBase	Self

typedef LightProcessObject	Superclass

Public Types inherited from itk::LightProcessObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightProcessObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual ClassifiedImagePointer	GetClassifiedImage () const

virtual const char *	GetNameOfClass () const

std::vector< double >	GetPixelMembershipValue (const InputImagePixelType inputImagePixel)

virtual void	SetClassifiedImage (ClassifiedImagePointer _arg)


virtual void	SetInputImage (const InputImageType *_arg)

virtual const InputImageType *	GetInputImage () const

Public Member Functions inherited from itk::ClassifierBase< TInputImage >
unsigned int	AddMembershipFunction (MembershipFunctionType *function)

DecisionRuleType *	GetDecisionRule (void)

const MembershipFunctionType *	GetMembershipFunction (unsigned int index) const

virtual const unsigned int &	GetNumberOfClasses () const

unsigned int	GetNumberOfMembershipFunctions ()

void	SetDecisionRule (DecisionRuleType *ptrToDecisionRule)

virtual void	SetNumberOfClasses (unsigned int _arg)

void	Update ()

Public Member Functions inherited from itk::LightProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual const bool &	GetAbortGenerateData () const

virtual void	SetAbortGenerateData (bool _arg)

virtual void	UpdateOutputData ()

void	UpdateProgress (float amount)

virtual void	SetProgress (float _arg)

virtual const float &	GetProgress () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

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

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::LightProcessObject
static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
void	Allocate ()

void	GenerateData () override

	ImageClassifierBase ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	~ImageClassifierBase ()

Protected Member Functions inherited from itk::ClassifierBase< TInputImage >
	ClassifierBase ()

	~ClassifierBase ()

Protected Member Functions inherited from itk::LightProcessObject
	LightProcessObject ()

	~LightProcessObject ()

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Types
typedef TInputImage::SizeType	InputImageSizeType

Private Member Functions
virtual void	Classify ()

	ImageClassifierBase (const Self &) ITK_DELETE_FUNCTION

void	operator= (const Self &) ITK_DELETE_FUNCTION

Private Attributes
ClassifiedImagePointer	m_ClassifiedImage

InputImageConstPointer	m_InputImage

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount