#include <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
virtual const char *	GetNameOfClass () const

virtual const unsigned int &	GetNumberOfModels () const

virtual void	SetNumberOfModels (unsigned int _arg)

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

virtual void	AbortGenerateDataOn ()

virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const bool &	GetAbortGenerateData () const

virtual void	SetAbortGenerateData (bool _arg)

virtual void	SetProgress (float _arg)

virtual const float &	GetProgress () const

void	UpdateProgress (float amount)

virtual void	UpdateOutputData ()

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

unsigned long	AddObserver (const EventObject &event, Command *) 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

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)

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

virtual int	GetReferenceCount () const

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

unsigned int	m_NumberOfModels { 0 }

MembershipFunctionPointerVector	m_MembershipFunctions

InputImagePointer	m_InputImage

virtual void	SetInputImage (InputImageType *_arg)

virtual InputImageType *	GetModifiableInputImage ()

virtual const InputImageType *	GetInputImage () const

void	SetMembershipFunctions (MembershipFunctionPointerVector membershipFunctions)

const MembershipFunctionPointerVector	GetMembershipFunctions () const

unsigned int	GetNumberOfMembershipFunctions ()

void	DeleteAllMembershipFunctions ()

unsigned int	AddMembershipFunction (MembershipFunctionPointer function)

void	Update ()

	ImageModelEstimatorBase ()

	~ImageModelEstimatorBase () override=default

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

void	GenerateData () override

virtual void	EstimateModels ()=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 Member Functions inherited from itk::LightProcessObject
	LightProcessObject ()

	~LightProcessObject () override

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

	~Object () override

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

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

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

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.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TMembershipFunction >

using itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::ConstPointer = SmartPointer<const Self>

Definition at line 73 of file itkImageModelEstimatorBase.h.

◆ InputImagePointer

template<typename TInputImage , typename TMembershipFunction >

using itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::InputImagePointer = typename TInputImage::Pointer

Definition at line 91 of file itkImageModelEstimatorBase.h.

◆ InputImageType

template<typename TInputImage , typename TMembershipFunction >

using itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::InputImageType = TInputImage

Type definitions for the training image.

Definition at line 90 of file itkImageModelEstimatorBase.h.

◆ MembershipFunctionPointer

template<typename TInputImage , typename TMembershipFunction >

using itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::MembershipFunctionPointer = typename TMembershipFunction::Pointer

Type definitions for the membership function .

Definition at line 85 of file itkImageModelEstimatorBase.h.

◆ MembershipFunctionPointerVector

template<typename TInputImage , typename TMembershipFunction >

using itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::MembershipFunctionPointerVector = std::vector<MembershipFunctionPointer>

Definition at line 87 of file itkImageModelEstimatorBase.h.

◆ Pointer

template<typename TInputImage , typename TMembershipFunction >

using itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::Pointer = SmartPointer<Self>

Definition at line 72 of file itkImageModelEstimatorBase.h.

◆ Self

template<typename TInputImage , typename TMembershipFunction >

using itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::Self = ImageModelEstimatorBase

Standard class type aliases.

Definition at line 70 of file itkImageModelEstimatorBase.h.

◆ Superclass

template<typename TInputImage , typename TMembershipFunction >

using itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::Superclass = LightProcessObject

Definition at line 71 of file itkImageModelEstimatorBase.h.

Constructor & Destructor Documentation

◆ ImageModelEstimatorBase()

template<typename TInputImage , typename TMembershipFunction >

itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::ImageModelEstimatorBase ( )

protected

Container to hold the membership functions

◆ ~ImageModelEstimatorBase()

template<typename TInputImage , typename TMembershipFunction >

itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::~ImageModelEstimatorBase ( )

overrideprotecteddefault

Container to hold the membership functions

Member Function Documentation

◆ AddMembershipFunction()

template<typename TInputImage , typename TMembershipFunction >

unsigned int itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::AddMembershipFunction ( MembershipFunctionPointer function )

Stores a MembershipCalculator of a class in its internal vector

◆ DeleteAllMembershipFunctions()

template<typename TInputImage , typename TMembershipFunction >

void itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::DeleteAllMembershipFunctions ( )

inline

Method to reset the membership function mean

Definition at line 124 of file itkImageModelEstimatorBase.h.

◆ EstimateModels()

template<typename TInputImage , typename TMembershipFunction >

