#include <itkStoppingCriterionBase.h>

Detailed Description

An abstract base class to represent a stopping criterion for an iterative algorithm.

The main method is StoppingCriterionBase::IsSatisfied that must be reimplemented in inheriting classes.

Definition at line 38 of file itkStoppingCriterionBase.h.

Inheritance diagram for itk::StoppingCriterionBase:

Collaboration diagram for itk::StoppingCriterionBase:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = StoppingCriterionBase

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
const char *	GetNameOfClass () const override


virtual bool	IsSatisfied () const =0

virtual std::string	GetDescription () const =0

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

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

virtual int	GetReferenceCount () const

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

Protected Member Functions
	StoppingCriterionBase ()

	~StoppingCriterionBase () 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	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Additional Inherited Members
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 {}

Member Typedef Documentation

◆ ConstPointer

using itk::StoppingCriterionBase::ConstPointer = SmartPointer<const Self>

Definition at line 46 of file itkStoppingCriterionBase.h.

◆ Pointer

using itk::StoppingCriterionBase::Pointer = SmartPointer<Self>

Definition at line 45 of file itkStoppingCriterionBase.h.

◆ Self

using itk::StoppingCriterionBase::Self = StoppingCriterionBase

Definition at line 43 of file itkStoppingCriterionBase.h.

◆ Superclass

using itk::StoppingCriterionBase::Superclass = Object

Definition at line 44 of file itkStoppingCriterionBase.h.

Constructor & Destructor Documentation

◆ StoppingCriterionBase()

itk::StoppingCriterionBase::StoppingCriterionBase ( )

protected

Constructor.

◆ ~StoppingCriterionBase()

itk::StoppingCriterionBase::~StoppingCriterionBase ( )

overrideprotected

Destructor.

Member Function Documentation

◆ GetDescription()

virtual std::string itk::StoppingCriterionBase::GetDescription ( ) const

pure virtual

Returns: true if the stopping criterion is reached (and the algorithm must stop).; false else.

◆ GetNameOfClass()

const char* itk::StoppingCriterionBase::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

Reimplemented in itk::LevelSetEvolutionStoppingCriterion< TLevelSetContainer >.

◆ IsSatisfied()

virtual bool itk::StoppingCriterionBase::IsSatisfied ( ) const