#include <itkImageModelEstimatorBase.h>

Detailed Description

template<typename TInputImage, typename TMembershipFunction>
class itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >

Base class for model estimation from images used for classification.

itkImageModelEstimatorBase is the base class for the ImageModelEstimator objects. It provides the basic function definitions that are inherent to ImageModelEstimator objects.

This is the Superclass for the ImageModelEstimator framework. This is an abstract class defining an interface for all such objects available through the ImageModelEstimator framework in the ITK toolkit.

The basic functionality of the ImageModelEstimator framework base class is to generate the models used in classification applications. It requires input images and a training image to be provided by the user. 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.

EstimateModels() is a pure virtual function making this an abstract class. The template parameter is the type of membership function the ImageModelEstimator populates.

A membership function 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.

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

Definition at line 64 of file itkImageModelEstimatorBase.h.

Inheritance diagram for itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >:

Collaboration diagram for itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	InputImagePointer = typename TInputImage::Pointer

using	InputImageType = TInputImage

using	MembershipFunctionPointer = typename TMembershipFunction::Pointer

using	MembershipFunctionPointerVector = std::vector< MembershipFunctionPointer >

using	Pointer = SmartPointer< Self >

using	Self = ImageModelEstimatorBase

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
unsigned int	AddMembershipFunction (MembershipFunctionPointer function)

void	DeleteAllMembershipFunctions ()

const MembershipFunctionPointerVector	GetMembershipFunctions () const

const char *	GetNameOfClass () const override

unsigned int	GetNumberOfMembershipFunctions ()

virtual const unsigned int &	GetNumberOfModels () const

void	SetMembershipFunctions (MembershipFunctionPointerVector membershipFunctions)

virtual void	SetNumberOfModels (unsigned int _arg)

void	Update ()


virtual void	SetInputImage (InputImageType *_arg)

virtual InputImageType *	GetModifiableInputImage ()

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

Protected Member Functions
void	GenerateData () override

	ImageModelEstimatorBase ()

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

	~ImageModelEstimatorBase () 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 Member Functions
virtual void	EstimateModels ()=0

Private Attributes
InputImagePointer	m_InputImage {}

MembershipFunctionPointerVector	m_MembershipFunctions {}

unsigned int	m_NumberOfModels { 0 }

Additional Inherited Members
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 Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}