ITK  4.2.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
Module ITKOptimizersv4

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

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
virtual void DebugOff () const
virtual void DebugOn () const
Command * GetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionary & GetMetaDataDictionary (void)
const MetaDataDictionary & GetMetaDataDictionary (void) const
virtual unsigned long 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
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () 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 ()
void PrintSelf (std::ostream &os, Indent indent) const
 ~ConvergenceMonitoringFunction ()
- Protected Member Functions inherited from itk::Object
 Object ()
bool PrintObservers (std::ostream &os, Indent indent) const
virtual void SetTimeStamp (const TimeStamp &time)
virtual ~Object ()
- 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

Private Member Functions

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

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

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

Reimplemented from itk::Object.

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

Definition at line 51 of file itkConvergenceMonitoringFunction.h.

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

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

Definition at line 63 of file itkConvergenceMonitoringFunction.h.

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

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

Definition at line 61 of file itkConvergenceMonitoringFunction.h.

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

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

Definition at line 60 of file itkConvergenceMonitoringFunction.h.

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

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

Definition at line 62 of file itkConvergenceMonitoringFunction.h.

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

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

Definition at line 59 of file itkConvergenceMonitoringFunction.h.

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

Reimplemented from itk::Object.

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

Definition at line 50 of file itkConvergenceMonitoringFunction.h.

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

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

Definition at line 57 of file itkConvergenceMonitoringFunction.h.

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

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

Definition at line 54 of file itkConvergenceMonitoringFunction.h.

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

Reimplemented from itk::Object.

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

Definition at line 49 of file itkConvergenceMonitoringFunction.h.

Constructor & Destructor Documentation

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

Definition at line 95 of file itkConvergenceMonitoringFunction.h.

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

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

Definition at line 66 of file itkConvergenceMonitoringFunction.h.

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

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:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Wed Jul 11 2012 00:32:50 for ITK by doxygen 1.8.1