ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue > Class Template Reference

Abstract base class which monitors convergence during the course of optimization. More...

#include <itkConvergenceMonitoringFunction.h>

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

List of all members.

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 Member Functions

virtual void AddEnergyValue (const EnergyValueType value)
virtual RealType GetConvergenceValue () const =0
virtual const char * GetNameOfClass () const
EnergyValueContainerSizeType GetNumberOfEnergyValues () const
virtual void ClearEnergyValues ()

Protected Member Functions

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

Protected Attributes

EnergyValueContainerType m_EnergyValues

Private Member Functions

 ConvergenceMonitoringFunction (const Self &)
void operator= (const Self &)

Detailed Description

template<class TScalar, class 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

template<class TScalar, class TEnergyValue>
typedef SmartPointer<const Self> itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::ConstPointer
template<class TScalar, class TEnergyValue>
typedef EnergyValueContainerType::const_iterator itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::EnergyValueConstIterator
template<class TScalar, class TEnergyValue>
typedef EnergyValueContainerType::size_type itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::EnergyValueContainerSizeType
template<class TScalar, class TEnergyValue>
typedef std::deque<EnergyValueType> itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::EnergyValueContainerType
template<class TScalar, class TEnergyValue>
typedef EnergyValueContainerType::iterator itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::EnergyValueIterator
template<class TScalar, class TEnergyValue>
typedef TEnergyValue itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::EnergyValueType
template<class TScalar, class TEnergyValue>
typedef SmartPointer<Self> itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::Pointer
template<class TScalar, class TEnergyValue>
typedef NumericTraits<ScalarType>::RealType itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::RealType
template<class TScalar, class TEnergyValue>
typedef TScalar itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::ScalarType
template<class TScalar, class TEnergyValue>
typedef ConvergenceMonitoringFunction itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::Self

Smart pointer typedef support.

Reimplemented from itk::Object.

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

Definition at line 48 of file itkConvergenceMonitoringFunction.h.

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

Constructor & Destructor Documentation

template<class TScalar, class TEnergyValue>
itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::ConvergenceMonitoringFunction ( ) [inline, protected]

Definition at line 95 of file itkConvergenceMonitoringFunction.h.

template<class TScalar, class TEnergyValue>
itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::~ConvergenceMonitoringFunction ( ) [inline, protected]

Definition at line 100 of file itkConvergenceMonitoringFunction.h.

template<class TScalar, class TEnergyValue>
itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::ConvergenceMonitoringFunction ( const Self ) [private]

Member Function Documentation

template<class TScalar, class TEnergyValue>
virtual void itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::AddEnergyValue ( const EnergyValueType  value) [inline, virtual]

Definition at line 66 of file itkConvergenceMonitoringFunction.h.

template<class TScalar, class TEnergyValue>
virtual void itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::ClearEnergyValues ( ) [inline, virtual]

Clear all the energy values.

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

Definition at line 80 of file itkConvergenceMonitoringFunction.h.

template<class TScalar, class 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<class TScalar, class 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<class TScalar, class TEnergyValue>
EnergyValueContainerSizeType itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::GetNumberOfEnergyValues ( ) const [inline]

Definition at line 74 of file itkConvergenceMonitoringFunction.h.

template<class TScalar, class TEnergyValue>
void itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::operator= ( const Self ) [private]

Mutex lock to protect modification to the reference count

Reimplemented from itk::Object.

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

template<class TScalar, class TEnergyValue>
void itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [inline, protected, virtual]

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<class TScalar, class TEnergyValue>
EnergyValueContainerType itk::Function::ConvergenceMonitoringFunction< TScalar, TEnergyValue >::m_EnergyValues [protected]

Definition at line 117 of file itkConvergenceMonitoringFunction.h.


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