ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | List of all members
itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue > Class Template Referenceabstract

#include <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 const char * GetNameOfClass () const
 
EnergyValueContainerSizeType GetNumberOfEnergyValues () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 
EnergyValueContainerType m_EnergyValues
 
virtual void ClearEnergyValues ()
 
virtual RealType GetConvergenceValue () const =0
 
 ConvergenceMonitoringFunction ()
 
 ~ConvergenceMonitoringFunction () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

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 ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 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.

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

Clear all the energy values.

Definition at line 99 of file itkConvergenceMonitoringFunction.h.

◆ ~ConvergenceMonitoringFunction()

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

Clear all the energy values.

Member Function Documentation

◆ AddEnergyValue()

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

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>
virtual const char* itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

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

◆ GetNumberOfEnergyValues()

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

◆ PrintSelf()

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

Clear all the energy values.

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

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