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  virtual void BeforeRegistration( void );
111 
112  virtual void BeforeEachResolution( void );
113 
114  virtual void AfterEachResolution( void );
115 
116  virtual void AfterEachIteration( void );
117 
118  virtual void AfterRegistration( void );
119 
124  virtual void SetInitialPosition( const ParametersType & param );
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
elastix::RegularStepGradientDescent::ITKBaseType
Superclass2::ITKBaseType ITKBaseType
Definition: elxRegularStepGradientDescent.h:103
elastix::OptimizerBase::RegistrationPointer
Superclass::RegistrationPointer RegistrationPointer
Definition: elxOptimizerBase.h:70
elastix::RegularStepGradientDescent::RegistrationPointer
Superclass2::RegistrationPointer RegistrationPointer
Definition: elxRegularStepGradientDescent.h:102
elastix::RegularStepGradientDescent::SetInitialPosition
virtual void SetInitialPosition(const ParametersType &param)
elastix::OptimizerBase::RegistrationType
Superclass::RegistrationType RegistrationType
Definition: elxOptimizerBase.h:69
elastix::RegularStepGradientDescent::Superclass1
RegularStepGradientDescentOptimizer Superclass1
Definition: elxRegularStepGradientDescent.h:75
elastix::OptimizerBase::ConfigurationPointer
Superclass::ConfigurationPointer ConfigurationPointer
Definition: elxOptimizerBase.h:68
elastix::RegularStepGradientDescent::ElastixPointer
Superclass2::ElastixPointer ElastixPointer
Definition: elxRegularStepGradientDescent.h:98
elastix::RegularStepGradientDescent::ConfigurationPointer
Superclass2::ConfigurationPointer ConfigurationPointer
Definition: elxRegularStepGradientDescent.h:100
elastix::RegularStepGradientDescent::RegularStepGradientDescent
RegularStepGradientDescent()
Definition: elxRegularStepGradientDescent.h:128
elastix::RegularStepGradientDescent::AfterRegistration
virtual void AfterRegistration(void)
elastix::OptimizerBase
This class is the elastix base class for all Optimizers.
Definition: elxOptimizerBase.h:54
elastix::RegularStepGradientDescent::CostFunctionPointer
Superclass1::CostFunctionPointer CostFunctionPointer
Definition: elxRegularStepGradientDescent.h:94
elastix::RegularStepGradientDescent::elxClassNameMacro
elxClassNameMacro("RegularStepGradientDescent")
elastix::RegularStepGradientDescent::ConfigurationType
Superclass2::ConfigurationType ConfigurationType
Definition: elxRegularStepGradientDescent.h:99
elastix::RegularStepGradientDescent::AfterEachIteration
virtual void AfterEachIteration(void)
elastix::RegularStepGradientDescent::operator=
void operator=(const Self &)
elastix::RegularStepGradientDescent::RegularStepGradientDescent
RegularStepGradientDescent(const Self &)
elastix::OptimizerBase::ConfigurationType
Superclass::ConfigurationType ConfigurationType
Definition: elxOptimizerBase.h:67
elastix::RegularStepGradientDescent::ParametersType
Superclass1::ParametersType ParametersType
Definition: elxRegularStepGradientDescent.h:106
elastix::RegularStepGradientDescent::BeforeRegistration
virtual void BeforeRegistration(void)
elastix::OptimizerBase::ElastixPointer
Superclass::ElastixPointer ElastixPointer
Definition: elxOptimizerBase.h:66
elxIncludes.h
elastix::RegularStepGradientDescent::ConstPointer
itk::SmartPointer< const Self > ConstPointer
Definition: elxRegularStepGradientDescent.h:78
elastix::RegularStepGradientDescent::BeforeEachResolution
virtual void BeforeEachResolution(void)
elastix::RegularStepGradientDescent::AfterEachResolution
virtual void AfterEachResolution(void)
elastix::RegularStepGradientDescent
An optimizer based on gradient descent...
Definition: elxRegularStepGradientDescent.h:70
elastix::RegularStepGradientDescent::ElastixType
Superclass2::ElastixType ElastixType
Definition: elxRegularStepGradientDescent.h:97
elastix::RegularStepGradientDescent::RegistrationType
Superclass2::RegistrationType RegistrationType
Definition: elxRegularStepGradientDescent.h:101
elastix::RegularStepGradientDescent::Self
RegularStepGradientDescent Self
Definition: elxRegularStepGradientDescent.h:74
elastix::OptimizerBase::ITKBaseType
itk::Optimizer ITKBaseType
Definition: elxOptimizerBase.h:73
elastix::RegularStepGradientDescent::~RegularStepGradientDescent
virtual ~RegularStepGradientDescent()
Definition: elxRegularStepGradientDescent.h:129
elastix::RegularStepGradientDescent::Pointer
itk::SmartPointer< Self > Pointer
Definition: elxRegularStepGradientDescent.h:77
elastix::OptimizerBase::ElastixType
Superclass::ElastixType ElastixType
Definition: elxOptimizerBase.h:62
elastix
Definition: elxFixedGenericPyramid.h:25
elastix::RegularStepGradientDescent::CostFunctionType
Superclass1::CostFunctionType CostFunctionType
Definition: elxRegularStepGradientDescent.h:93
elastix::RegularStepGradientDescent::Superclass2
OptimizerBase< TElastix > Superclass2
Definition: elxRegularStepGradientDescent.h:76


Generated on OURCE_DATE_EPOCH for elastix by doxygen 1.8.18 elastix logo