#include <itkConvergenceMonitoringFunction.h>
Abstract base class which monitors convergence during the course of optimization.
Definition at line 41 of file itkConvergenceMonitoringFunction.h.
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 |
![]() | |
using | ConstPointer = SmartPointer<const Self> |
using | Pointer = SmartPointer<Self> |
using | Self = Object |
using | Superclass = LightObject |
![]() | |
using | ConstPointer = SmartPointer<const Self> |
using | Pointer = SmartPointer<Self> |
using | Self = LightObject |
Public Member Functions | |
virtual void | AddEnergyValue (const EnergyValueType value) |
virtual void | ClearEnergyValues () |
virtual RealType | GetConvergenceValue () const =0 |
virtual const char * | GetNameOfClass () const |
EnergyValueContainerSizeType | GetNumberOfEnergyValues () const |
![]() | |
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 |
![]() | |
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 | |
![]() | |
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 | |
![]() | |
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 {} |
![]() | |
std::atomic< int > | m_ReferenceCount {} |
Additional Inherited Members | |
![]() | |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool val) |
![]() | |
static void | BreakOnError () |
static Pointer | New () |
using itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::ConstPointer = SmartPointer<const Self> |
Definition at line 49 of file itkConvergenceMonitoringFunction.h.
using itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::EnergyValueConstIterator = typename EnergyValueContainerType::const_iterator |
Definition at line 61 of file itkConvergenceMonitoringFunction.h.
using itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::EnergyValueContainerSizeType = typename EnergyValueContainerType::size_type |
Definition at line 59 of file itkConvergenceMonitoringFunction.h.
using itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::EnergyValueContainerType = std::deque<EnergyValueType> |
Definition at line 58 of file itkConvergenceMonitoringFunction.h.
using itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::EnergyValueIterator = typename EnergyValueContainerType::iterator |
Definition at line 60 of file itkConvergenceMonitoringFunction.h.
using itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::EnergyValueType = TEnergyValue |
Definition at line 57 of file itkConvergenceMonitoringFunction.h.
using itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::Pointer = SmartPointer<Self> |
Definition at line 48 of file itkConvergenceMonitoringFunction.h.
using itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::RealType = typename NumericTraits<ScalarType>::RealType |
Definition at line 55 of file itkConvergenceMonitoringFunction.h.
using itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::ScalarType = TScalar |
Definition at line 54 of file itkConvergenceMonitoringFunction.h.
using itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::Self = ConvergenceMonitoringFunction |
Definition at line 46 of file itkConvergenceMonitoringFunction.h.
using itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::Superclass = Object |
Definition at line 47 of file itkConvergenceMonitoringFunction.h.
|
inlineprotected |
Definition at line 96 of file itkConvergenceMonitoringFunction.h.
|
overrideprotecteddefault |
|
inlinevirtual |
Reimplemented in itk::Function::WindowConvergenceMonitoringFunction< TScalar >, itk::Function::WindowConvergenceMonitoringFunction< TInternalComputationValueType >, and itk::Function::WindowConvergenceMonitoringFunction< TInternalComputationValueType >.
Definition at line 65 of file itkConvergenceMonitoringFunction.h.
|
inlinevirtual |
Clear all the energy values.
Reimplemented in itk::Function::WindowConvergenceMonitoringFunction< TScalar >, itk::Function::WindowConvergenceMonitoringFunction< TInternalComputationValueType >, and itk::Function::WindowConvergenceMonitoringFunction< TInternalComputationValueType >.
Definition at line 81 of file itkConvergenceMonitoringFunction.h.
|
pure virtual |
Derived classes are responsible for defining the convergence value calculation
Implemented in itk::Function::WindowConvergenceMonitoringFunction< TScalar >, itk::Function::WindowConvergenceMonitoringFunction< TInternalComputationValueType >, and itk::Function::WindowConvergenceMonitoringFunction< TInternalComputationValueType >.
|
virtual |
Reimplemented from itk::Object.
Reimplemented in itk::Function::WindowConvergenceMonitoringFunction< TScalar >, itk::Function::WindowConvergenceMonitoringFunction< TInternalComputationValueType >, and itk::Function::WindowConvergenceMonitoringFunction< TInternalComputationValueType >.
|
inline |
Definition at line 74 of file itkConvergenceMonitoringFunction.h.
Referenced by itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >::ClearEnergyValues().
|
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::LightObject.
Reimplemented in itk::Function::WindowConvergenceMonitoringFunction< TScalar >, itk::Function::WindowConvergenceMonitoringFunction< TInternalComputationValueType >, and itk::Function::WindowConvergenceMonitoringFunction< TInternalComputationValueType >.
Definition at line 101 of file itkConvergenceMonitoringFunction.h.
|
protected |
Definition at line 116 of file itkConvergenceMonitoringFunction.h.