![]() |
ITK
4.13.0
Insight Segmentation and Registration Toolkit
|
#include <itkFRPROptimizer.h>
Implements Fletch-Reeves & Polak-Ribiere optimization using dBrent line search.
This optimizer needs a cost function. This optimizer needs to be able to compute partial derivatives of the cost function with respect to each parameter.
The SetStepLength determines the initial distance to step in a line direction when bounding the minimum (using bracketing triple spaced using a derivative-based search strategy).
The StepTolerance terminates optimization when the parameter values are known to be within this (scaled) distance of the local extreme.
The ValueTolerance terminates optimization when the cost function values at the current parameters and at the local extreme are likely (within a second order approximation) to be within this is tolerance.
Definition at line 50 of file itkFRPROptimizer.h.
Public Member Functions | |
virtual ::itk::LightObject::Pointer | CreateAnother () const |
virtual const char * | GetNameOfClass () const |
void | SetToFletchReeves () |
void | SetToPolakRibiere () |
virtual void | StartOptimization () override |
virtual void | SetUseUnitLengthGradient (bool _arg) |
virtual bool | GetUseUnitLengthGradient () const |
![]() | |
virtual ::itk::LightObject::Pointer | CreateAnother () const |
virtual const bool & | GetCatchGetValueException () const |
virtual const unsigned int & | GetCurrentIteration () const |
virtual const unsigned int & | GetCurrentLineIteration () const |
virtual const double & | GetMetricWorstPossibleValue () const |
virtual const std::string | GetStopConditionDescription () const override |
virtual void | SetCatchGetValueException (bool _arg) |
virtual void | SetMetricWorstPossibleValue (double _arg) |
void | StopOptimization () |
virtual void | SetMaximize (bool _arg) |
virtual void | MaximizeOn () |
virtual void | MaximizeOff () |
virtual const bool & | GetMaximize () const |
virtual void | SetMaximumIteration (unsigned int _arg) |
virtual const unsigned int & | GetMaximumIteration () const |
virtual void | SetMaximumLineIteration (unsigned int _arg) |
virtual unsigned int | GetMaximumLineIteration () const |
virtual void | SetStepLength (double _arg) |
virtual const double & | GetStepLength () const |
virtual void | SetStepTolerance (double _arg) |
virtual const double & | GetStepTolerance () const |
virtual void | SetValueTolerance (double _arg) |
virtual const double & | GetValueTolerance () const |
virtual const MeasureType & | GetCurrentCost () const |
MeasureType | GetValue () 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 void | SetInitialPosition (const ParametersType ¶m) |
void | SetScales (const ScalesType &scales) |
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 |
Static Public Member Functions | |
static Pointer | New () |
![]() | |
static Pointer | New () |
![]() | |
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 () |
Protected Member Functions | |
FRPROptimizer () | |
virtual void | GetValueAndDerivative (ParametersType &p, double *val, ParametersType *xi) |
virtual void | LineOptimize (ParametersType *p, ParametersType &xi, double *val) |
virtual void | LineOptimize (ParametersType *p, ParametersType &xi, double *val, ParametersType &tempCoord) |
virtual void | PrintSelf (std::ostream &os, Indent indent) const override |
virtual | ~FRPROptimizer () override |
![]() | |
virtual void | BracketedLineOptimize (double ax, double bx, double cx, double fa, double fb, double fc, double *extX, double *extVal) |
virtual void | BracketedLineOptimize (double ax, double bx, double cx, double fa, double fb, double fc, double *extX, double *extVal, ParametersType &tempCoord) |
double | GetLineValue (double x) const |
double | GetLineValue (double x, ParametersType &tempCoord) const |
virtual unsigned int | GetSpaceDimension () |
virtual bool | GetStop () |
virtual void | LineBracket (double *ax, double *bx, double *cx, double *fa, double *fb, double *fc) |
virtual void | LineBracket (double *ax, double *bx, double *cx, double *fa, double *fb, double *fc, ParametersType &tempCoord) |
PowellOptimizer () | |
PowellOptimizer (const PowellOptimizer &) | |
virtual void | SetCurrentCost (double _arg) |
virtual void | SetCurrentIteration (unsigned int _arg) |
void | SetCurrentLinePoint (double x, double fx) |
void | SetLine (const ParametersType &origin, const vnl_vector< double > &direction) |
void | SetSpaceDimension (unsigned int dim) |
virtual void | SetStop (bool _arg) |
void | Shift (double *a, double *b, double *c, double d) const |
void | Swap (double *a, double *b) const |
virtual | ~PowellOptimizer () 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 Types | |
enum | OptimizationType { FletchReeves, PolakRibiere } |
Private Member Functions | |
FRPROptimizer (const FRPROptimizer &) | |
Private Attributes | |
OptimizationType | m_OptimizationType |
bool | m_UseUnitLengthGradient |
Additional Inherited Members | |
![]() | |
CostFunctionPointer | m_CostFunction |
![]() | |
ParametersType | m_CurrentPosition |
bool | m_ScalesInitialized |
![]() | |
AtomicInt< int > | m_ReferenceCount |
typedef SmartPointer< const Self > itk::FRPROptimizer::ConstPointer |
Definition at line 58 of file itkFRPROptimizer.h.
Definition at line 70 of file itkFRPROptimizer.h.
Type of the Cost Function
Definition at line 66 of file itkFRPROptimizer.h.
Definition at line 60 of file itkFRPROptimizer.h.
typedef SmartPointer< Self > itk::FRPROptimizer::Pointer |
Definition at line 57 of file itkFRPROptimizer.h.
Standard "Self" typedef.
Definition at line 55 of file itkFRPROptimizer.h.
Definition at line 56 of file itkFRPROptimizer.h.
|
private |
Enumerator | |
---|---|
FletchReeves | |
PolakRibiere |
Definition at line 108 of file itkFRPROptimizer.h.
|
protected |
|
overrideprotectedvirtual |
|
private |
|
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::PowellOptimizer.
|
virtual |
Convert gradient to a unit length vector
|
protectedvirtual |
Get the value of the n-dimensional cost function at this scalar step distance along the current line direction from the current line origin. Line origin and distances are set via SetLine
|
protectedvirtual |
|
protectedvirtual |
|
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::PowellOptimizer.
void itk::FRPROptimizer::SetToFletchReeves | ( | ) |
Set it to the Fletch-Reeves optimizer
void itk::FRPROptimizer::SetToPolakRibiere | ( | ) |
Set it to the Fletch-Reeves optimizer
|
virtual |
Convert gradient to a unit length vector
|
overridevirtual |
Start optimization.
Reimplemented from itk::PowellOptimizer.
|
private |
Definition at line 113 of file itkFRPROptimizer.h.
|
private |
Definition at line 115 of file itkFRPROptimizer.h.