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

itkPowellOptimizer.h

Go to the documentation of this file.
00001 /*=========================================================================
00002 
00003   Program:   Insight Segmentation & Registration Toolkit
00004   Module:    $RCSfile: itkPowellOptimizer.h,v $
00005   Language:  C++
00006   Date:      $Date: 2008-04-29 23:33:33 $
00007   Version:   $Revision: 1.11 $
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 __itkPowellOptimizer_h
00018 #define __itkPowellOptimizer_h
00019 
00020 #include <itkVector.h>
00021 #include <itkMatrix.h>
00022 #include <itkSingleValuedNonLinearOptimizer.h>
00023 
00024 namespace itk
00025 {
00026 
00060 class ITK_EXPORT PowellOptimizer: 
00061     public SingleValuedNonLinearOptimizer
00062 {
00063 public:
00065   typedef PowellOptimizer                Self;
00066   typedef SingleValuedNonLinearOptimizer Superclass;
00067   typedef SmartPointer<Self>             Pointer;
00068   typedef SmartPointer<const Self>       ConstPointer;
00069 
00070   typedef SingleValuedNonLinearOptimizer::ParametersType
00071                                               ParametersType;
00072   
00074   itkNewMacro(Self);
00075 
00077   itkTypeMacro(PowellOptimizer, SingleValuedNonLinearOptimizer );
00078 
00080   typedef  SingleValuedCostFunction         CostFunctionType;
00081   typedef  CostFunctionType::Pointer        CostFunctionPointer;
00082 
00084   itkSetMacro( Maximize, bool );
00085   itkGetConstReferenceMacro( Maximize, bool );
00087 
00089   itkSetMacro( MaximumIteration, unsigned int );
00090   itkGetConstReferenceMacro( MaximumIteration, unsigned int );
00092 
00094   itkSetMacro(MaximumLineIteration, unsigned int);
00095   itkGetConstMacro(MaximumLineIteration, unsigned int);
00097 
00100   itkSetMacro( StepLength, double );
00101   itkGetConstReferenceMacro( StepLength, double );
00103 
00106   itkSetMacro( StepTolerance, double );
00107   itkGetConstReferenceMacro( StepTolerance, double );
00109 
00113   itkSetMacro( ValueTolerance, double );
00114   itkGetConstReferenceMacro( ValueTolerance, double );
00116 
00118   itkGetConstReferenceMacro( CurrentCost, MeasureType );
00119   MeasureType GetValue() const { return this->GetCurrentCost(); }
00121 
00123   itkGetConstReferenceMacro( CurrentIteration, unsigned int);
00124 
00126   itkGetConstReferenceMacro( CurrentLineIteration, unsigned int);
00127 
00129   void StartOptimization();
00130 
00134   void StopOptimization() 
00135     { m_Stop = true; }
00136 
00137   itkGetMacro(CatchGetValueException, bool);
00138   itkSetMacro(CatchGetValueException, bool);
00139 
00140   itkGetMacro(MetricWorstPossibleValue, double);
00141   itkSetMacro(MetricWorstPossibleValue, double);
00142 
00143 
00144 protected:
00145   PowellOptimizer();
00146   PowellOptimizer(const PowellOptimizer&);
00147   virtual ~PowellOptimizer();
00148   void PrintSelf(std::ostream& os, Indent indent) const;
00149 
00150   itkSetMacro(CurrentCost, double);
00151 
00154   void SetLine(const ParametersType & origin,
00155                const vnl_vector<double> & direction);
00156 
00160   double GetLineValue(double x) const;
00161 
00162   double GetLineValue(double x, ParametersType & tempCoord) const;
00163 
00166   void   SetCurrentLinePoint(double x, double fx);
00167 
00170   void   Swap(double *a, double *b) const;
00171 
00174   void   Shift(double *a, double *b, double *c, double d) const;
00175 
00185   virtual void   LineBracket(double *ax, double *bx, double *cx,
00186                              double *fa, double *fb, double *fc);
00187 
00188   virtual void   LineBracket(double *ax, double *bx, double *cx,
00189                              double *fa, double *fb, double *fc,
00190                              ParametersType & tempCoord);
00191 
00197   virtual void   BracketedLineOptimize(double ax, double bx, double cx,
00198                                        double fa, double fb, double fc,
00199                                        double * extX, double * extVal);
00200 
00201   virtual void   BracketedLineOptimize(double ax, double bx, double cx,
00202                                        double fa, double fb, double fc,
00203                                        double * extX, double * extVal,
00204                                        ParametersType & tempCoord);
00205 
00206   itkGetMacro(SpaceDimension, unsigned int);
00207   void SetSpaceDimension( unsigned int dim )
00208     {
00209     this->m_SpaceDimension = dim;
00210     this->m_LineDirection.set_size( dim );
00211     this->m_LineOrigin.set_size( dim );
00212     this->m_CurrentPosition.set_size( dim );
00213     this->Modified();
00214     }
00215 
00216   itkSetMacro(CurrentIteration, unsigned int);
00217 
00218   itkGetMacro(Stop, bool);
00219   itkSetMacro(Stop, bool);
00220 
00221 private:
00222   unsigned int       m_SpaceDimension;
00223 
00225   unsigned int       m_CurrentIteration;
00226   unsigned int       m_CurrentLineIteration;
00227 
00229   unsigned int       m_MaximumIteration;
00230   unsigned int       m_MaximumLineIteration;
00231 
00232   bool               m_CatchGetValueException;
00233   double             m_MetricWorstPossibleValue;
00234 
00236   bool               m_Maximize;
00237 
00239   double             m_StepLength;
00240   double             m_StepTolerance;
00241 
00242   ParametersType     m_LineOrigin;
00243   vnl_vector<double> m_LineDirection;
00244 
00245   double             m_ValueTolerance;
00246 
00248   MeasureType        m_CurrentCost;
00249 
00254   bool               m_Stop;
00255 
00256 }; // end of class
00257 
00258 } // end of namespace itk
00259 
00260 #endif
00261 

Generated at Tue Jul 29 21:48:05 2008 for ITK by doxygen 1.5.1 written by Dimitri van Heesch, © 1997-2000