ITK  4.8.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"
23 #include "itkOptimizerParameters.h"
24 
25 namespace itk
26 {
27 
37 template< typename TInternalComputationValueType=double >
39 {
40 public:
43  typedef Object Superclass;
46 
49 
52 
55 
57  typedef TInternalComputationValueType 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  virtual void PrintSelf(std::ostream &os, Indent indent) const ITK_OVERRIDE
77  {
78  Superclass::PrintSelf(os,indent);
79  }
80 
81 private:
82  OptimizerParameterScalesEstimatorTemplate(const Self&); //purposely not implemented
83  void operator=(const Self&); //purposely not implemented
84 
85 }; //class OptimizerParameterScalesEstimatorTemplate
86 
89 
90 } // namespace itk
91 
92 #endif
virtual FloatType EstimateStepScale(const ParametersType &step)=0
virtual void EstimateLocalStepScales(const ParametersType &step, ScalesType &localStepScales)=0
OptimizerParameters< TInternalComputationValueType > ScalesType
OptimizerParameters< TInternalComputationValueType > ParametersType
OptimizerParameterScalesEstimatorTemplate is the base class offering a empty method of estimating the...
OptimizerParameterScalesEstimatorTemplate< double > OptimizerParameterScalesEstimator
virtual void PrintSelf(std::ostream &os, Indent indent) const override
virtual void EstimateScales(ScalesType &scales)=0
Control indentation during Print() invocation.
Definition: itkIndent.h:49
virtual void PrintSelf(std::ostream &os, Indent indent) const override
Base class for most ITK classes.
Definition: itkObject.h:57