ITK  4.6.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
itk::FRPROptimizer Class Reference
Numerics | Optimizers | Module ITKOptimizers

#include <itkFRPROptimizer.h>

+ Inheritance diagram for itk::FRPROptimizer:
+ Collaboration diagram for itk::FRPROptimizer:

Detailed Description

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 49 of file itkFRPROptimizer.h.

Public Types

typedef SmartPointer< const Self > ConstPointer
 
typedef CostFunctionType::Pointer CostFunctionPointer
 
typedef SingleValuedCostFunction CostFunctionType
 
typedef
SingleValuedNonLinearOptimizer::ParametersType 		ParametersType
 
typedef SmartPointer< Self > Pointer
 
typedef FRPROptimizer Self
 
typedef PowellOptimizer Superclass
 
- Public Types inherited from itk::PowellOptimizer
typedef SmartPointer< const Self > ConstPointer
 
typedef CostFunctionType::Pointer CostFunctionPointer
 
typedef SingleValuedCostFunction CostFunctionType
 
typedef
SingleValuedNonLinearOptimizer::ParametersType 		ParametersType
 
typedef SmartPointer< Self > Pointer
 
typedef PowellOptimizer Self
 
typedef
SingleValuedNonLinearOptimizer 		Superclass
 
- Public Types inherited from itk::SingleValuedNonLinearOptimizer
typedef SmartPointer< const Self > ConstPointer
 
typedef CostFunctionType::Pointer CostFunctionPointer
 
typedef SingleValuedCostFunction CostFunctionType
 
typedef
CostFunctionType::DerivativeType 		DerivativeType
 
typedef
CostFunctionType::MeasureType 		MeasureType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< Self > Pointer
 
typedef
SingleValuedNonLinearOptimizer 		Self
 
typedef NonLinearOptimizer Superclass
 
- Public Types inherited from itk::NonLinearOptimizer
typedef SmartPointer< const Self > ConstPointer
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< Self > Pointer
 
typedef Superclass::ScalesType ScalesType
 
typedef NonLinearOptimizer Self
 
typedef Optimizer Superclass
 
- Public Types inherited from itk::Optimizer
typedef SmartPointer< const Self > ConstPointer
 
typedef OptimizerParameters
< double > 		ParametersType
 
typedef SmartPointer< Self > Pointer
 
typedef Array< double > ScalesType
 
typedef Optimizer Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
void SetToFletchReeves ()
 
void SetToPolakRibiere ()
 
virtual void StartOptimization () ITK_OVERRIDE
 
virtual void SetUseUnitLengthGradient (bool _arg)
 
virtual bool GetUseUnitLengthGradient () const
 
- Public Member Functions inherited from itk::PowellOptimizer
virtual ::itk::LightObject::Pointer CreateAnother (void) 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 ITK_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
 
- Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const CostFunctionType * GetCostFunction () const
 
virtual CostFunctionType * GetModifiableCostFunction ()
 
MeasureType GetValue (const ParametersType &parameters) const
 
virtual void SetCostFunction (CostFunctionType *costFunction)
 
- Public Member Functions inherited from itk::Optimizer
virtual const ParametersType & GetCurrentPosition () const
 
virtual const ParametersType & GetInitialPosition () const
 
virtual void SetInitialPosition (const ParametersType &param)
 
void SetScales (const ScalesType &scales)
 
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
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::PowellOptimizer
static Pointer New ()
 
- Static Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer
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 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 ITK_OVERRIDE
 
virtual ~FRPROptimizer ()
 
- Protected Member Functions inherited from itk::PowellOptimizer
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 ()
 
- Protected Member Functions inherited from itk::SingleValuedNonLinearOptimizer
 SingleValuedNonLinearOptimizer ()
 
virtual ~SingleValuedNonLinearOptimizer ()
 
- Protected Member Functions inherited from itk::NonLinearOptimizer
 NonLinearOptimizer ()
 
virtual ~NonLinearOptimizer ()
 
