ITK  4.1.0
Insight Segmentation and Registration Toolkit
itkOptimizerParameterScalesEstimator.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 __itkOptimizerParameterScalesEstimator_h
00019 #define __itkOptimizerParameterScalesEstimator_h
00020 
00021 #include "itkObject.h"
00022 #include "itkObjectFactory.h"
00023 #include "itkObjectToObjectOptimizerBase.h"
00024 #include "itkSingleValuedCostFunctionv4.h"
00025 
00026 namespace itk
00027 {
00028 
00038 class ITK_EXPORT OptimizerParameterScalesEstimator : public Object
00039 {
00040 public:
00042   typedef OptimizerParameterScalesEstimator     Self;
00043   typedef Object                                Superclass;
00044   typedef SmartPointer<Self>                    Pointer;
00045   typedef SmartPointer<const Self>              ConstPointer;
00046 
00048   itkTypeMacro( OptimizerParameterScalesEstimator, Object );
00049 
00051   typedef ObjectToObjectOptimizerBase::ScalesType        ScalesType;
00052 
00054   typedef ObjectToObjectOptimizerBase::ParametersType    ParametersType;
00055 
00057   typedef double                                         FloatType;
00058 
00060   virtual void EstimateScales(ScalesType &scales) = 0;
00061 
00063   virtual FloatType EstimateStepScale(const ParametersType &step) = 0;
00064 
00066   virtual void EstimateLocalStepScales(const ParametersType &step,
00067     ScalesType &localStepScales) = 0;
00068 
00070   virtual FloatType EstimateMaximumStepSize() = 0;
00071 
00072 protected:
00073   OptimizerParameterScalesEstimator(){};
00074   ~OptimizerParameterScalesEstimator(){};
00075 
00076   void PrintSelf(std::ostream &os, Indent indent) const
00077     {
00078     Superclass::PrintSelf(os,indent);
00079     }
00080 
00081 private:
00082   OptimizerParameterScalesEstimator(const Self&); //purposely not implemented
00083   void operator=(const Self&); //purposely not implemented
00084 
00085 }; //class OptimizerParameterScalesEstimator
00086 
00087 }  // namespace itk
00088 
00089 #endif /* __itkOptimizerParameterScalesEstimator_h */
00090