virtual void itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::EstimateModels ( )

privatepure virtual

The core virtual function to perform modelling of the input data

Implemented in itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, and itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >.

◆ GenerateData()

template<typename TInputImage , typename TMembershipFunction >

void itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::GenerateData ( )

overrideprotectedvirtual

Container to hold the membership functions

Reimplemented from itk::LightProcessObject.

◆ GetInputImage()

template<typename TInputImage , typename TMembershipFunction >

virtual const InputImageType* itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::GetInputImage ( ) const

virtual

Container to hold the membership functions

◆ GetMembershipFunctions()

template<typename TInputImage , typename TMembershipFunction >

const MembershipFunctionPointerVector itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::GetMembershipFunctions ( ) const

inline

Method to get mean

Definition at line 110 of file itkImageModelEstimatorBase.h.

◆ GetModifiableInputImage()

template<typename TInputImage , typename TMembershipFunction >

virtual InputImageType* itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::GetModifiableInputImage ( )

virtual

Container to hold the membership functions

◆ GetNameOfClass()

template<typename TInputImage , typename TMembershipFunction >

virtual const char* itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::LightProcessObject.

Reimplemented in itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, and itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >.

◆ GetNumberOfMembershipFunctions()

template<typename TInputImage , typename TMembershipFunction >

unsigned int itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::GetNumberOfMembershipFunctions ( )

inline

Method to number of membership functions

Definition at line 117 of file itkImageModelEstimatorBase.h.

◆ GetNumberOfModels()

template<typename TInputImage , typename TMembershipFunction >

virtual const unsigned int& itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::GetNumberOfModels ( ) const

virtual

Get the number of classes.

◆ PrintSelf()

template<typename TInputImage , typename TMembershipFunction >

void itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

Container to hold the membership functions

Reimplemented from itk::LightProcessObject.

◆ SetInputImage()

template<typename TInputImage , typename TMembershipFunction >

virtual void itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::SetInputImage ( InputImageType * _arg )

virtual

Type definitions for the training image. Get/Set the input image.

◆ SetMembershipFunctions()

template<typename TInputImage , typename TMembershipFunction >

void itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::SetMembershipFunctions ( MembershipFunctionPointerVector membershipFunctions )

inline

Set the classified image.

Definition at line 103 of file itkImageModelEstimatorBase.h.

◆ SetNumberOfModels()

template<typename TInputImage , typename TMembershipFunction >

virtual void itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::SetNumberOfModels ( unsigned int _arg )

virtual

Set the number of classes.

◆ Update()

template<typename TInputImage , typename TMembershipFunction >

void itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::Update ( )

Define a virtual function to perform model generation from the input data

Member Data Documentation

◆ m_InputImage

template<typename TInputImage , typename TMembershipFunction >

InputImagePointer itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::m_InputImage

private

Container for holding the training image

Definition at line 154 of file itkImageModelEstimatorBase.h.

◆ m_MembershipFunctions

template<typename TInputImage , typename TMembershipFunction >

MembershipFunctionPointerVector itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::m_MembershipFunctions

private

Container to hold the membership functions

Definition at line 151 of file itkImageModelEstimatorBase.h.

◆ m_NumberOfModels

template<typename TInputImage , typename TMembershipFunction >

unsigned int itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::m_NumberOfModels { 0 }

private

Container to hold the membership functions

Definition at line 148 of file itkImageModelEstimatorBase.h.

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

itkImageModelEstimatorBase.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ ConstPointer

◆ InputImagePointer

◆ InputImageType

◆ MembershipFunctionPointer

◆ MembershipFunctionPointerVector

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ImageModelEstimatorBase()

◆ ~ImageModelEstimatorBase()

Member Function Documentation

◆ AddMembershipFunction()

◆ DeleteAllMembershipFunctions()

◆ EstimateModels()

◆ GenerateData()

◆ GetInputImage()

◆ GetMembershipFunctions()

◆ GetModifiableInputImage()

◆ GetNameOfClass()

◆ GetNumberOfMembershipFunctions()

◆ GetNumberOfModels()

◆ PrintSelf()

◆ SetInputImage()

◆ SetMembershipFunctions()

◆ SetNumberOfModels()

◆ Update()

Member Data Documentation

◆ m_InputImage

◆ m_MembershipFunctions

◆ m_NumberOfModels

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