#include <itkImageClassifierBase.h>

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.

Definition at line 71 of file itkImageClassifierBase.h.

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

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

Public Types
using	ClassifiedImageIterator = ImageRegionIterator< TClassifiedImage >

using	ClassifiedImagePixelType = typename TClassifiedImage::PixelType

using	ClassifiedImagePointer = typename TClassifiedImage::Pointer

using	ConstPointer = SmartPointer< const Self >

using	InputImageConstIterator = ImageRegionConstIterator< TInputImage >

using	InputImageConstPointer = typename TInputImage::ConstPointer

using	InputImagePixelType = typename TInputImage::PixelType

using	InputImagePointer = typename TInputImage::Pointer

using	InputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageClassifierBase

using	Superclass = ClassifierBase< TInputImage >

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

using	MeasurementVectorType = typename TDataContainer::ValueType

using	MembershipFunctionPointer = typename MembershipFunctionType::Pointer

using	MembershipFunctionPointerVector = std::vector< MembershipFunctionPointer >

using	MembershipFunctionType = Statistics::MembershipFunctionBase< MeasurementVectorType >

using	Self = ClassifierBase

using	Superclass = LightProcessObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightProcessObject

using	Superclass = Object

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

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
virtual ClassifiedImagePointer	GetClassifiedImage () const

const char *	GetNameOfClass () const override

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 ()

const MembershipFunctionType *	GetMembershipFunction (unsigned int index) const

const char *	GetNameOfClass () const override

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	AbortGenerateDataOn ()

virtual const bool &	GetAbortGenerateData () const

const char *	GetNameOfClass () const override

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 *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

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

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

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

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

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 val)

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

static Pointer	New ()

Protected Member Functions
void	Allocate ()

void	GenerateData () override

	ImageClassifierBase ()=default

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

	~ImageClassifierBase () override=default

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

void	GenerateData () override=0

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

	~ClassifierBase () override=default

Protected Member Functions inherited from itk::LightProcessObject
virtual void	GenerateData ()

	LightProcessObject ()

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

	~LightProcessObject () override

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

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

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

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

	LightObject ()

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

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

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

virtual	~LightObject ()

Private Types
using	InputImageSizeType = typename TInputImage::SizeType

Private Member Functions
virtual void	Classify ()

Private Attributes
ClassifiedImagePointer	m_ClassifiedImage {}

InputImageConstPointer	m_InputImage {}

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}