ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::Function::WindowConvergenceMonitoringFunction< TScalar > Class Template Reference

#include <itkWindowConvergenceMonitoringFunction.h>

+ Inheritance diagram for itk::Function::WindowConvergenceMonitoringFunction< TScalar >:
+ Collaboration diagram for itk::Function::WindowConvergenceMonitoringFunction< TScalar >:

Detailed Description

template<typename TScalar = double>
class itk::Function::WindowConvergenceMonitoringFunction< TScalar >

Class which monitors convergence during the course of optimization.

Author
Nick Tustison
Brian Avants

Definition at line 39 of file itkWindowConvergenceMonitoringFunction.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef
EnergyValueContainerType::const_iterator 
EnergyValueConstIterator
 
typedef
Superclass::EnergyValueContainerSizeType 
EnergyValueContainerSizeType
 
typedef
Superclass::EnergyValueContainerType 
EnergyValueContainerType
 
typedef
EnergyValueContainerType::iterator 
EnergyValueIterator
 
typedef Superclass::EnergyValueType EnergyValueType
 
typedef SmartPointer< SelfPointer
 
typedef NumericTraits
< ScalarType >::RealType 
RealType
 
typedef TScalar ScalarType
 
typedef
WindowConvergenceMonitoringFunction 
Self
 
typedef
ConvergenceMonitoringFunction
< TScalar, TScalar > 
Superclass
 
- Public Types inherited from itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >
typedef SmartPointer< const SelfConstPointer
 
typedef
EnergyValueContainerType::const_iterator 
EnergyValueConstIterator
 
typedef
EnergyValueContainerType::size_type 
EnergyValueContainerSizeType
 
typedef std::deque
< EnergyValueType
EnergyValueContainerType
 
typedef
EnergyValueContainerType::iterator 
EnergyValueIterator
 
typedef TScalar 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) override
 
virtual void ClearEnergyValues () override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual RealType GetConvergenceValue () const override
 
virtual const char * GetNameOfClass () const
 
virtual void SetWindowSize (EnergyValueContainerSizeType _arg)
 
virtual
EnergyValueContainerSizeType 
GetWindowSize () const
 
- Public Member Functions inherited from itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >
virtual void AddEnergyValue (const EnergyValueType value)
 
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
 
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
 

Static Public Member Functions

static Pointer New ()
 
- 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

void PrintSelf (std::ostream &os, Indent indent) const override
 
 WindowConvergenceMonitoringFunction ()
 
 ~WindowConvergenceMonitoringFunction ()
 
- Protected Member Functions inherited from itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >
 ConvergenceMonitoringFunction ()
 
 ~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 ()
 

Private Member Functions

void operator= (const Self &) ITK_DELETE_FUNCTION
 
 WindowConvergenceMonitoringFunction (const Self &) ITK_DELETE_FUNCTION
 

Private Attributes

RealType m_TotalEnergy
 
EnergyValueContainerSizeType m_WindowSize
 

Additional Inherited Members

- Protected Attributes inherited from itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >
EnergyValueContainerType m_EnergyValues
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TScalar = double>
typedef SmartPointer<const Self> itk::Function::WindowConvergenceMonitoringFunction< TScalar >::ConstPointer

Definition at line 47 of file itkWindowConvergenceMonitoringFunction.h.

template<typename TScalar = double>
typedef EnergyValueContainerType::const_iterator itk::Function::WindowConvergenceMonitoringFunction< TScalar >::EnergyValueConstIterator

Definition at line 62 of file itkWindowConvergenceMonitoringFunction.h.

template<typename TScalar = double>
typedef Superclass::EnergyValueContainerSizeType itk::Function::WindowConvergenceMonitoringFunction< TScalar >::EnergyValueContainerSizeType

Definition at line 60 of file itkWindowConvergenceMonitoringFunction.h.

template<typename TScalar = double>
typedef Superclass::EnergyValueContainerType itk::Function::WindowConvergenceMonitoringFunction< TScalar >::EnergyValueContainerType

Definition at line 59 of file itkWindowConvergenceMonitoringFunction.h.

template<typename TScalar = double>
typedef EnergyValueContainerType::iterator itk::Function::WindowConvergenceMonitoringFunction< TScalar >::EnergyValueIterator

Definition at line 61 of file itkWindowConvergenceMonitoringFunction.h.

