#include <itkMultiGradientOptimizerv4.h>

Inheritance diagram for itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >:

Collaboration diagram for itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >:

Detailed Description

template<typename TInternalComputationValueType>
class itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >

Multiple gradient-based optimizers are combined in order to perform a multi-objective optimization.

This optimizer will do a combined gradient descent optimization using whatever metric/optimizer gradient sub-optimizers are passed to it by the user. The learning rate or scaleestimator for each sub-optimizer controls the relative weight of each metric in the optimization. Denote the weights as $ w_1 $ and $ w_2 $ then the MultiGradientOptimizer will optimize $\sum_i w_i Metric_i$ by using update rule:

$params_{new} = params_{old} + \frac{1}{N_{Metrics}} * ( \sum_i w_i Grad(Metric_i) )$

Note: The scales, learning rates and weights options must be set individually for each sub-optimizer, and have no effect when set on this class.

The test for this class illustrates the expected behavior.

Definition at line 46 of file itkMultiGradientOptimizerv4.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef MetricType::DerivativeType	DerivativeType

typedef TInternalComputationValueType	InternalComputationValueType

typedef itk::GradientDescentOptimizerv4Template < TInternalComputationValueType > ::Pointer	LocalOptimizerPointer

typedef itk::GradientDescentOptimizerv4Template < TInternalComputationValueType >	LocalOptimizerType

typedef Superclass::MeasureType	MeasureType

typedef Superclass::MetricType	MetricType

typedef MetricType::Pointer	MetricTypePointer

typedef std::vector< MeasureType >	MetricValuesListType

typedef OptimizerType::Pointer	OptimizerPointer

typedef OptimizersListType::size_type	OptimizersListSizeType

typedef std::vector < LocalOptimizerPointer >	OptimizersListType

typedef ObjectToObjectOptimizerBaseTemplate < TInternalComputationValueType >	OptimizerType

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

typedef MultiGradientOptimizerv4Template	Self

typedef Superclass::StopConditionDescriptionType	StopConditionDescriptionType

typedef Superclass::StopConditionReturnStringType	StopConditionReturnStringType

typedef Superclass::StopConditionType	StopConditionType

typedef GradientDescentOptimizerv4Template < TInternalComputationValueType >	Superclass

Public Types inherited from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DerivativeType	DerivativeType

typedef Superclass::IndexRangeType	IndexRangeType

typedef TInternalComputationValueType	InternalComputationValueType

typedef Superclass::MeasureType	MeasureType

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

typedef Superclass::ScalesType	ScalesType

typedef GradientDescentOptimizerv4Template	Self

typedef Superclass::StopConditionType	StopConditionType

typedef GradientDescentOptimizerBasev4Template < TInternalComputationValueType >	Superclass

Public Types inherited from itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >
typedef SmartPointer< const Self >	ConstPointer

typedef itk::Function::WindowConvergenceMonitoringFunction < TInternalComputationValueType >	ConvergenceMonitoringType

typedef Superclass::DerivativeType	DerivativeType

typedef ThreadedIndexedContainerPartitioner::IndexRangeType	IndexRangeType

typedef TInternalComputationValueType	InternalComputationValueType

typedef Superclass::MeasureType	MeasureType

typedef Superclass::MetricType	MetricType

typedef MetricType::Pointer	MetricTypePointer

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

typedef Superclass::ScalesType	ScalesType

typedef GradientDescentOptimizerBasev4Template	Self

typedef Superclass::StopConditionDescriptionType	StopConditionDescriptionType

typedef Superclass::StopConditionReturnStringType	StopConditionReturnStringType

enum	StopConditionType { MAXIMUM_NUMBER_OF_ITERATIONS, COSTFUNCTION_ERROR, UPDATE_PARAMETERS_ERROR, STEP_TOO_SMALL, CONVERGENCE_CHECKER_PASSED, GRADIENT_MAGNITUDE_TOLEARANCE, OTHER_ERROR }

typedef ObjectToObjectOptimizerBaseTemplate < TInternalComputationValueType >	Superclass

Public Types inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
typedef SmartPointer< const Self >	ConstPointer

typedef MetricType::DerivativeType	DerivativeType

typedef MetricType::MeasureType	MeasureType

typedef ObjectToObjectMetricBaseTemplate < TInternalComputationValueType >	MetricType

