#include <itkConjugateGradientLineSearchOptimizerv4.h>

Inheritance diagram for itk::ConjugateGradientLineSearchOptimizerv4:

Collaboration diagram for itk::ConjugateGradientLineSearchOptimizerv4:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef itk::Function::WindowConvergenceMonitoringFunction < double >	ConvergenceMonitoringType
typedef Superclass::DerivativeType	DerivativeType
typedef Superclass::InternalComputationValueType	InternalComputationValueType
typedef Superclass::MeasureType	MeasureType
typedef SmartPointer< Self >	Pointer
typedef ConjugateGradientLineSearchOptimizerv4	Self
typedef GradientDescentOptimizerv4	Superclass
Public Types inherited from itk::GradientDescentLineSearchOptimizerv4
Public Types inherited from itk::GradientDescentOptimizerv4
Public Types inherited from itk::GradientDescentOptimizerBasev4
typedef Superclass::MetricType	MetricType
typedef MetricType::Pointer	MetricTypePointer
typedef std::ostringstream	StopConditionDescriptionType
typedef std::string	StopConditionReturnStringType
enum	StopConditionType { MAXIMUM_NUMBER_OF_ITERATIONS, COSTFUNCTION_ERROR, UPDATE_PARAMETERS_ERROR, STEP_TOO_SMALL, QUASI_NEWTON_STEP_ERROR, CONVERGENCE_CHECKER_PASSED, OTHER_ERROR }
Public Types inherited from itk::ObjectToObjectOptimizerBase
typedef MetricType::NumberOfParametersType	NumberOfParametersType
typedef OptimizerParameters < double >	ParametersType
typedef OptimizerParameters < double >	ScalesType
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
virtual void	StartOptimization ()
Public Member Functions inherited from itk::GradientDescentLineSearchOptimizerv4
virtual void	SetEpsilon (InternalComputationValueType _arg)
virtual InternalComputationValueType	GetEpsilon ()
virtual void	SetLowerLimit (InternalComputationValueType _arg)
virtual InternalComputationValueType	GetLowerLimit ()
virtual void	SetUpperLimit (InternalComputationValueType _arg)
virtual InternalComputationValueType	GetUpperLimit ()
virtual void	SetMaximumLineSearchIterations (unsigned int _arg)
virtual unsigned int	GetMaximumLineSearchIterations ()
Public Member Functions inherited from itk::GradientDescentOptimizerv4
virtual void	EstimateLearningRate ()
virtual const InternalComputationValueType &	GetConvergenceValue ()
virtual const InternalComputationValueType &	GetLearningRate ()
virtual const InternalComputationValueType &	GetMaximumStepSizeInPhysicalUnits ()
virtual void	ResumeOptimization ()
virtual void	SetConvergenceWindowSize (SizeValueType _arg)
virtual void	SetLearningRate (InternalComputationValueType _arg)
virtual void	SetMaximumStepSizeInPhysicalUnits (InternalComputationValueType _arg)
virtual void	SetMinimumConvergenceValue (InternalComputationValueType _arg)
virtual void	SetScalesEstimator (OptimizerParameterScalesEstimator *_arg)
virtual void	StopOptimization (void)
virtual void	SetDoEstimateScales (bool _arg)
virtual const bool &	GetDoEstimateScales ()
virtual void	DoEstimateScalesOn ()
virtual void	DoEstimateScalesOff ()
virtual void	SetDoEstimateLearningRateAtEachIteration (bool _arg)
virtual const bool &	GetDoEstimateLearningRateAtEachIteration ()
virtual void	DoEstimateLearningRateAtEachIterationOn ()
virtual void	DoEstimateLearningRateAtEachIterationOff ()
virtual void	SetDoEstimateLearningRateOnce (bool _arg)
virtual const bool &	GetDoEstimateLearningRateOnce ()
virtual void	DoEstimateLearningRateOnceOn ()
virtual void	DoEstimateLearningRateOnceOff ()
virtual void	SetReturnBestParametersAndValue (bool _arg)
virtual const bool &	GetReturnBestParametersAndValue ()
virtual void	ReturnBestParametersAndValueOn ()
virtual void	ReturnBestParametersAndValueOff ()
Public Member Functions inherited from itk::GradientDescentOptimizerBasev4
virtual SizeValueType	GetCurrentIteration () const
virtual const DerivativeType &	GetGradient ()
virtual const SizeValueType &	GetNumberOfIterations ()
virtual const StopConditionType &	GetStopCondition ()
virtual const StopConditionReturnStringType	GetStopConditionDescription () const
virtual void	SetNumberOfIterations (SizeValueType _arg)
virtual void	ModifyGradientByScales ()
virtual void	ModifyGradientByLearningRate ()
Public Member Functions inherited from itk::ObjectToObjectOptimizerBase
virtual const MeasureType &	GetCurrentMetricValue ()
const ParametersType &	GetCurrentPosition ()
virtual const ThreadIdType &	GetNumberOfThreads ()
virtual const ScalesType &	GetScales ()
virtual const bool &	GetScalesAreIdentity ()
const MeasureType &	GetValue ()
virtual void	SetNumberOfThreads (ThreadIdType number)
virtual void	SetScales (ScalesType _arg)
virtual MetricType *	GetMetric ()
virtual void	SetMetric (MetricType *_arg)
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 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

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
virtual void	AdvanceOneStep (void)
	ConjugateGradientLineSearchOptimizerv4 ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~ConjugateGradientLineSearchOptimizerv4 ()
