ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | 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 >:

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 SelfConstPointer
 
typedef
EnergyValueContainerType::const_iterator 
EnergyValueConstIterator
 
typedef
EnergyValueContainerType::size_type 
EnergyValueContainerSizeType
 
typedef std::deque
< EnergyValueType
EnergyValueContainerType
 
typedef
EnergyValueContainerType::iterator 
EnergyValueIterator
 
typedef TEnergyValue EnergyValueType
 
typedef SmartPointer< SelfPointer
 
typedef NumericTraits
< ScalarType >::RealType 
RealType
 
typedef TScalar ScalarType
 
typedef
ConvergenceMonitoringFunction 
Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
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
 
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
 
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 ()
 

Member Typedef Documentation

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

Definition at line 51 of file itkConvergenceMonitoringFunction.h.

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

Definition at line 63 of file itkConvergenceMonitoringFunction.h.

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

Definition at line 61 of file itkConvergenceMonitoringFunction.h.

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

Definition at line 60 of file itkConvergenceMonitoringFunction.h.

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

Definition at line 62 of file itkConvergenceMonitoringFunction.h.

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

Definition at line 59 of file itkConvergenceMonitoringFunction.h.

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

Definition at line 50 of file itkConvergenceMonitoringFunction.h.

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

Definition at line 57 of file itkConvergenceMonitoringFunction.h.

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

Definition at line 54 of file itkConvergenceMonitoringFunction.h.

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

Definition at line 48 of file itkConvergenceMonitoringFunction.h.

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

Definition at line 49 of file itkConvergenceMonitoringFunction.h.

Constructor & Destructor Documentation

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

Definition at line 95 of file itkConvergenceMonitoringFunction.h.

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

Definition at line 100 of file itkConvergenceMonitoringFunction.h.

Member Function Documentation

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

Definition at line 66 of file itkConvergenceMonitoringFunction.h.

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 80 of file itkConvergenceMonitoringFunction.h.

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 >.

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 >.

template<typename TScalar, typename TEnergyValue>
EnergyValueContainerSizeType itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::GetNumberOfEnergyValues ( ) const
inline
template<typename TScalar, typename TEnergyValue>
virtual 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.

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

Definition at line 102 of file itkConvergenceMonitoringFunction.h.

Member Data Documentation

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: