ITK  5.2.0
Insight Toolkit
itkOptimizerParameterScalesEstimator.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
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 
38 template <typename TInternalComputationValueType = double>
40 {
41 public:
42  ITK_DISALLOW_COPY_AND_ASSIGN(OptimizerParameterScalesEstimatorTemplate);
43 
46  using Superclass = Object;
49 
52 
55 
58 
60  using FloatType = TInternalComputationValueType;
61 
63  virtual void
64  EstimateScales(ScalesType & scales) = 0;
65 
67  virtual FloatType
68  EstimateStepScale(const ParametersType & step) = 0;
69 
71  virtual void
72  EstimateLocalStepScales(const ParametersType & step, ScalesType & localStepScales) = 0;
73 
75  virtual FloatType
77 
78 protected:
80  ~OptimizerParameterScalesEstimatorTemplate() override = default;
81 
82  void
83  PrintSelf(std::ostream & os, Indent indent) const override
84  {
85  Superclass::PrintSelf(os, indent);
86  }
87 }; // class OptimizerParameterScalesEstimatorTemplate
88 
91 
92 } // namespace itk
93 
94 #endif
itk::OptimizerParameterScalesEstimatorTemplate
OptimizerParameterScalesEstimatorTemplate is the base class offering a empty method of estimating the...
Definition: itkOptimizerParameterScalesEstimator.h:39
itk::OptimizerParameters
Class to hold and manage different parameter types used during optimization.
Definition: itkOptimizerParameters.h:34
itkObjectFactory.h
itk::OptimizerParameterScalesEstimatorTemplate::EstimateMaximumStepSize
virtual FloatType EstimateMaximumStepSize()=0
itk::OptimizerParameterScalesEstimatorTemplate::PrintSelf
void PrintSelf(std::ostream &os, Indent indent) const override
Definition: itkOptimizerParameterScalesEstimator.h:83
itk::OptimizerParameterScalesEstimatorTemplate::EstimateScales
virtual void EstimateScales(ScalesType &scales)=0
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::OptimizerParameterScalesEstimatorTemplate::~OptimizerParameterScalesEstimatorTemplate
~OptimizerParameterScalesEstimatorTemplate() override=default
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itkOptimizerParameters.h
itk::OptimizerParameterScalesEstimatorTemplate::EstimateStepScale
virtual FloatType EstimateStepScale(const ParametersType &step)=0
itkObject.h
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::OptimizerParameterScalesEstimatorTemplate< TMetric::ParametersValueType >::FloatType
TMetric::ParametersValueType FloatType
Definition: itkOptimizerParameterScalesEstimator.h:60
itk::Object
Base class for most ITK classes.
Definition: itkObject.h:62
itk::Object::Object
Object()
itk::OptimizerParameterScalesEstimatorTemplate::EstimateLocalStepScales
virtual void EstimateLocalStepScales(const ParametersType &step, ScalesType &localStepScales)=0
itk::Object::PrintSelf
void PrintSelf(std::ostream &os, Indent indent) const override
itk::OptimizerParameterScalesEstimatorTemplate::OptimizerParameterScalesEstimatorTemplate
OptimizerParameterScalesEstimatorTemplate()=default