ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue > Class Template Referenceabstract
Group Numerics » Module ITKOptimizersv4

#include <itkConvergenceMonitoringFunction.h>

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.

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

Public Types

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 = TEnergyValue
 
using Pointer = SmartPointer< Self >
 
using RealType = typename NumericTraits< ScalarType >::RealType
 
using ScalarType = TScalar
 
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

virtual void AddEnergyValue (const EnergyValueType value)
 
virtual RealType GetConvergenceValue () const =0
 
const char * GetNameOfClass () const override
 
EnergyValueContainerSizeType GetNumberOfEnergyValues () const
 
virtual void ClearEnergyValues ()
 
- 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

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

Protected Attributes

EnergyValueContainerType m_EnergyValues {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< 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 val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Member Typedef Documentation

◆ ConstPointer

template<typename TScalar, typename TEnergyValue>
using itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::ConstPointer = SmartPointer<const Self>

Definition at line 51 of file itkConvergenceMonitoringFunction.h.

◆ EnergyValueConstIterator

template<typename TScalar, typename TEnergyValue>
using itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::EnergyValueConstIterator = typename EnergyValueContainerType::const_iterator

Definition at line 63 of file itkConvergenceMonitoringFunction.h.

◆ EnergyValueContainerSizeType

template<typename TScalar, typename TEnergyValue>
using itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::EnergyValueContainerSizeType = typename EnergyValueContainerType::size_type

Definition at line 61 of file itkConvergenceMonitoringFunction.h.

◆ EnergyValueContainerType

template<typename TScalar, typename TEnergyValue>
using itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::EnergyValueContainerType = std::deque<EnergyValueType>

Definition at line 60 of file itkConvergenceMonitoringFunction.h.

◆ EnergyValueIterator

template<typename TScalar, typename TEnergyValue>
using itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::EnergyValueIterator = typename EnergyValueContainerType::iterator

Definition at line 62 of file itkConvergenceMonitoringFunction.h.

◆ EnergyValueType

template<typename TScalar, typename TEnergyValue>
using itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::EnergyValueType = TEnergyValue

Definition at line 59 of file itkConvergenceMonitoringFunction.h.

◆ Pointer

template<typename TScalar, typename TEnergyValue>
using itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::Pointer = SmartPointer<Self>

Definition at line 50 of file itkConvergenceMonitoringFunction.h.

◆ RealType

template<typename TScalar, typename TEnergyValue>
using itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::RealType = typename NumericTraits<ScalarType>::RealType

Definition at line 57 of file itkConvergenceMonitoringFunction.h.

◆ ScalarType

template<typename TScalar, typename TEnergyValue>
using itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::ScalarType = TScalar

Definition at line 56 of file itkConvergenceMonitoringFunction.h.

◆ Self

template<typename TScalar, typename TEnergyValue>
using itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::Self = ConvergenceMonitoringFunction

Definition at line 48 of file itkConvergenceMonitoringFunction.h.

◆ Superclass

template<typename TScalar, typename TEnergyValue>
using itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::Superclass = Object

Definition at line 49 of file itkConvergenceMonitoringFunction.h.

Constructor & Destructor Documentation

◆ ConvergenceMonitoringFunction()

template<typename TScalar, typename TEnergyValue>
itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::ConvergenceMonitoringFunction ( )
inlineprotected

Definition at line 99 of file itkConvergenceMonitoringFunction.h.

◆ ~ConvergenceMonitoringFunction()

template<typename TScalar, typename TEnergyValue>
itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::~ConvergenceMonitoringFunction ( )
overrideprotecteddefault

Member Function Documentation

◆ AddEnergyValue()

template<typename TScalar, typename TEnergyValue>
virtual void itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::AddEnergyValue ( const EnergyValueType  value)
inlinevirtual

Reimplemented in itk::Function::WindowConvergenceMonitoringFunction< TScalar >.

Definition at line 67 of file itkConvergenceMonitoringFunction.h.

◆ ClearEnergyValues()

template<typename TScalar, typename TEnergyValue>
virtual void itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::ClearEnergyValues ( )
inlinevirtual

Clear all the energy values.

Reimplemented in itk::Function::WindowConvergenceMonitoringFunction< TScalar >.

Definition at line 83 of file itkConvergenceMonitoringFunction.h.

◆ GetConvergenceValue()

template<typename TScalar, typename TEnergyValue>
virtual RealType itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::GetConvergenceValue ( ) const
pure virtual

Derived classes are responsible for defining the convergence value calculation

Implemented in itk::Function::WindowConvergenceMonitoringFunction< TScalar >.

◆ GetNameOfClass()

template<typename TScalar, typename TEnergyValue>
const char* itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ GetNumberOfEnergyValues()

template<typename TScalar, typename TEnergyValue>
EnergyValueContainerSizeType itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::GetNumberOfEnergyValues ( ) const
inline

Definition at line 76 of file itkConvergenceMonitoringFunction.h.

Referenced by itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >::ClearEnergyValues().

◆ PrintSelf()

template<typename TScalar, typename TEnergyValue>
void itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
inlineoverrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Object.

Definition at line 104 of file itkConvergenceMonitoringFunction.h.

Member Data Documentation

◆ m_EnergyValues

template<typename TScalar, typename TEnergyValue>
EnergyValueContainerType itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::m_EnergyValues {}
protected

Definition at line 119 of file itkConvergenceMonitoringFunction.h.

Referenced by itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >::AddEnergyValue(), itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >::ClearEnergyValues(), itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >::ConvergenceMonitoringFunction(), itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >::GetNumberOfEnergyValues(), and itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >::PrintSelf().

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16