ITK  4.3.0
Insight Segmentation and Registration Toolkit
itkOptimizerParameterScalesEstimator.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright Insight Software Consortium
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 #ifndef __itkOptimizerParameterScalesEstimator_h
19 #define __itkOptimizerParameterScalesEstimator_h
20 
21 #include "itkObject.h"
22 #include "itkObjectFactory.h"
25 
26 namespace itk
27 {
28 
38 class ITK_EXPORT OptimizerParameterScalesEstimator : public Object
39 {
40 public:
43  typedef Object Superclass;
46 
49 
52 
55 
57  typedef double FloatType;
58 
60  virtual void EstimateScales(ScalesType &scales) = 0;
61 
63  virtual FloatType EstimateStepScale(const ParametersType &step) = 0;
64 
66  virtual void EstimateLocalStepScales(const ParametersType &step,
67  ScalesType &localStepScales) = 0;
68 
70  virtual FloatType EstimateMaximumStepSize() = 0;
71 
72 protected:
75 
76  void PrintSelf(std::ostream &os, Indent indent) const
77  {
78  Superclass::PrintSelf(os,indent);
79  }
80 
81 private:
82  OptimizerParameterScalesEstimator(const Self&); //purposely not implemented
83  void operator=(const Self&); //purposely not implemented
84 
85 }; //class OptimizerParameterScalesEstimator
86 
87 } // namespace itk
88 
89 #endif /* __itkOptimizerParameterScalesEstimator_h */
90