template<typename TScalar = double>
typedef Superclass::EnergyValueType itk::Function::WindowConvergenceMonitoringFunction< TScalar >::EnergyValueType

Definition at line 58 of file itkWindowConvergenceMonitoringFunction.h.

template<typename TScalar = double>
typedef SmartPointer<Self> itk::Function::WindowConvergenceMonitoringFunction< TScalar >::Pointer

Definition at line 46 of file itkWindowConvergenceMonitoringFunction.h.

template<typename TScalar = double>
typedef NumericTraits<ScalarType>::RealType itk::Function::WindowConvergenceMonitoringFunction< TScalar >::RealType

Definition at line 56 of file itkWindowConvergenceMonitoringFunction.h.

template<typename TScalar = double>
typedef TScalar itk::Function::WindowConvergenceMonitoringFunction< TScalar >::ScalarType

Definition at line 53 of file itkWindowConvergenceMonitoringFunction.h.

template<typename TScalar = double>
typedef WindowConvergenceMonitoringFunction itk::Function::WindowConvergenceMonitoringFunction< TScalar >::Self

Definition at line 44 of file itkWindowConvergenceMonitoringFunction.h.

template<typename TScalar = double>
typedef ConvergenceMonitoringFunction<TScalar, TScalar> itk::Function::WindowConvergenceMonitoringFunction< TScalar >::Superclass

Definition at line 45 of file itkWindowConvergenceMonitoringFunction.h.

Constructor & Destructor Documentation

template<typename TScalar = double>
itk::Function::WindowConvergenceMonitoringFunction< TScalar >::WindowConvergenceMonitoringFunction ( )
protected
template<typename TScalar = double>
itk::Function::WindowConvergenceMonitoringFunction< TScalar >::~WindowConvergenceMonitoringFunction ( )
protected
template<typename TScalar = double>
itk::Function::WindowConvergenceMonitoringFunction< TScalar >::WindowConvergenceMonitoringFunction ( const Self )
private

Member Function Documentation

template<typename TScalar = double>
virtual void itk::Function::WindowConvergenceMonitoringFunction< TScalar >::AddEnergyValue ( const EnergyValueType  )
overridevirtual

Add energy value

template<typename TScalar = double>
virtual void itk::Function::WindowConvergenceMonitoringFunction< TScalar >::ClearEnergyValues ( )
overridevirtual

Clear all the energy values.

Reimplemented from itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >.

template<typename TScalar = double>
virtual::itk::LightObject::Pointer itk::Function::WindowConvergenceMonitoringFunction< TScalar >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<typename TScalar = double>
virtual RealType itk::Function::WindowConvergenceMonitoringFunction< TScalar >::GetConvergenceValue ( ) const
overridevirtual

Calculate convergence value by fitting to a window of the enrgy profile

Implements itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >.

template<typename TScalar = double>
virtual const char* itk::Function::WindowConvergenceMonitoringFunction< TScalar >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >.

template<typename TScalar = double>
virtual EnergyValueContainerSizeType itk::Function::WindowConvergenceMonitoringFunction< TScalar >::GetWindowSize ( ) const
virtual

Set/Get window size over which the convergence value is calculated

template<typename TScalar = double>
static Pointer itk::Function::WindowConvergenceMonitoringFunction< TScalar >::New ( )
static

Method for creation through the object factory.

template<typename TScalar = double>
void itk::Function::WindowConvergenceMonitoringFunction< TScalar >::operator= ( const Self )
private
template<typename TScalar = double>
void itk::Function::WindowConvergenceMonitoringFunction< TScalar >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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::Function::ConvergenceMonitoringFunction< TScalar, TScalar >.

template<typename TScalar = double>
virtual void itk::Function::WindowConvergenceMonitoringFunction< TScalar >::SetWindowSize ( EnergyValueContainerSizeType  _arg)
virtual

Set/Get window size over which the convergence value is calculated

Member Data Documentation

template<typename TScalar = double>
RealType itk::Function::WindowConvergenceMonitoringFunction< TScalar >::m_TotalEnergy
private

Definition at line 91 of file itkWindowConvergenceMonitoringFunction.h.

template<typename TScalar = double>
EnergyValueContainerSizeType itk::Function::WindowConvergenceMonitoringFunction< TScalar >::m_WindowSize
private

Definition at line 89 of file itkWindowConvergenceMonitoringFunction.h.


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