#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 (void) const

const MetricValuesListType &	GetMetricValuesList () const

virtual const char *	GetNameOfClass () const

OptimizersListType &	GetOptimizersList ()

virtual const StopConditionType &	GetStopCondition () const

virtual const StopConditionReturnStringType	GetStopConditionDescription () const ITK_OVERRIDE

virtual void	ResumeOptimization ()

void	SetOptimizersList (OptimizersListType &p)

virtual void	StartOptimization (bool doOnlyInitialization=false)

virtual void	StopOptimization (void)

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

virtual const DerivativeType &	GetGradient () const

virtual SizeValueType	GetNumberOfIterations () const

virtual void	SetNumberOfIterations (SizeValueType _arg)

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

const MetaDataDictionary &	GetMetaDataDictionary (void) 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 ITK_OVERRIDE

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) ITK_OVERRIDE

virtual void	UnRegister () const ITK_OVERRIDE

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


	MultiGradientOptimizerv4Template ()

virtual	~MultiGradientOptimizerv4Template ()

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

	GradientDescentOptimizerv4Template ()

virtual	~GradientDescentOptimizerv4Template ()

virtual void	ModifyGradientByScalesOverSubRange (const IndexRangeType &subrange) ITK_OVERRIDE

virtual void	ModifyGradientByLearningRateOverSubRange (const IndexRangeType &subrange) ITK_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
InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock

Private Member Functions
	MultiGradientOptimizerv4Template (const Self &)

void	operator= (const Self &)

Additional Inherited Members
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType