Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itkLBFGSOptimizer.h

Go to the documentation of this file.
00001 /*=========================================================================
00002 
00003   Program:   Insight Segmentation & Registration Toolkit
00004   Module:    $RCSfile: itkLBFGSOptimizer.h,v $
00005   Language:  C++
00006   Date:      $Date: 2009-09-16 15:19:20 $
00007   Version:   $Revision: 1.22 $
00008 
00009   Copyright (c) Insight Software Consortium. All rights reserved.
00010   See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
00011 
00012      This software is distributed WITHOUT ANY WARRANTY; without even 
00013      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
00014      PURPOSE.  See the above copyright notices for more information.
00015 
00016 =========================================================================*/
00017 #ifndef __itkLBFGSOptimizer_h
00018 #define __itkLBFGSOptimizer_h
00019 
00020 #include "itkSingleValuedNonLinearVnlOptimizer.h"
00021 #include "vnl/algo/vnl_lbfgs.h"
00022 
00023 namespace itk
00024 {
00025   
00031 class ITK_EXPORT LBFGSOptimizer : 
00032     public SingleValuedNonLinearVnlOptimizer
00033 {
00034 public:
00036   typedef LBFGSOptimizer                     Self;
00037   typedef SingleValuedNonLinearVnlOptimizer  Superclass;
00038   typedef SmartPointer<Self>                 Pointer;
00039   typedef SmartPointer<const Self>           ConstPointer;
00040 
00042   itkNewMacro(Self);
00043 
00045   itkTypeMacro( LBFGSOptimizer, SingleValuedNonLinearVnlOptimizer );
00046 
00048   typedef   vnl_vector<double>     InternalParametersType;
00049 
00051   typedef   vnl_lbfgs             InternalOptimizerType;
00052 
00054   vnl_lbfgs * GetOptimizer(void);
00055 
00057   void StartOptimization( void );
00058 
00060   virtual void SetCostFunction( SingleValuedCostFunction * costFunction );
00061 
00065   virtual void SetTrace( bool flag );
00066   itkGetMacro( Trace, bool );
00067   itkBooleanMacro( Trace );
00069 
00071   virtual void SetMaximumNumberOfFunctionEvaluations( unsigned int n );
00072   itkGetMacro( MaximumNumberOfFunctionEvaluations, unsigned int );
00074 
00080   virtual void SetGradientConvergenceTolerance( double gtol );
00081   itkGetMacro( GradientConvergenceTolerance, double );
00083 
00090   virtual void SetLineSearchAccuracy( double tol );
00091   itkGetMacro( LineSearchAccuracy, double );
00093 
00098   virtual void SetDefaultStepLength( double stp );
00099   itkGetMacro( DefaultStepLength, double );
00101 
00103   MeasureType GetValue() const;
00104 
00106   const std::string GetStopConditionDescription() const;
00107 
00108 protected:
00109   LBFGSOptimizer();
00110   virtual ~LBFGSOptimizer();
00111   void PrintSelf(std::ostream& os, Indent indent) const;
00112 
00113   typedef Superclass::CostFunctionAdaptorType   CostFunctionAdaptorType;
00114 
00115 private:
00116   LBFGSOptimizer(const Self&); //purposely not implemented
00117   void operator=(const Self&); //purposely not implemented
00118   
00119   bool                          m_OptimizerInitialized;
00120   InternalOptimizerType       * m_VnlOptimizer;
00121   mutable OStringStream         m_StopConditionDescription;
00122 
00123   bool                          m_Trace;
00124   unsigned int                  m_MaximumNumberOfFunctionEvaluations;
00125   double                        m_GradientConvergenceTolerance;
00126   double                        m_LineSearchAccuracy;
00127   double                        m_DefaultStepLength;
00128 
00129 };
00130 
00131 } // end namespace itk
00132 
00133 #endif
00134 

Generated at Mon Jul 12 2010 19:02:46 for ITK by doxygen 1.7.1 written by Dimitri van Heesch, © 1997-2000