![]() |
ITK
4.13.0
Insight Segmentation and Registration Toolkit
|
#include <itkMultiGradientOptimizerv4.h>
Multiple gradient-based optimizers are combined in order to perform a multi-objective optimization.
This optimizer will do a combined gradient descent optimization using whatever metric/optimizer gradient sub-optimizers are passed to it by the user. The learning rate or scaleestimator for each sub-optimizer controls the relative weight of each metric in the optimization. Denote the weights as and
then the MultiGradientOptimizer will optimize
by using update rule:
The test for this class illustrates the expected behavior.
Definition at line 46 of file itkMultiGradientOptimizerv4.h.
Public Member Functions | |
virtual ::itk::LightObject::Pointer | CreateAnother () const |
const MetricValuesListType & | GetMetricValuesList () const |
virtual const char * | GetNameOfClass () const |
OptimizersListType & | GetOptimizersList () |
virtual const StopConditionType & | GetStopCondition () const override |
virtual const StopConditionReturnStringType | GetStopConditionDescription () const override |
virtual void | ResumeOptimization () override |
void | SetOptimizersList (OptimizersListType &p) |
virtual void | StartOptimization (bool doOnlyInitialization=false) override |
virtual void | StopOptimization (void) override |
![]() | |
virtual void | EstimateLearningRate () |
virtual const TInternalComputationValueType & | GetConvergenceValue () const |
virtual void | SetConvergenceWindowSize (SizeValueType _arg) |
virtual void | SetMinimumConvergenceValue (TInternalComputationValueType _arg) |
virtual void | SetLearningRate (TInternalComputationValueType _arg) |
virtual const TInternalComputationValueType & | GetLearningRate () const |
virtual void | SetMaximumStepSizeInPhysicalUnits (TInternalComputationValueType _arg) |
virtual const TInternalComputationValueType & | GetMaximumStepSizeInPhysicalUnits () const |
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 () |
![]() | |
virtual SizeValueType | GetCurrentIteration () const override |
virtual const DerivativeType & | GetGradient () const |
virtual SizeValueType | GetNumberOfIterations () const override |
virtual void | SetNumberOfIterations (const SizeValueType numberOfIterations) override |
virtual void | ModifyGradientByScales () |
virtual void | ModifyGradientByLearningRate () |
![]() | |
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 () 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 () |
![]() | |
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 () |
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 |
![]() | |
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 Pointer | New () |
![]() | |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool flag) |
![]() | |
static void | BreakOnError () |
static Pointer | New () |
typedef SmartPointer< const Self > itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::ConstPointer |
Definition at line 54 of file itkMultiGradientOptimizerv4.h.
typedef MetricType::DerivativeType itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::DerivativeType |
Derivative type
Definition at line 86 of file itkMultiGradientOptimizerv4.h.
typedef TInternalComputationValueType itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::InternalComputationValueType |
It should be possible to derive the internal computation type from the class object.
Definition at line 79 of file itkMultiGradientOptimizerv4.h.
typedef itk::GradientDescentOptimizerv4Template<TInternalComputationValueType>::Pointer itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::LocalOptimizerPointer |
Definition at line 63 of file itkMultiGradientOptimizerv4.h.
typedef itk::GradientDescentOptimizerv4Template<TInternalComputationValueType> itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::LocalOptimizerType |
Definition at line 60 of file itkMultiGradientOptimizerv4.h.
typedef Superclass::MeasureType itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::MeasureType |
Measure type
Definition at line 89 of file itkMultiGradientOptimizerv4.h.
typedef Superclass::MetricType itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::MetricType |
Metric type over which this class is templated
Definition at line 82 of file itkMultiGradientOptimizerv4.h.
typedef MetricType::Pointer itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::MetricTypePointer |
Definition at line 83 of file itkMultiGradientOptimizerv4.h.
typedef std::vector< MeasureType > itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::MetricValuesListType |
Definition at line 90 of file itkMultiGradientOptimizerv4.h.
typedef OptimizerType::Pointer itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::OptimizerPointer |
Definition at line 66 of file itkMultiGradientOptimizerv4.h.
typedef OptimizersListType::size_type itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::OptimizersListSizeType |
Definition at line 68 of file itkMultiGradientOptimizerv4.h.
typedef std::vector< LocalOptimizerPointer > itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::OptimizersListType |
Definition at line 67 of file itkMultiGradientOptimizerv4.h.
typedef ObjectToObjectOptimizerBaseTemplate<TInternalComputationValueType> itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::OptimizerType |
Definition at line 65 of file itkMultiGradientOptimizerv4.h.
typedef Superclass::ParametersType itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::ParametersType |
Definition at line 64 of file itkMultiGradientOptimizerv4.h.
typedef SmartPointer< Self > itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::Pointer |
Definition at line 53 of file itkMultiGradientOptimizerv4.h.
typedef MultiGradientOptimizerv4Template itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::Self |
Standard class typedefs.
Definition at line 51 of file itkMultiGradientOptimizerv4.h.
typedef Superclass::StopConditionDescriptionType itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::StopConditionDescriptionType |
Stop condition internal string type
Definition at line 76 of file itkMultiGradientOptimizerv4.h.
typedef Superclass::StopConditionReturnStringType itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::StopConditionReturnStringType |
Stop condition return string type
Definition at line 73 of file itkMultiGradientOptimizerv4.h.
typedef Superclass::StopConditionType itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::StopConditionType |
Definition at line 70 of file itkMultiGradientOptimizerv4.h.
typedef GradientDescentOptimizerv4Template<TInternalComputationValueType> itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::Superclass |
Definition at line 52 of file itkMultiGradientOptimizerv4.h.
|
protected |
Default constructor
|
overrideprotectedvirtual |
Default constructor
|
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::GradientDescentOptimizerv4Template< TInternalComputationValueType >.
const MetricValuesListType& itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::GetMetricValuesList | ( | ) | const |
Get the list of metric values that we produced after the multi-objective search.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >.
OptimizersListType& itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::GetOptimizersList | ( | ) |
Get the list of optimizers currently held.
|
inlineoverridevirtual |
Get stop condition enum
Reimplemented from itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >.
Definition at line 93 of file itkMultiGradientOptimizerv4.h.
|
overridevirtual |
Get the reason for termination
Reimplemented from itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >.
|
static |
Method for creation through the object factory.
|
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::GradientDescentOptimizerv4Template< TInternalComputationValueType >.
|
overridevirtual |
Resume the optimization. Can be called after StopOptimization to resume. The bulk of the optimization work loop is here.
Reimplemented from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >.
void itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >::SetOptimizersList | ( | OptimizersListType & | p | ) |
Set the list of optimizers to combine
|
overridevirtual |
Begin the optimization
Reimplemented from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >.
|
overridevirtual |
Stop optimization. The object is left in a state so the optimization can be resumed by calling ResumeOptimization.
Reimplemented from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >.
|
protected |
Definition at line 137 of file itkMultiGradientOptimizerv4.h.
|
protected |
Definition at line 135 of file itkMultiGradientOptimizerv4.h.
|
protected |
Definition at line 136 of file itkMultiGradientOptimizerv4.h.
|
protected |
Definition at line 134 of file itkMultiGradientOptimizerv4.h.
|
protected |
Definition at line 131 of file itkMultiGradientOptimizerv4.h.
|
protected |
Definition at line 132 of file itkMultiGradientOptimizerv4.h.
|
protected |
Definition at line 133 of file itkMultiGradientOptimizerv4.h.