ITK
4.6.0
Insight Segmentation and Registration Toolkit
|
#include <itkConjugateGradientLineSearchOptimizerv4.h>
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
where d is defined as the Polak-Ribiere conjugate gradient.
Options are identical to the superclass's.
Definition at line 47 of file itkConjugateGradientLineSearchOptimizerv4.h.
Public Member Functions | |
virtual ::itk::LightObject::Pointer | CreateAnother (void) const |
virtual const char * | GetNameOfClass () const |
virtual void | StartOptimization (bool doOnlyInitialization=false) |
Public Member Functions inherited from itk::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType > | |
virtual ::itk::LightObject::Pointer | CreateAnother (void) 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 (void) const |
virtual void | EstimateLearningRate () |
virtual const TInternalComputationValueType & | GetConvergenceValue () const |
virtual const TInternalComputationValueType & | GetLearningRate () const |
virtual const TInternalComputationValueType & | GetMaximumStepSizeInPhysicalUnits () const |
virtual void | ResumeOptimization () ITK_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) ITK_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 |
virtual const DerivativeType & | GetGradient () const |
virtual SizeValueType | GetNumberOfIterations () const |
virtual const StopConditionType & | GetStopCondition () const |
virtual const StopConditionReturnStringType | GetStopConditionDescription () const ITK_OVERRIDE |
virtual void | SetNumberOfIterations (SizeValueType _arg) |
virtual void | ModifyGradientByScales () |
virtual void | ModifyGradientByLearningRate () |
Public Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType > | |
virtual const MeasureType & | GetCurrentMetricValue () const |
virtual const ParametersType & | GetCurrentPosition () const |
virtual const ThreadIdType & | GetNumberOfThreads () const |
virtual const ScalesType & | GetScales () const |
virtual const bool & | GetScalesAreIdentity () const |
bool | GetScalesInitialized (void) const |
virtual const MeasureType & | GetValue () const |
virtual const ScalesType & | GetWeights () 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 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 void | DebugOff () const |
virtual void | DebugOn () const |
Command * | GetCommand (unsigned long tag) |
bool | GetDebug () const |
MetaDataDictionary & | GetMetaDataDictionary (void) |
const MetaDataDictionary & | GetMetaDataDictionary (void) 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 ITK_OVERRIDE |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) |
void | SetDebug (bool debugFlag) const |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
virtual void | SetReferenceCount (int) ITK_OVERRIDE |
virtual void | UnRegister () const ITK_OVERRIDE |
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 () |
Private Member Functions | |
ConjugateGradientLineSearchOptimizerv4Template (const Self &) | |
void | operator= (const Self &) |
Private Attributes | |
DerivativeType | m_ConjugateGradient |
DerivativeType | m_LastGradient |
typedef SmartPointer< const Self > itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::ConstPointer |
Definition at line 55 of file itkConjugateGradientLineSearchOptimizerv4.h.
typedef itk::Function::WindowConvergenceMonitoringFunction<TInternalComputationValueType> itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::ConvergenceMonitoringType |
Type for the convergence checker
Definition at line 73 of file itkConjugateGradientLineSearchOptimizerv4.h.
typedef Superclass::DerivativeType itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::DerivativeType |
Derivative type
Definition at line 67 of file itkConjugateGradientLineSearchOptimizerv4.h.
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.
typedef Superclass::MeasureType itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::MeasureType |
Metric type over which this class is templated
Definition at line 70 of file itkConjugateGradientLineSearchOptimizerv4.h.
typedef SmartPointer< Self > itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::Pointer |
Definition at line 54 of file itkConjugateGradientLineSearchOptimizerv4.h.
typedef ConjugateGradientLineSearchOptimizerv4Template itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::Self |
Standard class typedefs.
Definition at line 52 of file itkConjugateGradientLineSearchOptimizerv4.h.
typedef GradientDescentLineSearchOptimizerv4Template<TInternalComputationValueType> itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >::Superclass |
Definition at line 53 of file itkConjugateGradientLineSearchOptimizerv4.h.
|
protected |
Default constructor
|
protectedvirtual |
Destructor
|
private |
|
protectedvirtual |
Advance one Step following the gradient direction. Includes transform update.
Reimplemented from itk::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >.
|
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.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >.
|
static |
New macro for creation of through a Smart Pointer
|
private |
|
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::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >.
|
virtual |
Start and run the optimization
Reimplemented from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >.
|
private |
Definition at line 94 of file itkConjugateGradientLineSearchOptimizerv4.h.
|
private |
Definition at line 93 of file itkConjugateGradientLineSearchOptimizerv4.h.