#include <elxQuasiNewtonLBFGS.h>

Detailed Description

template<class TElastix>
class elastix::QuasiNewtonLBFGS< TElastix >

An optimizer based on the itk::QuasiNewtonLBFGSOptimizer.

The QuasiNewtonLBFGS class is a wrap around the QuasiNewtonLBFGSOptimizer. It uses the itk::MoreThuenteLineSearchOptimizer. Please read the documentation of these classes to find out more about it.

This optimizer supports the NewSamplesEveryIteration option. It requests new samples for the computation of each search direction (not during the line search). Actually this makes no sense for a QuasiNewton optimizer. So, think twice before using the NewSamplesEveryIteration option.

The parameters used in this class are:

Parameters:

Optimizer: Select this optimizer as follows:
(Optimizer "QuasiNewtonLBFGS")

GenerateLineSearchIterations: Whether line search iteration should be counted as elastix-iterations.
example: (GenerateLineSearchIterations "true")
Can only be specified for all resolutions at once.
Default value: "false".

MaximumNumberOfIterations: The maximum number of iterations in each resolution.
example: (MaximumNumberOfIterations 100 100 50)
Default value: 100.

MaximumNumberOfLineSearchIterations: The maximum number of line search iterations in each resolution.
example: (MaximumNumberOfLineSearchIterations 10 10 5)
Default value: 20.

StepLength: Set the length of the initial step tried by the itk::MoreThuenteLineSearchOptimizer.
example: (StepLength 2.0 1.0 0.5)
Default value: 1.0.

LineSearchValueTolerance: Determine the Wolfe conditions that the itk::MoreThuenteLineSearchOptimizer tries to satisfy.
example: (LineSearchValueTolerance 0.0001 0.0001 0.0001)
Default value: 0.0001.

LineSearchGradientTolerance: Determine the Wolfe conditions that the itk::MoreThuenteLineSearchOptimizer tries to satisfy.
example: (LineSearchGradientTolerance 0.9 0.9 0.9)
Default value: 0.9.

GradientMagnitudeTolerance: Stopping criterion. See the documentation of the itk::QuasiNewtonLBFGSOptimizer for more information.
example: (GradientMagnitudeTolerance 0.001 0.0001 0.000001)
Default value: 0.000001.

LBFGSUpdateAccuracy: The "memory" of the optimizer. This determines how many past iterations are used to construct the Hessian approximation. The higher, the more memory is used, but the better the Hessian approximation. If set to zero, The QuasiNewtonLBFGS equals a gradient descent method with line search.
example: (LBFGSUpdateAccuracy 5 10 20)
Default value: 5.

StopIfWolfeNotSatisfied: Whether to stop the optimisation if in one iteration the Wolfe conditions can not be satisfied by the itk::MoreThuenteLineSearchOptimizer.
In general it is wise to do so.
example: (StopIfWolfeNotSatisfied "true" "false")
Default value: "true".

Definition at line 88 of file elxQuasiNewtonLBFGS.h.

Inheritance diagram for elastix::QuasiNewtonLBFGS< TElastix >:

Public Types
typedef Superclass2::ConfigurationPointer	ConfigurationPointer

typedef Superclass2::ConfigurationType	ConfigurationType

typedef itk::SmartPointer< const Self >	ConstPointer

typedef Superclass1::CostFunctionPointer	CostFunctionPointer

typedef Superclass1::CostFunctionType	CostFunctionType

typedef Superclass1::DerivativeType	DerivativeType

typedef Superclass2::ElastixPointer	ElastixPointer

typedef Superclass2::ElastixType	ElastixType

typedef EventPassThroughType::Pointer	EventPassThroughPointer

typedef itk::ReceptorMemberCommand< Self >	EventPassThroughType

typedef Superclass2::ITKBaseType	ITKBaseType

typedef LineOptimizerType::Pointer	LineOptimizerPointer

typedef itk::MoreThuenteLineSearchOptimizer	LineOptimizerType

typedef Superclass1::ParametersType	ParametersType

typedef itk::SmartPointer< Self >	Pointer

typedef Superclass2::RegistrationPointer	RegistrationPointer

typedef Superclass2::RegistrationType	RegistrationType

typedef Superclass1::ScalesType	ScalesType

typedef QuasiNewtonLBFGS	Self

typedef Superclass1::StopConditionType	StopConditionType

typedef QuasiNewtonLBFGSOptimizer	Superclass1

typedef OptimizerBase< TElastix >	Superclass2

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

typedef Superclass::CostFunctionType	CostFunctionType

typedef Superclass::DerivativeType	DerivativeType

typedef Array< double >	DiagonalMatrixType

typedef LineSearchOptimizerType::Pointer	LineSearchOptimizerPointer

typedef LineSearchOptimizer	LineSearchOptimizerType

typedef Superclass::MeasureType	MeasureType

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

typedef Array< double >	RhoType

typedef Superclass::ScaledCostFunctionType	ScaledCostFunctionType

typedef Superclass::ScalesType	ScalesType

typedef QuasiNewtonLBFGSOptimizer	Self

enum	StopConditionType { MetricError , LineSearchError , MaximumNumberOfIterations , InvalidDiagonalMatrix , GradientMagnitudeTolerance , ZeroStep , Unknown }

typedef std::vector< ParametersType >	SType

typedef ScaledSingleValuedNonLinearOptimizer	Superclass

typedef std::vector< DerivativeType >	YType

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

typedef Superclass::CostFunctionType	CostFunctionType

typedef Superclass::DerivativeType	DerivativeType

typedef Superclass::MeasureType	MeasureType

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

typedef ScaledCostFunctionType::Pointer	ScaledCostFunctionPointer

typedef ScaledSingleValuedCostFunction	ScaledCostFunctionType

typedef NonLinearOptimizer::ScalesType	ScalesType

typedef ScaledSingleValuedNonLinearOptimizer	Self

typedef SingleValuedNonLinearOptimizer	Superclass

Public Types inherited from elastix::OptimizerBase< TElastix >
typedef Superclass::ConfigurationPointer	ConfigurationPointer

typedef Superclass::ConfigurationType	ConfigurationType

typedef Superclass::ElastixPointer	ElastixPointer

typedef Superclass::ElastixType	ElastixType

typedef itk::Optimizer	ITKBaseType

typedef ITKBaseType::ParametersType	ParametersType

typedef Superclass::RegistrationPointer	RegistrationPointer

typedef Superclass::RegistrationType	RegistrationType

typedef OptimizerBase	Self

typedef BaseComponentSE< TElastix >	Superclass

Public Types inherited from elastix::BaseComponentSE< TElastix >
typedef Configuration::Pointer	ConfigurationPointer

typedef Configuration	ConfigurationType

typedef itk::WeakPointer< ElastixType >	ElastixPointer

typedef TElastix	ElastixType

typedef RegistrationType *	RegistrationPointer

typedef ElastixType::RegistrationBaseType	RegistrationType

typedef BaseComponentSE	Self

typedef BaseComponent	Superclass

Public Member Functions
void	AfterEachIteration (void) override

void	AfterEachResolution (void) override

void	AfterRegistration (void) override

void	BeforeEachResolution (void) override

void	BeforeRegistration (void) override

	elxClassNameMacro ("QuasiNewtonLBFGS")

virtual const char *	GetClassName () const

virtual bool	GetStartLineSearch () const

void	StartOptimization (void) override

Public Member Functions inherited from itk::QuasiNewtonLBFGSOptimizer
virtual const char *	GetClassName () const

virtual const DerivativeType &	GetCurrentGradient ()

virtual unsigned long	GetCurrentIteration () const

virtual double	GetCurrentStepLength () const

virtual MeasureType	GetCurrentValue () const

virtual double	GetGradientMagnitudeTolerance () const

virtual bool	GetInLineSearch () const

virtual unsigned long	GetMaximumNumberOfIterations () const

virtual unsigned int	GetMemory () const

virtual const StopConditionType &	GetStopCondition ()

	itkGetModifiableObjectMacro (LineSearchOptimizer, LineSearchOptimizerType)

virtual void	ResumeOptimization (void)

virtual void	SetGradientMagnitudeTolerance (double _arg)

virtual void	SetLineSearchOptimizer (LineSearchOptimizerType *_arg)

virtual void	SetMaximumNumberOfIterations (unsigned long _arg)

virtual void	SetMemory (unsigned int _arg)

void	StartOptimization (void) override

virtual void	StopOptimization (void)

Public Member Functions inherited from itk::ScaledSingleValuedNonLinearOptimizer
virtual const char *	GetClassName () const

const ParametersType &	GetCurrentPosition (void) const override

virtual bool	GetMaximize () const

virtual const ScaledCostFunctionType *	GetScaledCostFunction ()

virtual const ParametersType &	GetScaledCurrentPosition ()

bool	GetUseScales (void) const

virtual void	InitializeScales (void)

virtual void	MaximizeOff ()

virtual void	MaximizeOn ()

void	SetCostFunction (CostFunctionType *costFunction) override

virtual void	SetMaximize (bool _arg)

virtual void	SetUseScales (bool arg)

Public Member Functions inherited from elastix::OptimizerBase< TElastix >
void	AfterRegistrationBase (void) override

void	BeforeEachResolutionBase () override

virtual ITKBaseType *	GetAsITKBaseType (void)

virtual const ITKBaseType *	GetAsITKBaseType (void) const

virtual const char *	GetClassName () const

virtual void	SetCurrentPositionPublic (const ParametersType &param)

virtual void	SetSinusScales (double amplitude, double frequency, unsigned long numberOfParameters)

Public Member Functions inherited from elastix::BaseComponentSE< TElastix >
ConfigurationType *	GetConfiguration (void) const

ElastixType *	GetElastix (void) const

RegistrationPointer	GetRegistration (void) const

	ITK_DISALLOW_COPY_AND_ASSIGN (BaseComponentSE)

void	SetConfiguration (ConfigurationType *_arg)

void	SetElastix (ElastixType *_arg)

Public Member Functions inherited from elastix::BaseComponent
virtual void	AfterEachIteration (void)

virtual void	AfterEachIterationBase (void)

virtual void	AfterEachResolution (void)

virtual void	AfterEachResolutionBase (void)

virtual void	AfterRegistration (void)

virtual void	AfterRegistrationBase (void)

virtual int	BeforeAll (void)

virtual int	BeforeAllBase (void)

virtual void	BeforeEachResolution (void)

virtual void	BeforeEachResolutionBase (void)

virtual void	BeforeRegistration (void)

virtual void	BeforeRegistrationBase (void)

virtual const char *	elxGetClassName (void) const

const char *	GetComponentLabel (void) const

	ITK_DISALLOW_COPY_AND_ASSIGN (BaseComponent)

	itkTypeMacroNoParent (BaseComponent)

void	SetComponentLabel (const char *label, unsigned int idx)

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::QuasiNewtonLBFGSOptimizer
static Pointer	New ()

Static Public Member Functions inherited from itk::ScaledSingleValuedNonLinearOptimizer
static Pointer	New ()

Static Public Member Functions inherited from elastix::BaseComponent
static std::string	ConvertSecondsToDHMS (const double totalSeconds, const unsigned int precision)

static void	InitializeElastixExecutable ()

static bool	IsElastixLibrary ()

Protected Member Functions
virtual std::string	DeterminePhase (void) const

virtual std::string	GetLineSearchStopCondition (void) const

void	LineSearch (const ParametersType searchDir, double &step, ParametersType &x, MeasureType &f, DerivativeType &g) override

	QuasiNewtonLBFGS ()

bool	TestConvergence (bool firstLineSearchDone) override

	~QuasiNewtonLBFGS () override

Protected Member Functions inherited from itk::QuasiNewtonLBFGSOptimizer
virtual void	ComputeDiagonalMatrix (DiagonalMatrixType &diag_H0)

virtual void	ComputeSearchDirection (const DerivativeType &gradient, ParametersType &searchDir)

virtual void	LineSearch (const ParametersType searchDir, double &step, ParametersType &x, MeasureType &f, DerivativeType &g)

void	PrintSelf (std::ostream &os, Indent indent) const override

	QuasiNewtonLBFGSOptimizer ()

virtual void	SetInLineSearch (bool _arg)

virtual void	StoreCurrentPoint (const ParametersType &step, const DerivativeType &grad_dif)

virtual bool	TestConvergence (bool firstLineSearchDone)

	~QuasiNewtonLBFGSOptimizer () override

Protected Member Functions inherited from itk::ScaledSingleValuedNonLinearOptimizer
virtual void	GetScaledDerivative (const ParametersType &parameters, DerivativeType &derivative) const

virtual MeasureType	GetScaledValue (const ParametersType &parameters) const

virtual void	GetScaledValueAndDerivative (const ParametersType &parameters, MeasureType &value, DerivativeType &derivative) const

void	PrintSelf (std::ostream &os, Indent indent) const override

	ScaledSingleValuedNonLinearOptimizer ()

void	SetCurrentPosition (const ParametersType &param) override

virtual void	SetScaledCurrentPosition (const ParametersType &parameters)

	~ScaledSingleValuedNonLinearOptimizer () override

Protected Member Functions inherited from elastix::OptimizerBase< TElastix >
virtual bool	GetNewSamplesEveryIteration (void) const

	OptimizerBase ()

virtual void	SelectNewSamples (void)

	~OptimizerBase () override

Protected Member Functions inherited from elastix::BaseComponentSE< TElastix >
	BaseComponentSE ()=default

	~BaseComponentSE () override=default

Protected Member Functions inherited from elastix::BaseComponent
	BaseComponent ()=default

virtual	~BaseComponent ()=default

Protected Attributes
LineOptimizerPointer	m_LineOptimizer

Protected Attributes inherited from itk::QuasiNewtonLBFGSOptimizer
unsigned int	m_Bound

DerivativeType	m_CurrentGradient

unsigned long	m_CurrentIteration

double	m_CurrentStepLength

MeasureType	m_CurrentValue

bool	m_InLineSearch

unsigned int	m_Point

unsigned int	m_PreviousPoint

RhoType	m_Rho

SType	m_S

bool	m_Stop

StopConditionType	m_StopCondition

YType	m_Y

Protected Attributes inherited from itk::ScaledSingleValuedNonLinearOptimizer
ScaledCostFunctionPointer	m_ScaledCostFunction

ParametersType	m_ScaledCurrentPosition

Protected Attributes inherited from elastix::BaseComponentSE< TElastix >
ConfigurationPointer	m_Configuration {}

ElastixPointer	m_Elastix {}

RegistrationPointer	m_Registration {}

Private Member Functions
void	InvokeIterationEvent (const itk::EventObject &event)

void	operator= (const Self &)

	QuasiNewtonLBFGS (const Self &)

Private Attributes
EventPassThroughPointer	m_EventPasser

bool	m_GenerateLineSearchIterations

double	m_SearchDirectionMagnitude

bool	m_StartLineSearch

bool	m_StopIfWolfeNotSatisfied

bool	m_WolfeIsStopCondition

Member Typedef Documentation

◆ ConfigurationPointer

template<class TElastix >

typedef Superclass2::ConfigurationPointer elastix::QuasiNewtonLBFGS< TElastix >::ConfigurationPointer

Definition at line 127 of file elxQuasiNewtonLBFGS.h.

◆ ConfigurationType

template<class TElastix >

typedef Superclass2::ConfigurationType elastix::QuasiNewtonLBFGS< TElastix >::ConfigurationType

Definition at line 126 of file elxQuasiNewtonLBFGS.h.

◆ ConstPointer

template<class TElastix >

typedef itk::SmartPointer< const Self > elastix::QuasiNewtonLBFGS< TElastix >::ConstPointer

Definition at line 101 of file elxQuasiNewtonLBFGS.h.

◆ CostFunctionPointer

template<class TElastix >

typedef Superclass1::CostFunctionPointer elastix::QuasiNewtonLBFGS< TElastix >::CostFunctionPointer

Definition at line 117 of file elxQuasiNewtonLBFGS.h.

◆ CostFunctionType

template<class TElastix >

typedef Superclass1::CostFunctionType elastix::QuasiNewtonLBFGS< TElastix >::CostFunctionType

Typedef's inherited from Superclass1.

Definition at line 116 of file elxQuasiNewtonLBFGS.h.

◆ DerivativeType

template<class TElastix >

typedef Superclass1::DerivativeType elastix::QuasiNewtonLBFGS< TElastix >::DerivativeType

Definition at line 120 of file elxQuasiNewtonLBFGS.h.

◆ ElastixPointer

template<class TElastix >

typedef Superclass2::ElastixPointer elastix::QuasiNewtonLBFGS< TElastix >::ElastixPointer

Definition at line 125 of file elxQuasiNewtonLBFGS.h.

◆ ElastixType

template<class TElastix >

typedef Superclass2::ElastixType elastix::QuasiNewtonLBFGS< TElastix >::ElastixType

Typedef's inherited from Elastix.

Definition at line 124 of file elxQuasiNewtonLBFGS.h.

◆ EventPassThroughPointer

template<class TElastix >

typedef EventPassThroughType::Pointer elastix::QuasiNewtonLBFGS< TElastix >::EventPassThroughPointer

Definition at line 136 of file elxQuasiNewtonLBFGS.h.

◆ EventPassThroughType

template<class TElastix >

typedef itk::ReceptorMemberCommand< Self > elastix::QuasiNewtonLBFGS< TElastix >::EventPassThroughType

Definition at line 135 of file elxQuasiNewtonLBFGS.h.

◆ ITKBaseType

template<class TElastix >

typedef Superclass2::ITKBaseType elastix::QuasiNewtonLBFGS< TElastix >::ITKBaseType

Definition at line 130 of file elxQuasiNewtonLBFGS.h.

◆ LineOptimizerPointer

template<class TElastix >

typedef LineOptimizerType::Pointer elastix::QuasiNewtonLBFGS< TElastix >::LineOptimizerPointer

Definition at line 134 of file elxQuasiNewtonLBFGS.h.

◆ LineOptimizerType

template<class TElastix >

typedef itk::MoreThuenteLineSearchOptimizer elastix::QuasiNewtonLBFGS< TElastix >::LineOptimizerType

Extra typedefs

Definition at line 133 of file elxQuasiNewtonLBFGS.h.

◆ ParametersType

template<class TElastix >

typedef Superclass1::ParametersType elastix::QuasiNewtonLBFGS< TElastix >::ParametersType

Definition at line 119 of file elxQuasiNewtonLBFGS.h.

◆ Pointer

template<class TElastix >

typedef itk::SmartPointer< Self > elastix::QuasiNewtonLBFGS< TElastix >::Pointer

Definition at line 100 of file elxQuasiNewtonLBFGS.h.

◆ RegistrationPointer

template<class TElastix >

typedef Superclass2::RegistrationPointer elastix::QuasiNewtonLBFGS< TElastix >::RegistrationPointer

Definition at line 129 of file elxQuasiNewtonLBFGS.h.

◆ RegistrationType

template<class TElastix >

typedef Superclass2::RegistrationType elastix::QuasiNewtonLBFGS< TElastix >::RegistrationType

Definition at line 128 of file elxQuasiNewtonLBFGS.h.

◆ ScalesType

template<class TElastix >

typedef Superclass1::ScalesType elastix::QuasiNewtonLBFGS< TElastix >::ScalesType

Definition at line 121 of file elxQuasiNewtonLBFGS.h.

◆ Self

template<class TElastix >

typedef QuasiNewtonLBFGS elastix::QuasiNewtonLBFGS< TElastix >::Self

Standard ITK.

Definition at line 97 of file elxQuasiNewtonLBFGS.h.

◆ StopConditionType

template<class TElastix >

typedef Superclass1::StopConditionType elastix::QuasiNewtonLBFGS< TElastix >::StopConditionType

Definition at line 118 of file elxQuasiNewtonLBFGS.h.

◆ Superclass1

template<class TElastix >

typedef QuasiNewtonLBFGSOptimizer elastix::QuasiNewtonLBFGS< TElastix >::Superclass1

Definition at line 98 of file elxQuasiNewtonLBFGS.h.

◆ Superclass2

template<class TElastix >

typedef OptimizerBase< TElastix > elastix::QuasiNewtonLBFGS< TElastix >::Superclass2

Definition at line 99 of file elxQuasiNewtonLBFGS.h.

Constructor & Destructor Documentation

◆ QuasiNewtonLBFGS() [1/2]

template<class TElastix >

elastix::QuasiNewtonLBFGS< TElastix >::QuasiNewtonLBFGS ( )

protected

◆ ~QuasiNewtonLBFGS()

template<class TElastix >

elastix::QuasiNewtonLBFGS< TElastix >::~QuasiNewtonLBFGS ( )

inlineoverrideprotected

Definition at line 159 of file elxQuasiNewtonLBFGS.h.

◆ QuasiNewtonLBFGS() [2/2]

template<class TElastix >

elastix::QuasiNewtonLBFGS< TElastix >::QuasiNewtonLBFGS ( const Self & )

private

Member Function Documentation

◆ AfterEachIteration()

template<class TElastix >

void elastix::QuasiNewtonLBFGS< TElastix >::AfterEachIteration ( void )

overridevirtual

Reimplemented from elastix::BaseComponent.

◆ AfterEachResolution()

template<class TElastix >

void elastix::QuasiNewtonLBFGS< TElastix >::AfterEachResolution ( void )

overridevirtual

Reimplemented from elastix::BaseComponent.

◆ AfterRegistration()

template<class TElastix >

void elastix::QuasiNewtonLBFGS< TElastix >::AfterRegistration ( void )

overridevirtual

Reimplemented from elastix::BaseComponent.

◆ BeforeEachResolution()

template<class TElastix >

void elastix::QuasiNewtonLBFGS< TElastix >::BeforeEachResolution ( void )

overridevirtual

Reimplemented from elastix::BaseComponent.

◆ BeforeRegistration()

template<class TElastix >

void elastix::QuasiNewtonLBFGS< TElastix >::BeforeRegistration ( void )

overridevirtual

Methods to set parameters and print output at different stages in the registration process.

Reimplemented from elastix::BaseComponent.

◆ DeterminePhase()

template<class TElastix >

virtual std::string elastix::QuasiNewtonLBFGS< TElastix >::DeterminePhase ( void ) const

protectedvirtual

Generate a string, representing the phase of optimisation (line search, main)

◆ elxClassNameMacro()

template<class TElastix >

elastix::QuasiNewtonLBFGS< TElastix >::elxClassNameMacro ( "QuasiNewtonLBFGS< TElastix >" )

Name of this class. Use this name in the parameter file to select this specific optimizer.
example: (Optimizer "QuasiNewtonLBFGS")

◆ GetClassName()

template<class TElastix >

virtual const char * elastix::QuasiNewtonLBFGS< TElastix >::GetClassName ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::QuasiNewtonLBFGSOptimizer.

◆ GetLineSearchStopCondition()

template<class TElastix >

virtual std::string elastix::QuasiNewtonLBFGS< TElastix >::GetLineSearchStopCondition ( void ) const

protectedvirtual

Convert the line search stop condition to a string

◆ GetStartLineSearch()

template<class TElastix >

virtual bool elastix::QuasiNewtonLBFGS< TElastix >::GetStartLineSearch ( ) const

virtual

◆ InvokeIterationEvent()

template<class TElastix >

void elastix::QuasiNewtonLBFGS< TElastix >::InvokeIterationEvent ( const itk::EventObject & event )

private

◆ LineSearch()

template<class TElastix >

void elastix::QuasiNewtonLBFGS< TElastix >::LineSearch	(	const ParametersType	searchDir,
		double &	step,
		ParametersType &	x,
		MeasureType &	f,
		DerivativeType &	g
	)

overrideprotectedvirtual

Call the superclass' implementation. If an ExceptionObject is caught, because the line search optimizer tried a too big step, the exception is printed, but ignored further. The optimizer stops, but elastix just goes on to the next resolution.

Reimplemented from itk::QuasiNewtonLBFGSOptimizer.

◆ New()

template<class TElastix >

static Pointer elastix::QuasiNewtonLBFGS< TElastix >::New ( )

static

Method for creation through the object factory.