typedef MetricType::Pointer	MetricTypePointer

typedef MetricType::NumberOfParametersType	NumberOfParametersType

typedef OptimizerParameters < TInternalComputationValueType >	ParametersType

typedef SmartPointer< Self >	Pointer

typedef OptimizerParameterScalesEstimatorTemplate < TInternalComputationValueType >	ScalesEstimatorType

typedef OptimizerParameters < TInternalComputationValueType >	ScalesType

typedef ObjectToObjectOptimizerBaseTemplate	Self

typedef std::ostringstream	StopConditionDescriptionType

typedef std::string	StopConditionReturnStringType

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

const MetricValuesListType &	GetMetricValuesList () const

virtual const char *	GetNameOfClass () const

OptimizersListType &	GetOptimizersList ()

virtual const StopConditionType &	GetStopCondition () const override

virtual const StopConditionReturnStringType	GetStopConditionDescription () const override

virtual void	ResumeOptimization () override

void	SetOptimizersList (OptimizersListType &p)

virtual void	StartOptimization (bool doOnlyInitialization=false) override

virtual void	StopOptimization (void) override

Public Member Functions inherited from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >
virtual void	EstimateLearningRate ()

virtual const TInternalComputationValueType &	GetConvergenceValue () const

virtual const TInternalComputationValueType &	GetLearningRate () const

virtual const TInternalComputationValueType &	GetMaximumStepSizeInPhysicalUnits () const

virtual void	SetConvergenceWindowSize (SizeValueType _arg)

virtual void	SetLearningRate (TInternalComputationValueType _arg)

virtual void	SetMaximumStepSizeInPhysicalUnits (TInternalComputationValueType _arg)

virtual void	SetMinimumConvergenceValue (TInternalComputationValueType _arg)

virtual void	SetDoEstimateLearningRateAtEachIteration (bool _arg)

virtual const bool &	GetDoEstimateLearningRateAtEachIteration () const

virtual void	DoEstimateLearningRateAtEachIterationOn ()

virtual void	DoEstimateLearningRateAtEachIterationOff ()

virtual void	SetDoEstimateLearningRateOnce (bool _arg)

virtual const bool &	GetDoEstimateLearningRateOnce () const

virtual void	DoEstimateLearningRateOnceOn ()

virtual void	DoEstimateLearningRateOnceOff ()

virtual void	SetReturnBestParametersAndValue (bool _arg)

virtual const bool &	GetReturnBestParametersAndValue () const

virtual void	ReturnBestParametersAndValueOn ()

virtual void	ReturnBestParametersAndValueOff ()

Public Member Functions inherited from itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >
virtual SizeValueType	GetCurrentIteration () const override

virtual const DerivativeType &	GetGradient () const

virtual SizeValueType	GetNumberOfIterations () const override

virtual void	SetNumberOfIterations (const SizeValueType numberOfIterations) override

virtual void	ModifyGradientByScales ()

virtual void	ModifyGradientByLearningRate ()

Public Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
virtual const MeasureType &	GetCurrentMetricValue () const

virtual const ParametersType &	GetCurrentPosition () const

virtual const ThreadIdType &	GetNumberOfThreads () const

virtual const ScalesType &	GetScales () const

virtual const bool &	GetScalesAreIdentity () const

bool	GetScalesInitialized () const

virtual const MeasureType &	GetValue () const

virtual const ScalesType &	GetWeights () const

virtual const bool &	GetWeightsAreIdentity () const

virtual void	SetNumberOfThreads (ThreadIdType number)

virtual void	SetScalesEstimator (ScalesEstimatorType *_arg)

virtual void	SetWeights (ScalesType _arg)

virtual void	SetMetric (MetricType *_arg)

virtual MetricType *	GetModifiableMetric ()

virtual const MetricType *	GetMetric () const

virtual void	SetScales (const ScalesType &scales)

virtual void	SetDoEstimateScales (bool _arg)

virtual const bool &	GetDoEstimateScales () const

virtual void	DoEstimateScalesOn ()

virtual void	DoEstimateScalesOff ()

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

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	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 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::GradientDescentOptimizerv4Template< TInternalComputationValueType >
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
virtual void	PrintSelf (std::ostream &os, Indent indent) const override


	MultiGradientOptimizerv4Template ()

virtual	~MultiGradientOptimizerv4Template ()

Protected Member Functions inherited from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >
virtual void	AdvanceOneStep ()

	GradientDescentOptimizerv4Template ()

virtual	~GradientDescentOptimizerv4Template ()

virtual void	ModifyGradientByScalesOverSubRange (const IndexRangeType &subrange) override

virtual void	ModifyGradientByLearningRateOverSubRange (const IndexRangeType &subrange) override

Protected Member Functions inherited from itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >
	GradientDescentOptimizerBasev4Template ()

virtual	~GradientDescentOptimizerBasev4Template ()

Protected Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
	ObjectToObjectOptimizerBaseTemplate ()

virtual	~ObjectToObjectOptimizerBaseTemplate ()

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
MeasureType	m_MaximumMetricValue

MetricValuesListType	m_MetricValuesList

MeasureType	m_MinimumMetricValue

OptimizersListType	m_OptimizersList

bool	m_Stop

StopConditionType	m_StopCondition

StopConditionDescriptionType	m_StopConditionDescription

Protected Attributes inherited from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >
ParametersType	m_BestParameters

TInternalComputationValueType	m_ConvergenceValue

MeasureType	m_CurrentBestValue

TInternalComputationValueType	m_LearningRate

TInternalComputationValueType	m_MinimumConvergenceValue

DerivativeType	m_PreviousGradient

bool	m_ReturnBestParametersAndValue

Protected Attributes inherited from itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >
ConvergenceMonitoringType::Pointer	m_ConvergenceMonitoring

SizeValueType	m_ConvergenceWindowSize

bool	m_DoEstimateLearningRateAtEachIteration

bool	m_DoEstimateLearningRateOnce

DerivativeType	m_Gradient

TInternalComputationValueType	m_MaximumStepSizeInPhysicalUnits

DomainThreader < ThreadedIndexedContainerPartitioner, Self >::Pointer	m_ModifyGradientByLearningRateThreader

DomainThreader < ThreadedIndexedContainerPartitioner, Self >::Pointer	m_ModifyGradientByScalesThreader

bool	m_Stop

StopConditionType	m_StopCondition

StopConditionDescriptionType	m_StopConditionDescription

bool	m_UseConvergenceMonitoring

Protected Attributes inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
SizeValueType	m_CurrentIteration

MeasureType	m_CurrentMetricValue

bool	m_DoEstimateScales

MetricTypePointer	m_Metric

SizeValueType	m_NumberOfIterations

ThreadIdType	m_NumberOfThreads

ScalesType	m_Scales

bool	m_ScalesAreIdentity

ScalesEstimatorType::Pointer	m_ScalesEstimator

ScalesType	m_Weights

bool	m_WeightsAreIdentity

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Private Member Functions
	MultiGradientOptimizerv4Template (const Self &)

void	operator= (const Self &)

Member Typedef Documentation

template<typename TInternalComputationValueType >

typedef SmartPointer< const Self > itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::ConstPointer

Definition at line 54 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

typedef MetricType::DerivativeType itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::DerivativeType

Derivative type

Definition at line 86 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

typedef TInternalComputationValueType itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::InternalComputationValueType

It should be possible to derive the internal computation type from the class object.

Definition at line 79 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

typedef itk::GradientDescentOptimizerv4Template<TInternalComputationValueType>::Pointer itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::LocalOptimizerPointer

Definition at line 63 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

typedef itk::GradientDescentOptimizerv4Template<TInternalComputationValueType> itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::LocalOptimizerType

Definition at line 60 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

typedef Superclass::MeasureType itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::MeasureType

Measure type

Definition at line 89 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

typedef Superclass::MetricType itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::MetricType

Metric type over which this class is templated

Definition at line 82 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

typedef MetricType::Pointer itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::MetricTypePointer

Definition at line 83 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

typedef std::vector< MeasureType > itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::MetricValuesListType

Definition at line 90 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

typedef OptimizerType::Pointer itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::OptimizerPointer

Definition at line 66 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

typedef OptimizersListType::size_type itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::OptimizersListSizeType

Definition at line 68 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

typedef std::vector< LocalOptimizerPointer > itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::OptimizersListType

Definition at line 67 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

typedef ObjectToObjectOptimizerBaseTemplate<TInternalComputationValueType> itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::OptimizerType

Definition at line 65 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

typedef Superclass::ParametersType itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::ParametersType

Definition at line 64 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

typedef SmartPointer< Self > itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::Pointer

Definition at line 53 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

typedef MultiGradientOptimizerv4Template itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::Self

Standard class typedefs.

Definition at line 51 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

typedef Superclass::StopConditionDescriptionType itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::StopConditionDescriptionType

Stop condition internal string type

Definition at line 76 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

typedef Superclass::StopConditionReturnStringType itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::StopConditionReturnStringType

Stop condition return string type

Definition at line 73 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

typedef Superclass::StopConditionType itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::StopConditionType

Definition at line 70 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

typedef GradientDescentOptimizerv4Template<TInternalComputationValueType> itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::Superclass

Definition at line 52 of file itkMultiGradientOptimizerv4.h.

Constructor & Destructor Documentation

template<typename TInternalComputationValueType >

itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::MultiGradientOptimizerv4Template ( )

protected

Default constructor

template<typename TInternalComputationValueType >

virtual itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::~MultiGradientOptimizerv4Template ( )

protectedvirtual

Default constructor

template<typename TInternalComputationValueType >

itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::MultiGradientOptimizerv4Template ( const Self & )

private

Member Function Documentation

template<typename TInternalComputationValueType >

virtual::itk::LightObject::Pointer itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::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::GradientDescentOptimizerv4Template< TInternalComputationValueType >.

template<typename TInternalComputationValueType >

const MetricValuesListType& itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::GetMetricValuesList ( ) const

Get the list of metric values that we produced after the multi-objective search.

template<typename TInternalComputationValueType >

virtual const char* itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >.

template<typename TInternalComputationValueType >

OptimizersListType& itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::GetOptimizersList ( )

Get the list of optimizers currently held.

template<typename TInternalComputationValueType >

virtual const StopConditionType& itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::GetStopCondition ( ) const

inlineoverridevirtual

Get stop condition enum

Reimplemented from itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >.

Definition at line 93 of file itkMultiGradientOptimizerv4.h.

References itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::m_StopCondition.

template<typename TInternalComputationValueType >

virtual const StopConditionReturnStringType itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::GetStopConditionDescription ( ) const

overridevirtual

Get the reason for termination

Reimplemented from itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >.

template<typename TInternalComputationValueType >

static Pointer itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::New ( )

static

Method for creation through the object factory.

template<typename TInternalComputationValueType >

void itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::operator= ( const Self & )

private

template<typename TInternalComputationValueType >

virtual void itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::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::GradientDescentOptimizerv4Template< TInternalComputationValueType >.

template<typename TInternalComputationValueType >

virtual void itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::ResumeOptimization ( )

overridevirtual

Resume the optimization. Can be called after StopOptimization to resume. The bulk of the optimization work loop is here.

Reimplemented from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >.

template<typename TInternalComputationValueType >

void itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::SetOptimizersList ( OptimizersListType & p )

Set the list of optimizers to combine

template<typename TInternalComputationValueType >

virtual void itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::StartOptimization ( bool doOnlyInitialization = false )

overridevirtual

Begin the optimization

Reimplemented from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >.

template<typename TInternalComputationValueType >

virtual void itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::StopOptimization ( void )

overridevirtual

Stop optimization. The object is left in a state so the optimization can be resumed by calling ResumeOptimization.

Reimplemented from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >.

Member Data Documentation

template<typename TInternalComputationValueType >

MeasureType itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::m_MaximumMetricValue

protected

Definition at line 137 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

MetricValuesListType itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::m_MetricValuesList

protected

Definition at line 135 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

MeasureType itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::m_MinimumMetricValue

protected

Definition at line 136 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

OptimizersListType itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::m_OptimizersList

protected

Definition at line 134 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

bool itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::m_Stop

protected

Definition at line 131 of file itkMultiGradientOptimizerv4.h.

template<typename TInternalComputationValueType >

StopConditionType itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::m_StopCondition

protected

Definition at line 132 of file itkMultiGradientOptimizerv4.h.

Referenced by itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::GetStopCondition().

template<typename TInternalComputationValueType >

StopConditionDescriptionType itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::m_StopConditionDescription

protected

Definition at line 133 of file itkMultiGradientOptimizerv4.h.

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

itkMultiGradientOptimizerv4.h

Detailed Description

template<typename TInternalComputationValueType> class itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename TInternalComputationValueType>
class itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >