ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType > Class Template Reference

#include <itkConjugateGradientLineSearchOptimizerv4.h>

+ Inheritance diagram for itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >:
+ Collaboration diagram for itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >:

Detailed Description

template<typename TInternalComputationValueType>
class itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >

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.

Examples:
Examples/RegistrationITKv4/MultiStageImageRegistration1.cxx, and Examples/RegistrationITKv4/MultiStageImageRegistration2.cxx.

Definition at line 47 of file itkConjugateGradientLineSearchOptimizerv4.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef
itk::Function::WindowConvergenceMonitoringFunction
< TInternalComputationValueType > 
ConvergenceMonitoringType
 
typedef Superclass::DerivativeType DerivativeType
 
typedef
TInternalComputationValueType 
InternalComputationValueType
 
typedef Superclass::MeasureType MeasureType
 
typedef SmartPointer< SelfPointer
 
typedef
ConjugateGradientLineSearchOptimizerv4Template 
Self
 
typedef
GradientDescentLineSearchOptimizerv4Template
< TInternalComputationValueType > 
Superclass
 
- Public Types inherited from itk::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >
typedef SmartPointer< const SelfConstPointer
 
typedef
itk::Function::WindowConvergenceMonitoringFunction
< TInternalComputationValueType > 
ConvergenceMonitoringType
 
typedef Superclass::DerivativeType DerivativeType
 
typedef
TInternalComputationValueType 
InternalComputationValueType
 
typedef Superclass::MeasureType MeasureType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef
GradientDescentLineSearchOptimizerv4Template 
Self
 
typedef
GradientDescentOptimizerv4Template
< TInternalComputationValueType > 
Superclass
 
- Public Types inherited from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::DerivativeType DerivativeType
 
typedef Superclass::IndexRangeType IndexRangeType
 
typedef
TInternalComputationValueType 
InternalComputationValueType
 
typedef Superclass::MeasureType MeasureType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
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 SelfConstPointer
 
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< SelfPointer
 
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 SelfConstPointer
 
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< SelfPointer
 
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 SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
virtual void StartOptimization (bool doOnlyInitialization=false) override
 
- Public Member Functions inherited from itk::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual void SetEpsilon (TInternalComputationValueType _arg)
 
virtual
TInternalComputationValueType 
GetEpsilon ()
 
virtual void SetLowerLimit (TInternalComputationValueType _arg)
 
virtual
TInternalComputationValueType 
GetLowerLimit ()
 
virtual void SetUpperLimit (TInternalComputationValueType _arg)
 
virtual
TInternalComputationValueType 
GetUpperLimit ()
 
virtual void SetMaximumLineSearchIterations (unsigned int _arg)
 
virtual unsigned int GetMaximumLineSearchIterations ()
 
- Public Member Functions inherited from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual void EstimateLearningRate ()
 
virtual const
TInternalComputationValueType & 
GetConvergenceValue () const
 
virtual const
TInternalComputationValueType & 
GetLearningRate () const
 
virtual const
TInternalComputationValueType & 
GetMaximumStepSizeInPhysicalUnits () const
 
virtual void ResumeOptimization () override
 
virtual void SetConvergenceWindowSize (SizeValueType _arg)
 
virtual void SetLearningRate (TInternalComputationValueType _arg)
 
virtual void SetMaximumStepSizeInPhysicalUnits (TInternalComputationValueType _arg)
 
virtual void SetMinimumConvergenceValue (TInternalComputationValueType _arg)
 
virtual void StopOptimization (void) override
 
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 override
 
virtual const DerivativeTypeGetGradient () const
 
virtual SizeValueType GetNumberOfIterations () const override
 
virtual const StopConditionTypeGetStopCondition () const
 
virtual const
StopConditionReturnStringType 
GetStopConditionDescription () const override
 
virtual void SetNumberOfIterations (const SizeValueType numberOfIterations) override
 
virtual void ModifyGradientByScales ()
 
virtual void ModifyGradientByLearningRate ()
 
- Public Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
virtual const MeasureTypeGetCurrentMetricValue () const
 
virtual const ParametersTypeGetCurrentPosition () const
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
virtual const ScalesTypeGetScales () const
 
virtual const bool & GetScalesAreIdentity () const
 
bool GetScalesInitialized () const
 
virtual const MeasureTypeGetValue () const
 
virtual const ScalesTypeGetWeights () 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 MetricTypeGetModifiableMetric ()
 
virtual const MetricTypeGetMetric () 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >
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 AdvanceOneStep (void) override
 
 ConjugateGradientLineSearchOptimizerv4Template ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual ~ConjugateGradientLineSearchOptimizerv4Template ()
 
- Protected Member Functions inherited from itk::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >
TInternalComputationValueType GoldenSectionSearch (TInternalComputationValueType a, TInternalComputationValueType b, TInternalComputationValueType c)
 
 GradientDescentLineSearchOptimizerv4Template ()
 
virtual ~GradientDescentLineSearchOptimizerv4Template ()
 
- Protected Member Functions inherited from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >
 GradientDescentOptimizerv4Template ()
 
virtual ~GradientDescentOptimizerv4Template ()
 
virtual void ModifyGradientByScalesOverSubRange (const IndexRangeType &subrange) override
 
virtual void ModifyGradientByLearningRateOverSubRange (const IndexRangeType &subrange) 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 ()
 

Private Member Functions

 ConjugateGradientLineSearchOptimizerv4Template (const Self &)
 
void operator= (const Self &)
 

Private Attributes

DerivativeType m_ConjugateGradient
 
DerivativeType m_LastGradient
 

Additional Inherited Members

- Protected Attributes inherited from itk::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >
TInternalComputationValueType m_Epsilon
 
unsigned int m_LineSearchIterations
 
TInternalComputationValueType m_LowerLimit
 
unsigned int m_MaximumLineSearchIterations
 
TInternalComputationValueType m_Phi
 
TInternalComputationValueType m_Resphi
 
TInternalComputationValueType m_UpperLimit
 
- 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
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TInternalComputationValueType >
typedef SmartPointer< const Self > itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::ConstPointer

Definition at line 55 of file itkConjugateGradientLineSearchOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef itk::Function::WindowConvergenceMonitoringFunction<TInternalComputationValueType> itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::ConvergenceMonitoringType

Type for the convergence checker

Definition at line 73 of file itkConjugateGradientLineSearchOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef Superclass::DerivativeType itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::DerivativeType

Derivative type

Definition at line 67 of file itkConjugateGradientLineSearchOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef TInternalComputationValueType itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::InternalComputationValueType

It should be possible to derive the internal computation type from the class object.

Definition at line 61 of file itkConjugateGradientLineSearchOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef Superclass::MeasureType itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::MeasureType

Metric type over which this class is templated

Definition at line 70 of file itkConjugateGradientLineSearchOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef SmartPointer< Self > itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::Pointer

Definition at line 54 of file itkConjugateGradientLineSearchOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef ConjugateGradientLineSearchOptimizerv4Template itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::Self

Standard class typedefs.

Definition at line 52 of file itkConjugateGradientLineSearchOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef GradientDescentLineSearchOptimizerv4Template<TInternalComputationValueType> itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::Superclass

Definition at line 53 of file itkConjugateGradientLineSearchOptimizerv4.h.

Constructor & Destructor Documentation

template<typename TInternalComputationValueType >
itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::ConjugateGradientLineSearchOptimizerv4Template ( )
protected

Default constructor

template<typename TInternalComputationValueType >
virtual itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::~ConjugateGradientLineSearchOptimizerv4Template ( )
protectedvirtual

Destructor

template<typename TInternalComputationValueType >
itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::ConjugateGradientLineSearchOptimizerv4Template ( const Self )
private

Member Function Documentation

template<typename TInternalComputationValueType >
virtual void itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::AdvanceOneStep ( void  )
overrideprotectedvirtual

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

Reimplemented from itk::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >.

template<typename TInternalComputationValueType >
virtual::itk::LightObject::Pointer itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::CreateAnother ( ) 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::Object.

template<typename TInternalComputationValueType >
virtual const char* itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >.

template<typename TInternalComputationValueType >
static Pointer itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::New ( )
static

New macro for creation of through a Smart Pointer

template<typename TInternalComputationValueType >
void itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::operator= ( const Self )
private
template<typename TInternalComputationValueType >
virtual void itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >.

template<typename TInternalComputationValueType >
virtual void itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::StartOptimization ( bool  doOnlyInitialization = false)
overridevirtual

Start and run the optimization

Reimplemented from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >.

Member Data Documentation

template<typename TInternalComputationValueType >
DerivativeType itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::m_ConjugateGradient
private

Definition at line 94 of file itkConjugateGradientLineSearchOptimizerv4.h.

template<typename TInternalComputationValueType >
DerivativeType itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::m_LastGradient
private

Definition at line 93 of file itkConjugateGradientLineSearchOptimizerv4.h.


The documentation for this class was generated from the following file: