#include <elxConjugateGradientFRPR.h>

Detailed Description

template<class TElastix>
class elastix::ConjugateGradientFRPR< TElastix >

This component is based on the itkFRPROptimizer. This is a Fletcher-Reeves conjugate gradient optimizer, in combination with an exact (dBrent) line search, based on the description in Numerical Recipes in C++

This optimizer support the NewSamplesEveryIteration option. It requests new samples upon every derivative evaluation, but actually this makes no sense for a conjugate gradient optimizer. So, think twice before using it.

Note: It prints out no stop conditions, since the itk superclass does not generate them.; It considers line search iterations as elastix iterations.

Parameters:

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

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

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

StepLength: Set the length of the initial step tried by the line seach, used to bracket the minimum.
example: (StepLength 2.0 1.0 0.5)
Default value: 1.0.

ValueTolerance: Convergence is declared if:

$2.0 * | f_2 - f_1 | \le ValueTolerance * ( | f_1 | + | f_2 | )$

example: (ValueTolerance 0.001 0.00001 0.000001)
Default value: 0.00001.

Parameters:: LineSearchStepTolerance: Convergence of the line search is declared if:

$| x - x_m | \le tol * |x| - ( b - a ) / 2,$

where:
= current mininum of the gain
= current brackets around the minimum

example: (LineSearchStepTolerance 0.001 0.00001 0.000001)
Default value: 0.00001.

Definition at line 74 of file elxConjugateGradientFRPR.h.

Inheritance diagram for elastix::ConjugateGradientFRPR< 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 SingleValuedNonLinearOptimizer::DerivativeType	DerivativeType

typedef Superclass2::ElastixPointer	ElastixPointer

typedef Superclass2::ElastixType	ElastixType

typedef Superclass2::ITKBaseType	ITKBaseType

typedef Superclass1::ParametersType	ParametersType

typedef itk::SmartPointer< Self >	Pointer

typedef Superclass2::RegistrationPointer	RegistrationPointer

typedef Superclass2::RegistrationType	RegistrationType

typedef ConjugateGradientFRPR	Self

typedef itk::FRPROptimizer	Superclass1

typedef OptimizerBase< TElastix >	Superclass2

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 ("ConjugateGradientFRPR")

virtual const char *	GetClassName () const

virtual const double &	GetCurrentDerivativeMagnitude ()

virtual const double &	GetCurrentSearchDirectionMagnitude ()

virtual const double &	GetCurrentStepLength ()

virtual bool	GetLineBracketing () const

virtual bool	GetLineOptimizing () const

void	SetInitialPosition (const ParametersType &param) override

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 elastix::BaseComponent
static std::string	ConvertSecondsToDHMS (const double totalSeconds, const unsigned int precision)

static void	InitializeElastixExecutable ()

static bool	IsElastixLibrary ()

Protected Member Functions
void	BracketedLineOptimize (double ax, double bx, double cx, double fa, double fb, double fc, double extX, double extVal) override

	ConjugateGradientFRPR ()

virtual void	GetValueAndDerivative (ParametersType p, double val, ParametersType xi)

void	LineBracket (double ax, double bx, double cx, double fa, double fb, double fc) override

virtual void	LineOptimize (ParametersType p, ParametersType xi, double val)

virtual void	SetLineBracketing (bool _arg)

virtual void	SetLineOptimizing (bool _arg)

	~ConjugateGradientFRPR () 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
double	m_CurrentDerivativeMagnitude

double	m_CurrentSearchDirectionMagnitude

double	m_CurrentStepLength

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

ElastixPointer	m_Elastix {}

RegistrationPointer	m_Registration {}

Private Member Functions
	ConjugateGradientFRPR (const Self &)

const char *	DeterminePhase (void) const

void	operator= (const Self &)

Private Attributes
bool	m_LineBracketing

bool	m_LineOptimizing

Member Typedef Documentation

◆ ConfigurationPointer

template<class TElastix >

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

Definition at line 110 of file elxConjugateGradientFRPR.h.

◆ ConfigurationType

template<class TElastix >

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

Definition at line 109 of file elxConjugateGradientFRPR.h.

◆ ConstPointer

template<class TElastix >

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

Definition at line 87 of file elxConjugateGradientFRPR.h.

◆ CostFunctionPointer

template<class TElastix >

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

Definition at line 100 of file elxConjugateGradientFRPR.h.

◆ CostFunctionType

template<class TElastix >

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

Typedef's inherited from Superclass1.

Definition at line 99 of file elxConjugateGradientFRPR.h.

◆ DerivativeType

template<class TElastix >

typedef SingleValuedNonLinearOptimizer::DerivativeType elastix::ConjugateGradientFRPR< TElastix >::DerivativeType

Definition at line 104 of file elxConjugateGradientFRPR.h.

◆ ElastixPointer

template<class TElastix >

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

Definition at line 108 of file elxConjugateGradientFRPR.h.

◆ ElastixType

template<class TElastix >

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

Typedef's inherited from Elastix.

Definition at line 107 of file elxConjugateGradientFRPR.h.

◆ ITKBaseType

template<class TElastix >

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

Definition at line 113 of file elxConjugateGradientFRPR.h.

◆ ParametersType

template<class TElastix >

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

Definition at line 102 of file elxConjugateGradientFRPR.h.

◆ Pointer

template<class TElastix >

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

Definition at line 86 of file elxConjugateGradientFRPR.h.

◆ RegistrationPointer

template<class TElastix >

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

Definition at line 112 of file elxConjugateGradientFRPR.h.

◆ RegistrationType

template<class TElastix >

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

Definition at line 111 of file elxConjugateGradientFRPR.h.

◆ Self

template<class TElastix >

typedef ConjugateGradientFRPR elastix::ConjugateGradientFRPR< TElastix >::Self

Standard ITK.

Definition at line 83 of file elxConjugateGradientFRPR.h.

◆ Superclass1

template<class TElastix >

typedef itk::FRPROptimizer elastix::ConjugateGradientFRPR< TElastix >::Superclass1

Definition at line 84 of file elxConjugateGradientFRPR.h.

◆ Superclass2

template<class TElastix >

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

Definition at line 85 of file elxConjugateGradientFRPR.h.

Constructor & Destructor Documentation

◆ ConjugateGradientFRPR() [1/2]

template<class TElastix >

elastix::ConjugateGradientFRPR< TElastix >::ConjugateGradientFRPR ( )

protected

◆ ~ConjugateGradientFRPR()

template<class TElastix >

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

inlineoverrideprotected

Definition at line 147 of file elxConjugateGradientFRPR.h.

◆ ConjugateGradientFRPR() [2/2]

template<class TElastix >

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

private

Member Function Documentation

◆ AfterEachIteration()

template<class TElastix >

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

overridevirtual

Reimplemented from elastix::BaseComponent.

◆ AfterEachResolution()

template<class TElastix >

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

overridevirtual

Reimplemented from elastix::BaseComponent.

◆ AfterRegistration()

template<class TElastix >

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

overridevirtual

Reimplemented from elastix::BaseComponent.

◆ BeforeEachResolution()

template<class TElastix >

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

overridevirtual

Reimplemented from elastix::BaseComponent.

◆ BeforeRegistration()

template<class TElastix >

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

overridevirtual

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

Reimplemented from elastix::BaseComponent.

◆ BracketedLineOptimize()

template<class TElastix >

void elastix::ConjugateGradientFRPR< TElastix >::BracketedLineOptimize	(	double	ax,
		double	bx,
		double	cx,
		double	fa,
		double	fb,
		double	fc,
		double *	extX,
		double *	extVal
	)

overrideprotected

Given a bracketing triple of points and their function values, returns a bounded extreme. These values are in parameter space, along the current line and wrt the current origin set via SetLine. Optimization terminates based on MaximumIteration, StepTolerance, or ValueTolerance. Implemented as Brent line optimers from NRC.

This implementation sets the LineOptimizing flag to 'true', calls the the superclass's implementation, stores extX as the current step length, and sets the LineOptimizing flag to 'false' again.

◆ DeterminePhase()

template<class TElastix >

const char * elastix::ConjugateGradientFRPR< TElastix >::DeterminePhase ( void ) const

private

◆ elxClassNameMacro()

template<class TElastix >

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

Name of this class.

◆ GetClassName()

template<class TElastix >

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

virtual

Run-time type information (and related methods).

Reimplemented from elastix::OptimizerBase< TElastix >.

◆ GetCurrentDerivativeMagnitude()

template<class TElastix >

virtual const double & elastix::ConjugateGradientFRPR< TElastix >::GetCurrentDerivativeMagnitude ( )

virtual

Return the magnitude of the cached derivative

◆ GetCurrentSearchDirectionMagnitude()

template<class TElastix >

virtual const double & elastix::ConjugateGradientFRPR< TElastix >::GetCurrentSearchDirectionMagnitude ( )

virtual

Get the magnitude of the line search direction

◆ GetCurrentStepLength()

template<class TElastix >

virtual const double & elastix::ConjugateGradientFRPR< TElastix >::GetCurrentStepLength ( )

virtual

Get the current gain

◆ GetLineBracketing()

template<class TElastix >

virtual bool elastix::ConjugateGradientFRPR< TElastix >::GetLineBracketing ( ) const

virtual

◆ GetLineOptimizing()

template<class TElastix >

virtual bool elastix::ConjugateGradientFRPR< TElastix >::GetLineOptimizing ( ) const

virtual

Check if the optimizer is currently Bracketing the minimum, or is optimizing along a line

◆ GetValueAndDerivative()

template<class TElastix >

virtual void elastix::ConjugateGradientFRPR< TElastix >::GetValueAndDerivative	(	ParametersType	p,
		double *	val,
		ParametersType *	xi
	)

protectedvirtual

Get the value of the n-dimensional cost function at this scalar step distance along the current line direction from the current line origin. Line origin and distances are set via SetLine.

This implementation calls the Superclass' implementation and caches the computed derivative's magnitude. Besides, it invokes the SelectNewSamples method.

◆ LineBracket()

template<class TElastix >

void elastix::ConjugateGradientFRPR< TElastix >::LineBracket	(	double *	ax,
		double *	bx,
		double *	cx,
		double *	fa,
		double *	fb,
		double *	fc
	)

overrideprotected

The LineBracket routine from NRC. Uses current origin and line direction (from SetLine) to find a triple of points (ax, bx, cx) that bracket the extreme "near" the origin. Search first considers the point StepLength distance from ax. IMPORTANT: The value of ax and the value of the function at ax (i.e., fa), must both be provided to this function.

This implementation sets the LineBracketing flag to 'true', calls the superclass' implementation, stores bx as the current step length, invokes an iteration event, and sets the LineBracketing flag to 'false'

◆ LineOptimize()

template<class TElastix >

virtual void elastix::ConjugateGradientFRPR< TElastix >::LineOptimize	(	ParametersType *	p,
		ParametersType	xi,
		double *	val
	)

protectedvirtual

store the line search direction's (xi) magnitude and call the superclass' implementation.

◆ New()

template<class TElastix >

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

static

Method for creation through the object factory.

◆ operator=()

template<class TElastix >

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

private

◆ SetInitialPosition()

template<class TElastix >

void elastix::ConjugateGradientFRPR< TElastix >::SetInitialPosition ( const ParametersType & param )

override

Override the SetInitialPosition.

◆ SetLineBracketing()

template<class TElastix >

virtual void elastix::ConjugateGradientFRPR< TElastix >::SetLineBracketing ( bool _arg )

protectedvirtual

◆ SetLineOptimizing()

template<class TElastix >

virtual void elastix::ConjugateGradientFRPR< TElastix >::SetLineOptimizing ( bool _arg )

protectedvirtual

Set if the optimizer is currently bracketing the minimum, or is optimizing along a line

Field Documentation

◆ m_CurrentDerivativeMagnitude

template<class TElastix >

double elastix::ConjugateGradientFRPR< TElastix >::m_CurrentDerivativeMagnitude

protected

To store the latest computed derivative's magnitude

Definition at line 150 of file elxConjugateGradientFRPR.h.

◆ m_CurrentSearchDirectionMagnitude

template<class TElastix >

double elastix::ConjugateGradientFRPR< TElastix >::m_CurrentSearchDirectionMagnitude

protected

Variable to store the line search direction magnitude

Definition at line 153 of file elxConjugateGradientFRPR.h.

◆ m_CurrentStepLength

template<class TElastix >

double elastix::ConjugateGradientFRPR< TElastix >::m_CurrentStepLength

protected

the current gain

Definition at line 156 of file elxConjugateGradientFRPR.h.

◆ m_LineBracketing

template<class TElastix >

bool elastix::ConjugateGradientFRPR< TElastix >::m_LineBracketing

private

Definition at line 212 of file elxConjugateGradientFRPR.h.

◆ m_LineOptimizing

template<class TElastix >

bool elastix::ConjugateGradientFRPR< TElastix >::m_LineOptimizing

private

Definition at line 211 of file elxConjugateGradientFRPR.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

◆ ITKBaseType

◆ ParametersType

◆ Pointer

◆ RegistrationPointer

◆ RegistrationType

◆ Self

◆ Superclass1

◆ Superclass2

Constructor & Destructor Documentation

◆ ConjugateGradientFRPR() [1/2]

◆ ~ConjugateGradientFRPR()

◆ ConjugateGradientFRPR() [2/2]

Member Function Documentation

◆ AfterEachIteration()

◆ AfterEachResolution()

◆ AfterRegistration()

◆ BeforeEachResolution()

◆ BeforeRegistration()

◆ BracketedLineOptimize()

◆ DeterminePhase()

◆ elxClassNameMacro()

◆ GetClassName()

◆ GetCurrentDerivativeMagnitude()

◆ GetCurrentSearchDirectionMagnitude()

◆ GetCurrentStepLength()

◆ GetLineBracketing()

◆ GetLineOptimizing()

◆ GetValueAndDerivative()

◆ LineBracket()

◆ LineOptimize()

◆ New()

◆ operator=()

◆ SetInitialPosition()

◆ SetLineBracketing()

◆ SetLineOptimizing()

Field Documentation

◆ m_CurrentDerivativeMagnitude

◆ m_CurrentSearchDirectionMagnitude

◆ m_CurrentStepLength

◆ m_LineBracketing

◆ m_LineOptimizing