![]() |
ITK
4.13.0
Insight Segmentation and Registration Toolkit
|
#include <itkSingleValuedNonLinearVnlOptimizer.h>
This class is a base for the Optimization methods that optimize a single valued function.
It is an Adaptor class for optimizers provided by the vnl library
Definition at line 37 of file itkSingleValuedNonLinearVnlOptimizer.h.
Public Member Functions | |
virtual const char * | GetNameOfClass () const |
virtual void | SetCostFunction (SingleValuedCostFunction *costFunction) override=0 |
virtual const bool & | GetMaximize () const |
virtual void | SetMaximize (bool _arg) |
virtual void | MaximizeOn () |
virtual void | MaximizeOff () |
bool | GetMinimize () const |
void | SetMinimize (bool v) |
void | MinimizeOn () |
void | MinimizeOff () |
virtual const MeasureType & | GetCachedValue () const |
virtual const DerivativeType & | GetCachedDerivative () const |
virtual const ParametersType & | GetCachedCurrentPosition () const |
![]() | |
virtual ::itk::LightObject::Pointer | CreateAnother () const |
virtual const CostFunctionType * | GetCostFunction () const |
virtual CostFunctionType * | GetModifiableCostFunction () |
MeasureType | GetValue (const ParametersType ¶meters) const |
virtual void | SetCostFunction (CostFunctionType *costFunction) |
![]() | |
virtual const ParametersType & | GetCurrentPosition () const |
virtual const ParametersType & | GetInitialPosition () const |
virtual const std::string | GetStopConditionDescription () const |
virtual void | SetInitialPosition (const ParametersType ¶m) |
void | SetScales (const ScalesType &scales) |
virtual void | StartOptimization () |
virtual const ScalesType & | GetScales () const |
virtual const ScalesType & | GetInverseScales () const |
![]() | |
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 |
Protected Types | |
typedef SingleValuedVnlCostFunctionAdaptor | CostFunctionAdaptorType |
Protected Member Functions | |
const CostFunctionAdaptorType * | GetCostFunctionAdaptor () const |
CostFunctionAdaptorType * | GetCostFunctionAdaptor () |
CostFunctionAdaptorType * | GetNonConstCostFunctionAdaptor () const |
virtual void | PrintSelf (std::ostream &os, Indent indent) const override |
void | SetCostFunctionAdaptor (CostFunctionAdaptorType *adaptor) |
SingleValuedNonLinearVnlOptimizer () | |
virtual | ~SingleValuedNonLinearVnlOptimizer () override |
![]() | |
SingleValuedNonLinearOptimizer () | |
virtual | ~SingleValuedNonLinearOptimizer () override |
![]() | |
NonLinearOptimizer () | |
virtual | ~NonLinearOptimizer () override |
![]() | |
Optimizer () | |
virtual void | SetCurrentPosition (const ParametersType ¶m) |
virtual | ~Optimizer () override |
![]() | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
virtual void | SetTimeStamp (const TimeStamp &time) |
virtual | ~Object () override |
![]() | |
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 | |
void | IterationReport (const EventObject &event) |
Additional Inherited Members | |
![]() | |
static Pointer | New () |
![]() | |
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 () |
![]() | |
CostFunctionPointer | m_CostFunction |
![]() | |
ParametersType | m_CurrentPosition |
bool | m_ScalesInitialized |
![]() | |
AtomicInt< int > | m_ReferenceCount |
Command observer that will interact with the ITKVNL cost-function adaptor in order to generate iteration events. This will allow to overcome the limitation of VNL optimizers not offering callbacks for every iteration
Definition at line 49 of file itkSingleValuedNonLinearVnlOptimizer.h.
typedef SmartPointer< const Self > itk::SingleValuedNonLinearVnlOptimizer::ConstPointer |
Definition at line 45 of file itkSingleValuedNonLinearVnlOptimizer.h.
|
protected |
Definition at line 97 of file itkSingleValuedNonLinearVnlOptimizer.h.
Definition at line 44 of file itkSingleValuedNonLinearVnlOptimizer.h.
Standard class typedefs.
Definition at line 42 of file itkSingleValuedNonLinearVnlOptimizer.h.
Definition at line 43 of file itkSingleValuedNonLinearVnlOptimizer.h.
|
protected |
|
overrideprotectedvirtual |
|
virtual |
Return Cached Values. These method have the advantage of not triggering a recomputation of the metric value, but it has the disadvantage of returning a value that may not be the one corresponding to the current parameters. For GUI update purposes, this method is a good option, for mathematical validation you should rather call GetValue().
|
virtual |
Return Cached Values. These method have the advantage of not triggering a recomputation of the metric value, but it has the disadvantage of returning a value that may not be the one corresponding to the current parameters. For GUI update purposes, this method is a good option, for mathematical validation you should rather call GetValue().
|
virtual |
Return Cached Values. These method have the advantage of not triggering a recomputation of the metric value, but it has the disadvantage of returning a value that may not be the one corresponding to the current parameters. For GUI update purposes, this method is a good option, for mathematical validation you should rather call GetValue().
|
protected |
|
protected |
|
virtual |
Methods to define whether the cost function will be maximized or minimized. By default the VNL amoeba optimizer is only a minimizer. Maximization is implemented here by notifying the CostFunctionAdaptor which in its turn will multiply the function values and its derivative by -1.0.
|
inline |
Methods to define whether the cost function will be maximized or minimized. By default the VNL amoeba optimizer is only a minimizer. Maximization is implemented here by notifying the CostFunctionAdaptor which in its turn will multiply the function values and its derivative by -1.0.
Definition at line 73 of file itkSingleValuedNonLinearVnlOptimizer.h.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::SingleValuedNonLinearOptimizer.
Reimplemented in itk::LBFGSOptimizer, itk::AmoebaOptimizer, itk::LBFGSBOptimizer, and itk::ConjugateGradientOptimizer.
|
protected |
The purpose of this method is to get around the lack of const-correctness in VNL cost-functions and optimizers
|
private |
Callback function for the Command Observer
|
virtual |
Methods to define whether the cost function will be maximized or minimized. By default the VNL amoeba optimizer is only a minimizer. Maximization is implemented here by notifying the CostFunctionAdaptor which in its turn will multiply the function values and its derivative by -1.0.
|
virtual |
Methods to define whether the cost function will be maximized or minimized. By default the VNL amoeba optimizer is only a minimizer. Maximization is implemented here by notifying the CostFunctionAdaptor which in its turn will multiply the function values and its derivative by -1.0.
|
inline |
Methods to define whether the cost function will be maximized or minimized. By default the VNL amoeba optimizer is only a minimizer. Maximization is implemented here by notifying the CostFunctionAdaptor which in its turn will multiply the function values and its derivative by -1.0.
Definition at line 79 of file itkSingleValuedNonLinearVnlOptimizer.h.
|
inline |
Methods to define whether the cost function will be maximized or minimized. By default the VNL amoeba optimizer is only a minimizer. Maximization is implemented here by notifying the CostFunctionAdaptor which in its turn will multiply the function values and its derivative by -1.0.
Definition at line 77 of file itkSingleValuedNonLinearVnlOptimizer.h.
|
overrideprotectedvirtual |
Print out internal state
Reimplemented from itk::SingleValuedNonLinearOptimizer.
Reimplemented in itk::LBFGSBOptimizer, itk::LBFGSOptimizer, and itk::AmoebaOptimizer.
|
overridepure virtual |
Set the cost Function. This method has to be overloaded by derived classes because the CostFunctionAdaptor requires to know the number of parameters at construction time. This number of parameters is obtained at run-time from the itkCostFunction. As a consequence each derived optimizer should construct its own CostFunctionAdaptor when overloading this method
Implemented in itk::LBFGSOptimizer, itk::LBFGSBOptimizer, itk::AmoebaOptimizer, and itk::ConjugateGradientOptimizer.
|
protected |
|
virtual |
Methods to define whether the cost function will be maximized or minimized. By default the VNL amoeba optimizer is only a minimizer. Maximization is implemented here by notifying the CostFunctionAdaptor which in its turn will multiply the function values and its derivative by -1.0.
|
inline |
Methods to define whether the cost function will be maximized or minimized. By default the VNL amoeba optimizer is only a minimizer. Maximization is implemented here by notifying the CostFunctionAdaptor which in its turn will multiply the function values and its derivative by -1.0.
Definition at line 75 of file itkSingleValuedNonLinearVnlOptimizer.h.
|
mutableprivate |
Definition at line 124 of file itkSingleValuedNonLinearVnlOptimizer.h.
|
mutableprivate |
Definition at line 126 of file itkSingleValuedNonLinearVnlOptimizer.h.
|
mutableprivate |
Definition at line 125 of file itkSingleValuedNonLinearVnlOptimizer.h.
|
private |
Definition at line 122 of file itkSingleValuedNonLinearVnlOptimizer.h.
|
private |
Definition at line 116 of file itkSingleValuedNonLinearVnlOptimizer.h.
|
private |
Definition at line 120 of file itkSingleValuedNonLinearVnlOptimizer.h.