ITK  4.1.0
Insight Segmentation and Registration Toolkit
itkRegularStepGradientDescentOptimizer.h
Go to the documentation of this file.
00001 /*=========================================================================
00002  *
00003  *  Copyright Insight Software Consortium
00004  *
00005  *  Licensed under the Apache License, Version 2.0 (the "License");
00006  *  you may not use this file except in compliance with the License.
00007  *  You may obtain a copy of the License at
00008  *
00009  *         http://www.apache.org/licenses/LICENSE-2.0.txt
00010  *
00011  *  Unless required by applicable law or agreed to in writing, software
00012  *  distributed under the License is distributed on an "AS IS" BASIS,
00013  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  *  See the License for the specific language governing permissions and
00015  *  limitations under the License.
00016  *
00017  *=========================================================================*/
00018 #ifndef __itkRegularStepGradientDescentOptimizer_h
00019 #define __itkRegularStepGradientDescentOptimizer_h
00020 
00021 #include "itkRegularStepGradientDescentBaseOptimizer.h"
00022 
00023 namespace itk
00024 {
00032 class ITK_EXPORT RegularStepGradientDescentOptimizer:
00033   public RegularStepGradientDescentBaseOptimizer
00034 {
00035 public:
00037   typedef RegularStepGradientDescentOptimizer     Self;
00038   typedef RegularStepGradientDescentBaseOptimizer Superclass;
00039   typedef SmartPointer< Self >                    Pointer;
00040   typedef SmartPointer< const Self >              ConstPointer;
00041 
00043   itkNewMacro(Self);
00044 
00046   itkTypeMacro(RegularStepGradientDescentOptimizer,
00047                RegularStepGradientDescentBaseOptimizer);
00048 
00050   typedef Superclass::CostFunctionType CostFunctionType;
00051   typedef CostFunctionType::Pointer    CostFunctionPointer;
00052 protected:
00053   RegularStepGradientDescentOptimizer() {}
00054   virtual ~RegularStepGradientDescentOptimizer() {}
00056 
00062   virtual void StepAlongGradient(
00063     double factor,
00064     const DerivativeType & transformedGradient);
00065 
00066 private:
00067   RegularStepGradientDescentOptimizer(const Self &); //purposely not implemented
00068   void operator=(const Self &);                      //purposely not implemented
00069 };
00070 } // end namespace itk
00071 
00072 #endif
00073