- Protected Member Functions inherited from itk::Optimizer
 Optimizer ()
 
virtual void SetCurrentPosition (const ParametersType &param)
 
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 Types

enum  OptimizationType {
  FletchReeves,
  PolakRibiere
}
 

Private Member Functions

 FRPROptimizer (const FRPROptimizer &)
 

Private Attributes

OptimizationType m_OptimizationType
 
bool m_UseUnitLengthGradient
 

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::SingleValuedNonLinearOptimizer
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
 

Member Typedef Documentation

typedef SmartPointer< const Self > itk::FRPROptimizer::ConstPointer

Definition at line 57 of file itkFRPROptimizer.h.

typedef CostFunctionType::Pointer itk::FRPROptimizer::CostFunctionPointer

Definition at line 69 of file itkFRPROptimizer.h.

typedef SingleValuedCostFunction itk::FRPROptimizer::CostFunctionType

Type of the Cost Function

Definition at line 65 of file itkFRPROptimizer.h.

typedef SingleValuedNonLinearOptimizer::ParametersType itk::FRPROptimizer::ParametersType

Definition at line 59 of file itkFRPROptimizer.h.

typedef SmartPointer< Self > itk::FRPROptimizer::Pointer

Definition at line 56 of file itkFRPROptimizer.h.

typedef FRPROptimizer itk::FRPROptimizer::Self

Standard "Self" typedef.

Definition at line 54 of file itkFRPROptimizer.h.

typedef PowellOptimizer itk::FRPROptimizer::Superclass

Definition at line 55 of file itkFRPROptimizer.h.

Member Enumeration Documentation

enum itk::FRPROptimizer::OptimizationType
private
Enumerator
FletchReeves 
PolakRibiere 

Definition at line 107 of file itkFRPROptimizer.h.

Constructor & Destructor Documentation

itk::FRPROptimizer::FRPROptimizer ( )
protected
virtual itk::FRPROptimizer::~FRPROptimizer ( )
protectedvirtual
itk::FRPROptimizer::FRPROptimizer ( const FRPROptimizer &  )
private

Member Function Documentation

virtual::itk::LightObject::Pointer itk::FRPROptimizer::CreateAnother ( void  ) const
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 const char* itk::FRPROptimizer::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::PowellOptimizer.

virtual bool itk::FRPROptimizer::GetUseUnitLengthGradient ( ) const
virtual

Convert gradient to a unit length vector

virtual void itk::FRPROptimizer::GetValueAndDerivative ( ParametersType &  p,
double *  val,
ParametersType *  xi 
)
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

virtual void itk::FRPROptimizer::LineOptimize ( ParametersType *  p,
ParametersType &  xi,
double *  val 
)
protectedvirtual
virtual void itk::FRPROptimizer::LineOptimize ( ParametersType *  p,
ParametersType &  xi,
double *  val,
ParametersType &  tempCoord 
)
protectedvirtual
static Pointer itk::FRPROptimizer::New ( )
static

Method for creation through the object factory.

virtual void itk::FRPROptimizer::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
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::PowellOptimizer.

void itk::FRPROptimizer::SetToFletchReeves ( )

Set it to the Fletch-Reeves optimizer

void itk::FRPROptimizer::SetToPolakRibiere ( )

Set it to the Fletch-Reeves optimizer

virtual void itk::FRPROptimizer::SetUseUnitLengthGradient ( bool  _arg)
virtual

Convert gradient to a unit length vector

virtual void itk::FRPROptimizer::StartOptimization ( )
virtual

Start optimization.

Reimplemented from itk::PowellOptimizer.

Member Data Documentation

OptimizationType itk::FRPROptimizer::m_OptimizationType
private

Definition at line 112 of file itkFRPROptimizer.h.

bool itk::FRPROptimizer::m_UseUnitLengthGradient
private

Definition at line 114 of file itkFRPROptimizer.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Mon Jul 21 2014 01:42:05 for ITK by   doxygen 1.8.5