#include <itkConvergenceMonitoringFunction.h>

Inheritance diagram for itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >:

Collaboration diagram for itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >:

Detailed Description

template<typename TScalar, typename TEnergyValue>
class itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >

Abstract base class which monitors convergence during the course of optimization.

Author: Nick Tustison; Brian Avants

Definition at line 43 of file itkConvergenceMonitoringFunction.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef EnergyValueContainerType::const_iterator	EnergyValueConstIterator

typedef EnergyValueContainerType::size_type	EnergyValueContainerSizeType

typedef std::deque < EnergyValueType >	EnergyValueContainerType

typedef EnergyValueContainerType::iterator	EnergyValueIterator

typedef TEnergyValue	EnergyValueType

typedef SmartPointer< Self >	Pointer

typedef NumericTraits < ScalarType >::RealType	RealType

typedef TScalar	ScalarType

typedef ConvergenceMonitoringFunction	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 void	AddEnergyValue (const EnergyValueType value)

virtual RealType	GetConvergenceValue () const =0

virtual const char *	GetNameOfClass () const

EnergyValueContainerSizeType	GetNumberOfEnergyValues () const


virtual void	ClearEnergyValues ()

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

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

virtual 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

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

Protected Member Functions
	ConvergenceMonitoringFunction ()

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

	~ConvergenceMonitoringFunction () override

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

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

virtual void	SetTimeStamp (const TimeStamp &time)

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

Protected Attributes
EnergyValueContainerType	m_EnergyValues

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

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

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

static Pointer	New ()