itk::Function::WindowConvergenceMonitoringFunction< TScalar > Class Template Reference

#include <itkWindowConvergenceMonitoringFunction.h>

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

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

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef EnergyValueContainerType::const_iterator	EnergyValueConstIterator
typedef Superclass::EnergyValueContainerSizeType	EnergyValueContainerSizeType
typedef Superclass::EnergyValueContainerType	EnergyValueContainerType
typedef EnergyValueContainerType::iterator	EnergyValueIterator
typedef Superclass::EnergyValueType	EnergyValueType
typedef SmartPointer< Self >	Pointer
typedef NumericTraits < ScalarType >::RealType	RealType
typedef TScalar	ScalarType
typedef WindowConvergenceMonitoringFunction	Self
typedef ConvergenceMonitoringFunction < TScalar, TScalar >	Superclass
Public Member Functions
virtual void	AddEnergyValue (const EnergyValueType)
virtual void	ClearEnergyValues ()
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual RealType	GetConvergenceValue () const
virtual const char *	GetNameOfClass () const
virtual void	SetWindowSize (EnergyValueContainerSizeType _arg)
virtual EnergyValueContainerSizeType	GetWindowSize () const
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const
	WindowConvergenceMonitoringFunction ()
	~WindowConvergenceMonitoringFunction ()
Private Member Functions
void	operator= (const Self &)
	WindowConvergenceMonitoringFunction (const Self &)
Private Attributes
RealType	m_TotalEnergy
EnergyValueContainerSizeType	m_WindowSize

---

Detailed Description

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

---

Member Typedef Documentation

template<class TScalar = double>

typedef SmartPointer<const Self> itk::Function::WindowConvergenceMonitoringFunction< TScalar >::ConstPointer

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

Definition at line 47 of file itkWindowConvergenceMonitoringFunction.h.

template<class TScalar = double>

typedef EnergyValueContainerType::const_iterator itk::Function::WindowConvergenceMonitoringFunction< TScalar >::EnergyValueConstIterator

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

Definition at line 62 of file itkWindowConvergenceMonitoringFunction.h.

template<class TScalar = double>

typedef Superclass::EnergyValueContainerSizeType itk::Function::WindowConvergenceMonitoringFunction< TScalar >::EnergyValueContainerSizeType

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

Definition at line 60 of file itkWindowConvergenceMonitoringFunction.h.

template<class TScalar = double>

typedef Superclass::EnergyValueContainerType itk::Function::WindowConvergenceMonitoringFunction< TScalar >::EnergyValueContainerType

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

Definition at line 59 of file itkWindowConvergenceMonitoringFunction.h.

template<class TScalar = double>

typedef EnergyValueContainerType::iterator itk::Function::WindowConvergenceMonitoringFunction< TScalar >::EnergyValueIterator

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

Definition at line 61 of file itkWindowConvergenceMonitoringFunction.h.

template<class TScalar = double>

typedef Superclass::EnergyValueType itk::Function::WindowConvergenceMonitoringFunction< TScalar >::EnergyValueType

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

Definition at line 58 of file itkWindowConvergenceMonitoringFunction.h.

template<class TScalar = double>

typedef SmartPointer<Self> itk::Function::WindowConvergenceMonitoringFunction< TScalar >::Pointer

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

Definition at line 46 of file itkWindowConvergenceMonitoringFunction.h.

template<class TScalar = double>

typedef NumericTraits<ScalarType>::RealType itk::Function::WindowConvergenceMonitoringFunction< TScalar >::RealType

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

Definition at line 56 of file itkWindowConvergenceMonitoringFunction.h.

template<class TScalar = double>

typedef TScalar itk::Function::WindowConvergenceMonitoringFunction< TScalar >::ScalarType

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

Definition at line 53 of file itkWindowConvergenceMonitoringFunction.h.

template<class TScalar = double>

typedef WindowConvergenceMonitoringFunction itk::Function::WindowConvergenceMonitoringFunction< TScalar >::Self

Smart pointer typedef support.

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

Definition at line 44 of file itkWindowConvergenceMonitoringFunction.h.

template<class TScalar = double>

typedef ConvergenceMonitoringFunction<TScalar, TScalar> itk::Function::WindowConvergenceMonitoringFunction< TScalar >::Superclass

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

Definition at line 45 of file itkWindowConvergenceMonitoringFunction.h.

---

Constructor & Destructor Documentation

template<class TScalar = double>

itk::Function::WindowConvergenceMonitoringFunction< TScalar >::WindowConvergenceMonitoringFunction

(

)

[protected]

template<class TScalar = double>

itk::Function::WindowConvergenceMonitoringFunction< TScalar >::~WindowConvergenceMonitoringFunction

(

)

[protected]

template<class TScalar = double>

itk::Function::WindowConvergenceMonitoringFunction< TScalar >::WindowConvergenceMonitoringFunction

(

const Self &

)

[private]

---

Member Function Documentation

template<class TScalar = double>

virtual void itk::Function::WindowConvergenceMonitoringFunction< TScalar >::AddEnergyValue

(

const EnergyValueType

)

[virtual]

Add energy value

template<class TScalar = double>

virtual void itk::Function::WindowConvergenceMonitoringFunction< TScalar >::ClearEnergyValues

(

)

[virtual]

Clear all the energy values.

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

template<class TScalar = double>

virtual::itk::LightObject::Pointer itk::Function::WindowConvergenceMonitoringFunction< TScalar >::CreateAnother

(

void

)

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<class TScalar = double>

virtual RealType itk::Function::WindowConvergenceMonitoringFunction< TScalar >::GetConvergenceValue

(

)

const [virtual]

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

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

template<class 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<class TScalar = double>

virtual EnergyValueContainerSizeType itk::Function::WindowConvergenceMonitoringFunction< TScalar >::GetWindowSize

(

)

const [virtual]

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

template<class TScalar = double>

static Pointer itk::Function::WindowConvergenceMonitoringFunction< TScalar >::New

(

)

[static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TScalar = double>

void itk::Function::WindowConvergenceMonitoringFunction< TScalar >::operator=

(

const Self &

)

[private]

Mutex lock to protect modification to the reference count

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

template<class TScalar = double>

void itk::Function::WindowConvergenceMonitoringFunction< TScalar >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const [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::Function::ConvergenceMonitoringFunction< TScalar, TScalar >.

template<class 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<class TScalar = double>

RealType itk::Function::WindowConvergenceMonitoringFunction< TScalar >::m_TotalEnergy [private]

Definition at line 91 of file itkWindowConvergenceMonitoringFunction.h.

template<class 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:

• itkWindowConvergenceMonitoringFunction.h