ITK  5.4.0
Insight Toolkit
itkRegularStepGradientDescentOptimizer.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  * https://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 itkRegularStepGradientDescentOptimizer_h
19 #define itkRegularStepGradientDescentOptimizer_h
20 
22 #include "ITKOptimizersExport.h"
23 
24 namespace itk
25 {
34 {
35 public:
36  ITK_DISALLOW_COPY_AND_MOVE(RegularStepGradientDescentOptimizer);
37 
43 
45  itkNewMacro(Self);
46 
48  itkOverrideGetNameOfClassMacro(RegularStepGradientDescentOptimizer);
49 
51  using CostFunctionType = Superclass::CostFunctionType;
53 
54 protected:
56  ~RegularStepGradientDescentOptimizer() override = default;
57 
63  void
64  StepAlongGradient(double factor, const DerivativeType & transformedGradient) override;
65 };
66 } // end namespace itk
67 
68 #endif
Pointer
SmartPointer< Self > Pointer
Definition: itkAddImageFilter.h:93
itk::RegularStepGradientDescentBaseOptimizer
Implement a gradient descent optimizer.
Definition: itkRegularStepGradientDescentBaseOptimizer.h:58
itk::RegularStepGradientDescentOptimizer::CostFunctionType
Superclass::CostFunctionType CostFunctionType
Definition: itkRegularStepGradientDescentOptimizer.h:51
itk::SmartPointer< Self >
itk::RegularStepGradientDescentOptimizer
Implement a gradient descent optimizer.
Definition: itkRegularStepGradientDescentOptimizer.h:33
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:55
itk::RegularStepGradientDescentOptimizer::CostFunctionPointer
CostFunctionType::Pointer CostFunctionPointer
Definition: itkRegularStepGradientDescentOptimizer.h:52
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::Array
Array class with size defined at construction time.
Definition: itkArray.h:47
itkRegularStepGradientDescentBaseOptimizer.h