#include <itkWindowConvergenceMonitoringFunction.h>

Detailed Description

template<typename TScalar = double>
class itk::Function::WindowConvergenceMonitoringFunction< TScalar >

Class which monitors convergence during the course of optimization.

Author: Nick Tustison; Brian Avants

Definition at line 39 of file itkWindowConvergenceMonitoringFunction.h.

Inheritance diagram for itk::Function::WindowConvergenceMonitoringFunction< TScalar >:

Collaboration diagram for itk::Function::WindowConvergenceMonitoringFunction< TScalar >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	EnergyValueConstIterator = typename EnergyValueContainerType::const_iterator

using	EnergyValueIterator = typename EnergyValueContainerType::iterator

using	Pointer = SmartPointer< Self >

using	RealType = typename NumericTraits< ScalarType >::RealType

using	ScalarType = TScalar

using	Self = WindowConvergenceMonitoringFunction

using	Superclass = ConvergenceMonitoringFunction< TScalar, TScalar >

Public Types inherited from itk::Function::ConvergenceMonitoringFunction< double, double >
using	ConstPointer = SmartPointer< const Self >

using	EnergyValueConstIterator = typename EnergyValueContainerType::const_iterator

using	EnergyValueContainerSizeType = typename EnergyValueContainerType::size_type

using	EnergyValueContainerType = std::deque< EnergyValueType >

using	EnergyValueIterator = typename EnergyValueContainerType::iterator

using	EnergyValueType = double

using	Pointer = SmartPointer< Self >

using	RealType = typename NumericTraits< ScalarType >::RealType

using	ScalarType = double

using	Self = ConvergenceMonitoringFunction

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
void	AddEnergyValue (const EnergyValueType) override

void	ClearEnergyValues () override

RealType	GetConvergenceValue () const override

const char *	GetNameOfClass () const override


virtual void	SetWindowSize (EnergyValueContainerSizeType _arg)

virtual EnergyValueContainerSizeType	GetWindowSize () const

Public Member Functions inherited from itk::Function::ConvergenceMonitoringFunction< double, double >
virtual void	AddEnergyValue (const EnergyValueType value)

virtual RealType	GetConvergenceValue () const=0

const char *	GetNameOfClass () const override

EnergyValueContainerSizeType	GetNumberOfEnergyValues () 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::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	PrintSelf (std::ostream &os, Indent indent) const override

	WindowConvergenceMonitoringFunction ()

	~WindowConvergenceMonitoringFunction () override=default

Protected Member Functions inherited from itk::Function::ConvergenceMonitoringFunction< double, double >
	ConvergenceMonitoringFunction ()

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

	~ConvergenceMonitoringFunction () override=default

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 Attributes
RealType	m_TotalEnergy {}

EnergyValueContainerSizeType	m_WindowSize {}

Additional Inherited Members
Protected Attributes inherited from itk::Function::ConvergenceMonitoringFunction< double, double >
EnergyValueContainerType	m_EnergyValues

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