#include <itkLBFGSOptimizerBasev4.h>

Inheritance diagram for itk::LBFGSOptimizerBasev4< TInternalVnlOptimizerType >:

Collaboration diagram for itk::LBFGSOptimizerBasev4< TInternalVnlOptimizerType >:

Detailed Description

template<typename TInternalVnlOptimizerType>
class itk::LBFGSOptimizerBasev4< TInternalVnlOptimizerType >

Abstract base for vnl lbfgs algorithm optimizers in ITKv4 registration framework.

Note: The StopConditionDescription returned by this class is directly from the vnl optimizer by calling m_VnlOptimizer->get_failure_code() . This seems to return "Failure" even when no error has occured. The same behavior is observed in the ITKv3 version of this optimizer.; Local-support (high-density) transforms. Local-support transforms are not supported. To add support for these, the class must be modified thusly:; 1) Parameter updates: In SingleValuedNonLinearCostFunctionAdaptor, the handling of the gradient must be changed to accomodate the fact that local-support transforms expect a gradient to be added to the transform parameters using the UpdateTransformParameters method of the local support transform. Other optimizers in the v4 framework use this method, but the use of the vnl optimizers here complicates it.; 2) Efficiency To work efficiently with local-support transforms, this class should be modified to use a single parameter object to avoid the multiple parameter copies that are currently performed. It should work to use the transform parameters pointer.

This code has been adapted for the ITKv4 registration framework from the v3 version, itkLBFGSOptimizer.

Definition at line 74 of file itkLBFGSOptimizerBasev4.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef LBFGSOptimizerBaseHelperv4 < TInternalVnlOptimizerType >	InternalOptimizerType

typedef Superclass::MetricType	MetricType

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

typedef Superclass::ScalesType	ScalesType

typedef LBFGSOptimizerBasev4	Self

typedef Superclass::StopConditionDescriptionType	StopConditionDescriptionType

typedef Superclass::StopConditionReturnStringType	StopConditionReturnStringType

typedef SingleValuedNonLinearVnlOptimizerv4	Superclass

Public Types inherited from itk::SingleValuedNonLinearVnlOptimizerv4
typedef ReceptorMemberCommand < Self >	CommandType

typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DerivativeType	DerivativeType

typedef Superclass::MetricType	MetricType

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

typedef Superclass::ScalesType	ScalesType

typedef SingleValuedNonLinearVnlOptimizerv4	Self

typedef Superclass::StopConditionDescriptionType	StopConditionDescriptionType

typedef Superclass::StopConditionReturnStringType	StopConditionReturnStringType

typedef ObjectToObjectOptimizerBase	Superclass

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

typedef MetricType::DerivativeType	DerivativeType

typedef MetricType::MeasureType	MeasureType

typedef ObjectToObjectMetricBaseTemplate < double >	MetricType

typedef MetricType::Pointer	MetricTypePointer

typedef MetricType::NumberOfParametersType	NumberOfParametersType

typedef OptimizerParameters < double >	ParametersType

typedef SmartPointer< Self >	Pointer

typedef OptimizerParameterScalesEstimatorTemplate < double >	ScalesEstimatorType

typedef OptimizerParameters < double >	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 double	GetGradientConvergenceTolerance () const

virtual unsigned int	GetMaximumNumberOfFunctionEvaluations () const

virtual const char *	GetNameOfClass () const

InternalOptimizerType *	GetOptimizer ()

virtual const StopConditionReturnStringType	GetStopConditionDescription () const override

virtual bool	GetTrace () const

virtual void	SetGradientConvergenceTolerance (double gtol)

virtual void	SetMaximumNumberOfFunctionEvaluations (unsigned int n)

virtual void	SetMetric (MetricType *metric) override

virtual void	SetTrace (bool flag)

virtual void	StartOptimization (bool doOnlyInitialization=false) override

virtual void	TraceOff ()

virtual void	TraceOn ()

Public Member Functions inherited from itk::SingleValuedNonLinearVnlOptimizerv4
virtual const DerivativeType &	GetCachedDerivative () const

virtual const ParametersType &	GetCachedCurrentPosition () const

Public Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< double >
virtual SizeValueType	GetCurrentIteration () const

virtual const MeasureType &	GetCurrentMetricValue () const

virtual const ParametersType &	GetCurrentPosition () const

virtual SizeValueType	GetNumberOfIterations () 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	SetNumberOfIterations (SizeValueType _arg)

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 LightObject::Pointer	CreateAnother () const override

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

Protected Types
typedef Superclass::CostFunctionAdaptorType	CostFunctionAdaptorType

typedef AutoPointer < InternalOptimizerType >	InternalOptimizerAutoPointer

Protected Types inherited from itk::SingleValuedNonLinearVnlOptimizerv4
typedef SingleValuedVnlCostFunctionAdaptorv4	CostFunctionAdaptorType

Protected Member Functions
	LBFGSOptimizerBasev4 ()

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

virtual	~LBFGSOptimizerBasev4 () override

Protected Member Functions inherited from itk::SingleValuedNonLinearVnlOptimizerv4
const CostFunctionAdaptorType *	GetCostFunctionAdaptor () const

CostFunctionAdaptorType *	GetCostFunctionAdaptor ()

CostFunctionAdaptorType *	GetNonConstCostFunctionAdaptor () const

void	SetCostFunctionAdaptor (CostFunctionAdaptorType *adaptor)

	SingleValuedNonLinearVnlOptimizerv4 ()

virtual	~SingleValuedNonLinearVnlOptimizerv4 () override

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

virtual	~ObjectToObjectOptimizerBaseTemplate () override

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object () override

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
double	m_CostFunctionConvergenceFactor

double	m_GradientConvergenceTolerance

double	m_InfinityNormOfProjectedGradient

unsigned int	m_MaximumNumberOfFunctionEvaluations

bool	m_OptimizerInitialized

std::ostringstream	m_StopConditionDescription

bool	m_Trace

InternalOptimizerAutoPointer	m_VnlOptimizer

Protected Attributes inherited from itk::ObjectToObjectOptimizerBaseTemplate< double >
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

Friends
class	LBFGSBOptimizerHelperv4

class	LBFGSOptimizerBaseHelperv4< TInternalVnlOptimizerType >

Additional Inherited Members
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 ()