Protected Member Functions inherited from itk::GradientDescentLineSearchOptimizerv4
InternalComputationValueType	GoldenSectionSearch (InternalComputationValueType a, InternalComputationValueType b, InternalComputationValueType c)
	GradientDescentLineSearchOptimizerv4 ()
virtual	~GradientDescentLineSearchOptimizerv4 ()
Protected Member Functions inherited from itk::GradientDescentOptimizerv4
	GradientDescentOptimizerv4 ()
virtual	~GradientDescentOptimizerv4 ()
virtual void	ModifyGradientByScalesOverSubRange (const IndexRangeType &subrange)
virtual void	ModifyGradientByLearningRateOverSubRange (const IndexRangeType &subrange)
Protected Member Functions inherited from itk::GradientDescentOptimizerBasev4
	GradientDescentOptimizerBasev4 ()
virtual	~GradientDescentOptimizerBasev4 ()
Protected Member Functions inherited from itk::ObjectToObjectOptimizerBase
	ObjectToObjectOptimizerBase ()
virtual	~ObjectToObjectOptimizerBase ()
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
	ConjugateGradientLineSearchOptimizerv4 (const Self &)
void	operator= (const Self &)

Private Attributes
DerivativeType	m_ConjugateGradient
DerivativeType	m_LastGradient

Additional Inherited Members
Protected Attributes inherited from itk::GradientDescentLineSearchOptimizerv4
InternalComputationValueType	m_Epsilon
unsigned int	m_LineSearchIterations
InternalComputationValueType	m_LowerLimit
unsigned int	m_MaximumLineSearchIterations
InternalComputationValueType	m_Phi
InternalComputationValueType	m_Resphi
InternalComputationValueType	m_UpperLimit
Protected Attributes inherited from itk::GradientDescentOptimizerv4
ParametersType	m_BestParameters
ConvergenceMonitoringType::Pointer	m_ConvergenceMonitoring
InternalComputationValueType	m_ConvergenceValue
SizeValueType	m_ConvergenceWindowSize
MeasureType	m_CurrentBestValue
InternalComputationValueType	m_LearningRate
InternalComputationValueType	m_MaximumStepSizeInPhysicalUnits
InternalComputationValueType	m_MinimumConvergenceValue
bool	m_ReturnBestParametersAndValue
OptimizerParameterScalesEstimator::Pointer	m_ScalesEstimator
Protected Attributes inherited from itk::GradientDescentOptimizerBasev4
SizeValueType	m_CurrentIteration
DerivativeType	m_Gradient
GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreader::Pointer	m_ModifyGradientByLearningRateThreader
GradientDescentOptimizerBasev4ModifyGradientByScalesThreader::Pointer	m_ModifyGradientByScalesThreader
SizeValueType	m_NumberOfIterations
bool	m_Stop
StopConditionType	m_StopCondition
StopConditionDescriptionType	m_StopConditionDescription
Protected Attributes inherited from itk::ObjectToObjectOptimizerBase
MeasureType	m_CurrentMetricValue
MetricTypePointer	m_Metric
ThreadIdType	m_NumberOfThreads
ScalesType	m_Scales
bool	m_ScalesAreIdentity

Detailed Description

Conjugate gradient descent optimizer with a golden section line search for nonlinear optimization.

ConjugateGradientLineSearchOptimizer implements a conjugate gradient descent optimizer that is followed by a line search to find the best value for the learning rate. At each iteration the current position is updated according to

$p_{n+1} = p_n + \mbox{learningRateByGoldenSectionLineSearch} \, d$

where d is defined as the Polak-Ribiere conjugate gradient.

Options are identical to the superclass's.

Definition at line 46 of file itkConjugateGradientLineSearchOptimizerv4.h.

Member Typedef Documentation

typedef SmartPointer< const Self > itk::ConjugateGradientLineSearchOptimizerv4::ConstPointer

Reimplemented from itk::GradientDescentLineSearchOptimizerv4.

Definition at line 54 of file itkConjugateGradientLineSearchOptimizerv4.h.

typedef itk::Function::WindowConvergenceMonitoringFunction<double> itk::ConjugateGradientLineSearchOptimizerv4::ConvergenceMonitoringType

Type for the convergence checker

Reimplemented from itk::GradientDescentLineSearchOptimizerv4.

Definition at line 70 of file itkConjugateGradientLineSearchOptimizerv4.h.

typedef Superclass::DerivativeType itk::ConjugateGradientLineSearchOptimizerv4::DerivativeType

Derivative type

Reimplemented from itk::GradientDescentLineSearchOptimizerv4.

Definition at line 60 of file itkConjugateGradientLineSearchOptimizerv4.h.

typedef Superclass::InternalComputationValueType itk::ConjugateGradientLineSearchOptimizerv4::InternalComputationValueType

Internal computation type, for maintaining a desired precision

Reimplemented from itk::GradientDescentLineSearchOptimizerv4.

Definition at line 67 of file itkConjugateGradientLineSearchOptimizerv4.h.

typedef Superclass::MeasureType itk::ConjugateGradientLineSearchOptimizerv4::MeasureType

Metric type over which this class is templated

Reimplemented from itk::GradientDescentLineSearchOptimizerv4.

Definition at line 66 of file itkConjugateGradientLineSearchOptimizerv4.h.

typedef SmartPointer< Self > itk::ConjugateGradientLineSearchOptimizerv4::Pointer

Reimplemented from itk::GradientDescentLineSearchOptimizerv4.

Definition at line 53 of file itkConjugateGradientLineSearchOptimizerv4.h.

typedef ConjugateGradientLineSearchOptimizerv4 itk::ConjugateGradientLineSearchOptimizerv4::Self

Standard class typedefs.

Reimplemented from itk::GradientDescentLineSearchOptimizerv4.

Definition at line 51 of file itkConjugateGradientLineSearchOptimizerv4.h.

typedef GradientDescentOptimizerv4 itk::ConjugateGradientLineSearchOptimizerv4::Superclass

Reimplemented from itk::GradientDescentLineSearchOptimizerv4.

Definition at line 52 of file itkConjugateGradientLineSearchOptimizerv4.h.

Constructor & Destructor Documentation

itk::ConjugateGradientLineSearchOptimizerv4::ConjugateGradientLineSearchOptimizerv4 ( )

protected

Default constructor

virtual itk::ConjugateGradientLineSearchOptimizerv4::~ConjugateGradientLineSearchOptimizerv4 ( )

protectedvirtual

Destructor

itk::ConjugateGradientLineSearchOptimizerv4::ConjugateGradientLineSearchOptimizerv4 ( const Self & )

private

Member Function Documentation

virtual void itk::ConjugateGradientLineSearchOptimizerv4::AdvanceOneStep ( void )

protectedvirtual

Advance one Step following the gradient direction. Includes transform update.

Reimplemented from itk::GradientDescentLineSearchOptimizerv4.

virtual::itk::LightObject::Pointer itk::ConjugateGradientLineSearchOptimizerv4::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::GradientDescentLineSearchOptimizerv4.

virtual const char* itk::ConjugateGradientLineSearchOptimizerv4::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::GradientDescentLineSearchOptimizerv4.

static Pointer itk::ConjugateGradientLineSearchOptimizerv4::New ( )

static

New macro for creation of through a Smart Pointer

Reimplemented from itk::GradientDescentLineSearchOptimizerv4.

void itk::ConjugateGradientLineSearchOptimizerv4::operator= ( const Self & )

private

Mutex lock to protect modification to the reference count

Reimplemented from itk::GradientDescentLineSearchOptimizerv4.

virtual void itk::ConjugateGradientLineSearchOptimizerv4::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtual

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::GradientDescentLineSearchOptimizerv4.

virtual void itk::ConjugateGradientLineSearchOptimizerv4::StartOptimization ( )

virtual

Start and run the optimization

Reimplemented from itk::GradientDescentOptimizerv4.