go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
elxRegularStepGradientDescent.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright UMC Utrecht and contributors
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 __elxRegularStepGradientDescent_h
19 #define __elxRegularStepGradientDescent_h
20 
21 #include "elxIncludes.h" // include first to avoid MSVS warning
22 #include "itkRegularStepGradientDescentOptimizer.h"
23 
24 namespace elastix
25 {
26 
64 template< class TElastix >
66  public
67  itk::RegularStepGradientDescentOptimizer,
68  public
69  OptimizerBase< TElastix >
70 {
71 public:
72 
75  typedef RegularStepGradientDescentOptimizer Superclass1;
77  typedef itk::SmartPointer< Self > Pointer;
78  typedef itk::SmartPointer< const Self > ConstPointer;
79 
81  itkNewMacro( Self );
82 
84  itkTypeMacro( RegularStepGradientDescent, RegularStepGradientDescentOptimizer );
85 
90  elxClassNameMacro( "RegularStepGradientDescent" );
91 
93  typedef Superclass1::CostFunctionType CostFunctionType;
94  typedef Superclass1::CostFunctionPointer CostFunctionPointer;
95 
104 
106  typedef typename Superclass1::ParametersType ParametersType;
107 
110  void BeforeRegistration( void ) override;
111 
112  void BeforeEachResolution( void ) override;
113 
114  void AfterEachResolution( void ) override;
115 
116  void AfterEachIteration( void ) override;
117 
118  void AfterRegistration( void ) override;
119 
124  void SetInitialPosition( const ParametersType & param ) override;
125 
126 protected:
127 
130 
131 private:
132 
133  RegularStepGradientDescent( const Self & ); // purposely not implemented
134  void operator=( const Self & ); // purposely not implemented
135 
136 };
137 
138 } // end namespace elastix
139 
140 #ifndef ITK_MANUAL_INSTANTIATION
141 #include "elxRegularStepGradientDescent.hxx"
142 #endif
143 
144 #endif // end #ifndef __elxRegularStepGradientDescent_h
A class that deals with user given parameters and command line arguments.
This class is the elastix base class for all Optimizers.
Superclass::ConfigurationPointer ConfigurationPointer
itk::Optimizer ITKBaseType
Superclass::ElastixType ElastixType
Superclass::ElastixPointer ElastixPointer
Superclass::RegistrationPointer RegistrationPointer
Superclass::RegistrationType RegistrationType
An optimizer based on gradient descent...
void AfterEachIteration(void) override
elxClassNameMacro("RegularStepGradientDescent")
Superclass2::ConfigurationPointer ConfigurationPointer
void BeforeEachResolution(void) override
RegularStepGradientDescentOptimizer Superclass1
itk::SmartPointer< const Self > ConstPointer
Superclass1::CostFunctionType CostFunctionType
void BeforeRegistration(void) override
void SetInitialPosition(const ParametersType &param) override
void AfterEachResolution(void) override
Superclass2::RegistrationPointer RegistrationPointer
Superclass1::CostFunctionPointer CostFunctionPointer
void AfterRegistration(void) override
Superclass2::ConfigurationType ConfigurationType


Generated on OURCE_DATE_EPOCH for elastix by doxygen 1.9.1 elastix logo