ITK
4.6.0
Insight Segmentation and Registration Toolkit
|
#include <itkMultipleValuedNonLinearVnlOptimizer.h>
This class is a base for the Optimization methods that optimize a multi-valued function.
It is an Adaptor class for optimizers provided by the vnl library
Definition at line 36 of file itkMultipleValuedNonLinearVnlOptimizer.h.
Public Member Functions | |
virtual const char * | GetNameOfClass () const |
bool | GetUseCostFunctionGradient () const |
virtual void | SetCostFunction (MultipleValuedCostFunction *costFunction)=0 |
void | SetUseCostFunctionGradient (bool) |
void | UseCostFunctionGradientOff () |
void | UseCostFunctionGradientOn () |
virtual const MeasureType & | GetCachedValue () const |
virtual const DerivativeType & | GetCachedDerivative () const |
virtual const ParametersType & | GetCachedCurrentPosition () const |
Public Member Functions inherited from itk::MultipleValuedNonLinearOptimizer | |
virtual ::itk::LightObject::Pointer | CreateAnother (void) const |
virtual void | SetCostFunction (CostFunctionType *costFunction) |
Public Member Functions inherited from itk::NonLinearOptimizer | |
virtual ::itk::LightObject::Pointer | CreateAnother (void) const |
Public Member Functions inherited from itk::Optimizer | |
virtual ::itk::LightObject::Pointer | CreateAnother (void) const |
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 |
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 |
Protected Types | |
typedef ReceptorMemberCommand < Self > | CommandType |
typedef MultipleValuedVnlCostFunctionAdaptor | CostFunctionAdaptorType |
Protected Types inherited from itk::LightObject | |
typedef int | InternalReferenceCountType |
Protected Member Functions | |
const CostFunctionAdaptorType * | GetCostFunctionAdaptor (void) const |
CostFunctionAdaptorType * | GetCostFunctionAdaptor (void) |
CostFunctionAdaptorType * | GetNonConstCostFunctionAdaptor (void) const |
MultipleValuedNonLinearVnlOptimizer () | |
virtual void | PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE |
void | SetCostFunctionAdaptor (CostFunctionAdaptorType *adaptor) |
virtual | ~MultipleValuedNonLinearVnlOptimizer () |
Protected Member Functions inherited from itk::MultipleValuedNonLinearOptimizer | |
MultipleValuedNonLinearOptimizer () | |
virtual | ~MultipleValuedNonLinearOptimizer () |
Protected Member Functions inherited from itk::NonLinearOptimizer | |
NonLinearOptimizer () | |
virtual | ~NonLinearOptimizer () |
Protected Member Functions inherited from itk::Optimizer | |
Optimizer () | |
virtual void | SetCurrentPosition (const ParametersType ¶m) |
virtual | ~Optimizer () |
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 | |
void | IterationReport (const EventObject &event) |
MultipleValuedNonLinearVnlOptimizer (const Self &) | |
void | operator= (const Self &) |
Additional Inherited Members | |
Static Public Member Functions inherited from itk::MultipleValuedNonLinearOptimizer | |
static Pointer | New () |
Static Public Member Functions inherited from itk::NonLinearOptimizer | |
static Pointer | New () |
Static Public Member Functions inherited from itk::Optimizer | |
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 Attributes inherited from itk::MultipleValuedNonLinearOptimizer | |
CostFunctionPointer | m_CostFunction |
Protected Attributes inherited from itk::Optimizer | |
ParametersType | m_CurrentPosition |
bool | m_ScalesInitialized |
Protected Attributes inherited from itk::LightObject | |
InternalReferenceCountType | m_ReferenceCount |
SimpleFastMutexLock | m_ReferenceCountLock |
|
protected |
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 112 of file itkMultipleValuedNonLinearVnlOptimizer.h.
typedef SmartPointer< const Self > itk::MultipleValuedNonLinearVnlOptimizer::ConstPointer |
Definition at line 44 of file itkMultipleValuedNonLinearVnlOptimizer.h.
|
protected |
Definition at line 96 of file itkMultipleValuedNonLinearVnlOptimizer.h.
typedef Superclass::ParametersType itk::MultipleValuedNonLinearVnlOptimizer::ParametersType |
ParametersType typedef. It defines a position in the optimization search space.
Definition at line 48 of file itkMultipleValuedNonLinearVnlOptimizer.h.
Definition at line 43 of file itkMultipleValuedNonLinearVnlOptimizer.h.
Standard class typedefs.
Definition at line 41 of file itkMultipleValuedNonLinearVnlOptimizer.h.
Definition at line 42 of file itkMultipleValuedNonLinearVnlOptimizer.h.
|
protected |
|
protectedvirtual |
|
private |
|
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 |
Run-time type information (and related methods).
Reimplemented from itk::MultipleValuedNonLinearOptimizer.
Reimplemented in itk::LevenbergMarquardtOptimizer.
|
protected |
The purpose of this method is to get around the lack of const correctness in vnl cost_functions and optimizers
bool itk::MultipleValuedNonLinearVnlOptimizer::GetUseCostFunctionGradient | ( | ) | const |
|
private |
Callback function for the Command Observer
|
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::MultipleValuedNonLinearOptimizer.
|
pure 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::LevenbergMarquardtOptimizer.
|
protected |
void itk::MultipleValuedNonLinearVnlOptimizer::SetUseCostFunctionGradient | ( | bool | ) |
Define if the Cost function should provide a customized Gradient computation or the gradient can be computed internally using a default approach
Referenced by UseCostFunctionGradientOff(), and UseCostFunctionGradientOn().
|
inline |
Definition at line 72 of file itkMultipleValuedNonLinearVnlOptimizer.h.
References SetUseCostFunctionGradient().
|
inline |
Definition at line 67 of file itkMultipleValuedNonLinearVnlOptimizer.h.
References SetUseCostFunctionGradient().
|
mutableprivate |
Definition at line 126 of file itkMultipleValuedNonLinearVnlOptimizer.h.
|
mutableprivate |
Definition at line 128 of file itkMultipleValuedNonLinearVnlOptimizer.h.
|
mutableprivate |
Definition at line 127 of file itkMultipleValuedNonLinearVnlOptimizer.h.
|
private |
Definition at line 124 of file itkMultipleValuedNonLinearVnlOptimizer.h.
|
private |
Definition at line 121 of file itkMultipleValuedNonLinearVnlOptimizer.h.
|
private |
Definition at line 122 of file itkMultipleValuedNonLinearVnlOptimizer.h.