ITK
4.13.0
Insight Segmentation and Registration Toolkit
|
#include <itkMultiStartOptimizerv4.h>
Multi-start searches over input parameters and returns the best metric value.
The multi-start algorithm performs gradient descent from N (large) number of starting points and returns the best solution. Ideal start points would sample the solution space almost uniformly, thus, in theory, this is a global optimizer. In this implementation, the quality of the optimization depends on the parameter space samples that the user inputs to the optimizer. Multi-start can be modified in numerous ways to improve robustness of standard approaches. These improvements usually focus modifying the parameter sample space. This is why we place the burden on the user to provide the parameter samples over which to optimize.
Definition at line 40 of file itkMultiStartOptimizerv4.h.
Public Member Functions | |
virtual ::itk::LightObject::Pointer | CreateAnother () const |
ParametersType | GetBestParameters () |
ParameterListSizeType | GetBestParametersIndex () |
const MetricValuesListType & | GetMetricValuesList () const |
virtual const char * | GetNameOfClass () const |
ParametersListType & | GetParametersList () |
virtual const StopConditionType & | GetStopCondition () const |
virtual const StopConditionReturnStringType | GetStopConditionDescription () const override |
void | InstantiateLocalOptimizer () |
virtual void | ResumeOptimization () |
void | SetParametersList (ParametersListType &p) |
virtual void | StartOptimization (bool doOnlyInitialization=false) override |
virtual void | StopOptimization () |
virtual void | SetLocalOptimizer (OptimizerType *_arg) |
virtual OptimizerType * | GetModifiableLocalOptimizer () |
virtual const OptimizerType * | GetLocalOptimizer () const |
Public Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType > | |
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 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 |
Static Public Member Functions | |
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 | PrintSelf (std::ostream &os, Indent indent) const override |
MultiStartOptimizerv4Template () | |
virtual | ~MultiStartOptimizerv4Template () override |
Protected Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType > | |
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 () |
typedef SmartPointer< const Self > itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::ConstPointer |
Definition at line 48 of file itkMultiStartOptimizerv4.h.
typedef MetricType::DerivativeType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::DerivativeType |
Derivative type
Definition at line 91 of file itkMultiStartOptimizerv4.h.
typedef TInternalComputationValueType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::InternalComputationValueType |
Stop condition return string type It should be possible to derive the internal computation type from the class object.
Definition at line 84 of file itkMultiStartOptimizerv4.h.
typedef LocalOptimizerType::Pointer itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::LocalOptimizerPointer |
Definition at line 63 of file itkMultiStartOptimizerv4.h.
typedef itk::GradientDescentOptimizerv4Template<TInternalComputationValueType> itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::LocalOptimizerType |
Definition at line 62 of file itkMultiStartOptimizerv4.h.
typedef Superclass::MeasureType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::MeasureType |
Measure type
Definition at line 94 of file itkMultiStartOptimizerv4.h.
typedef Superclass::MetricType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::MetricType |
Metric type over which this class is templated
Definition at line 87 of file itkMultiStartOptimizerv4.h.
typedef MetricType::Pointer itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::MetricTypePointer |
Definition at line 88 of file itkMultiStartOptimizerv4.h.
typedef std::vector< MeasureType > itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::MetricValuesListType |
Definition at line 95 of file itkMultiStartOptimizerv4.h.
typedef OptimizerType::Pointer itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::OptimizerPointer |
Definition at line 61 of file itkMultiStartOptimizerv4.h.
typedef ObjectToObjectOptimizerBaseTemplate<TInternalComputationValueType> itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::OptimizerType |
Definition at line 60 of file itkMultiStartOptimizerv4.h.
typedef ParametersListType::size_type itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::ParameterListSizeType |
Definition at line 58 of file itkMultiStartOptimizerv4.h.
typedef std::vector< ParametersType > itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::ParametersListType |
Definition at line 57 of file itkMultiStartOptimizerv4.h.
typedef Superclass::ParametersType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::ParametersType |
Definition at line 54 of file itkMultiStartOptimizerv4.h.
typedef SmartPointer< Self > itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::Pointer |
Definition at line 47 of file itkMultiStartOptimizerv4.h.
typedef MultiStartOptimizerv4Template itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::Self |
Standard class typedefs.
Definition at line 45 of file itkMultiStartOptimizerv4.h.
typedef Superclass::StopConditionDescriptionType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::StopConditionDescriptionType |
Stop condition internal string type
Definition at line 79 of file itkMultiStartOptimizerv4.h.
typedef Superclass::StopConditionReturnStringType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::StopConditionReturnStringType |
Stop condition return string type
Definition at line 76 of file itkMultiStartOptimizerv4.h.
typedef ObjectToObjectOptimizerBaseTemplate<TInternalComputationValueType> itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::Superclass |
Definition at line 46 of file itkMultiStartOptimizerv4.h.
enum itk::MultiStartOptimizerv4Template::StopConditionType |
Codes of stopping conditions.
Enumerator | |
---|---|
MAXIMUM_NUMBER_OF_ITERATIONS | |
COSTFUNCTION_ERROR | |
UPDATE_PARAMETERS_ERROR | |
STEP_TOO_SMALL | |
CONVERGENCE_CHECKER_PASSED | |
OTHER_ERROR |
Definition at line 66 of file itkMultiStartOptimizerv4.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::Object.
ParametersType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::GetBestParameters | ( | ) |
Return the parameters from the best visited position
|
inline |
Definition at line 134 of file itkMultiStartOptimizerv4.h.
|
virtual |
Set/Get the optimizer.
const MetricValuesListType& itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::GetMetricValuesList | ( | ) | const |
Get the list of metric values that we produced after the multi-start search.
|
virtual |
Set/Get the optimizer.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.
ParametersListType& itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::GetParametersList | ( | ) |
Get the list of parameters over which to search.
|
virtual |
Get stop condition enum
|
overridevirtual |
Get the reason for termination
Implements itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.
void itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::InstantiateLocalOptimizer | ( | ) |
Create an instance of the local optimizer
|
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::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.
|
virtual |
Resume the optimization. Can be called after StopOptimization to resume. The bulk of the optimization work loop is here.
|
virtual |
Set/Get the optimizer.
void itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::SetParametersList | ( | ParametersListType & | p | ) |
Set the list of parameters over which to search
|
overridevirtual |
Begin the optimization
Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.
|
virtual |
Stop optimization. The object is left in a state so the optimization can be resumed by calling ResumeOptimization.
|
protected |
Definition at line 152 of file itkMultiStartOptimizerv4.h.
|
protected |
Definition at line 153 of file itkMultiStartOptimizerv4.h.
|
protected |
Definition at line 151 of file itkMultiStartOptimizerv4.h.
|
protected |
Definition at line 149 of file itkMultiStartOptimizerv4.h.
|
protected |
Definition at line 150 of file itkMultiStartOptimizerv4.h.
|
protected |
Definition at line 148 of file itkMultiStartOptimizerv4.h.
|
protected |
Definition at line 145 of file itkMultiStartOptimizerv4.h.
|
protected |
Definition at line 146 of file itkMultiStartOptimizerv4.h.
|
protected |
Definition at line 147 of file itkMultiStartOptimizerv4.h.