◆ operator=()

template<class TElastix >

void elastix::QuasiNewtonLBFGS< TElastix >::operator= ( const Self & )

private

◆ StartOptimization()

template<class TElastix >

void elastix::QuasiNewtonLBFGS< TElastix >::StartOptimization ( void )

override

Check if any scales are set, and set the UseScales flag on or off; after that call the superclass' implementation

◆ TestConvergence()

template<class TElastix >

bool elastix::QuasiNewtonLBFGS< TElastix >::TestConvergence ( bool firstLineSearchDone )

overrideprotectedvirtual

Reimplement the superclass. Calls the superclass' implementation and checks if the MoreThuente line search routine has stopped with Wolfe conditions satisfied.

Reimplemented from itk::QuasiNewtonLBFGSOptimizer.

Field Documentation

◆ m_EventPasser

template<class TElastix >

EventPassThroughPointer elastix::QuasiNewtonLBFGS< TElastix >::m_EventPasser

private

Definition at line 193 of file elxQuasiNewtonLBFGS.h.

◆ m_GenerateLineSearchIterations

template<class TElastix >

bool elastix::QuasiNewtonLBFGS< TElastix >::m_GenerateLineSearchIterations

private

Definition at line 196 of file elxQuasiNewtonLBFGS.h.

◆ m_LineOptimizer

template<class TElastix >

LineOptimizerPointer elastix::QuasiNewtonLBFGS< TElastix >::m_LineOptimizer

protected

Definition at line 161 of file elxQuasiNewtonLBFGS.h.

◆ m_SearchDirectionMagnitude

template<class TElastix >

double elastix::QuasiNewtonLBFGS< TElastix >::m_SearchDirectionMagnitude

private

Definition at line 194 of file elxQuasiNewtonLBFGS.h.

◆ m_StartLineSearch

template<class TElastix >

bool elastix::QuasiNewtonLBFGS< TElastix >::m_StartLineSearch

private

Definition at line 195 of file elxQuasiNewtonLBFGS.h.

◆ m_StopIfWolfeNotSatisfied

template<class TElastix >

bool elastix::QuasiNewtonLBFGS< TElastix >::m_StopIfWolfeNotSatisfied

private

Definition at line 197 of file elxQuasiNewtonLBFGS.h.

◆ m_WolfeIsStopCondition

template<class TElastix >

bool elastix::QuasiNewtonLBFGS< TElastix >::m_WolfeIsStopCondition

private

Definition at line 198 of file elxQuasiNewtonLBFGS.h.

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Member Typedef Documentation

◆ ConfigurationPointer

◆ ConfigurationType

◆ ConstPointer

◆ CostFunctionPointer

◆ CostFunctionType

◆ DerivativeType

◆ ElastixPointer

◆ ElastixType

◆ EventPassThroughPointer

◆ EventPassThroughType

◆ ITKBaseType

◆ LineOptimizerPointer

◆ LineOptimizerType

◆ ParametersType

◆ Pointer

◆ RegistrationPointer

◆ RegistrationType

◆ ScalesType

◆ Self

◆ StopConditionType

◆ Superclass1

◆ Superclass2

Constructor & Destructor Documentation

◆ QuasiNewtonLBFGS() [1/2]

◆ ~QuasiNewtonLBFGS()

◆ QuasiNewtonLBFGS() [2/2]

Member Function Documentation

◆ AfterEachIteration()

◆ AfterEachResolution()

◆ AfterRegistration()

◆ BeforeEachResolution()

◆ BeforeRegistration()

◆ DeterminePhase()

◆ elxClassNameMacro()

◆ GetClassName()

◆ GetLineSearchStopCondition()

◆ GetStartLineSearch()

◆ InvokeIterationEvent()

◆ LineSearch()

◆ New()

◆ operator=()

◆ StartOptimization()

◆ TestConvergence()

Field Documentation

◆ m_EventPasser

◆ m_GenerateLineSearchIterations

◆ m_LineOptimizer

◆ m_SearchDirectionMagnitude

◆ m_StartLineSearch

◆ m_StopIfWolfeNotSatisfied

◆ m_WolfeIsStopCondition