go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
elxStandardGradientDescent.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 __elxStandardGradientDescent_h
19 #define __elxStandardGradientDescent_h
20 
21 #include "elxIncludes.h" // include first to avoid MSVS warning
23 
24 namespace elastix
25 {
26 
67 template< class TElastix >
69  public
71  public
72  OptimizerBase< TElastix >
73 {
74 public:
75 
80  typedef itk::SmartPointer< Self > Pointer;
81  typedef itk::SmartPointer< const Self > ConstPointer;
82 
84  itkNewMacro( Self );
85 
88 
93  elxClassNameMacro( "StandardGradientDescent" );
94 
97  typedef Superclass1::CostFunctionPointer CostFunctionPointer;
99 
108 
111 
114  virtual void BeforeRegistration( void );
115 
116  virtual void BeforeEachResolution( void );
117 
118  virtual void AfterEachResolution( void );
119 
120  virtual void AfterEachIteration( void );
121 
122  virtual void AfterRegistration( void );
123 
126  virtual void StartOptimization( void );
127 
129  virtual void MetricErrorResponse( itk::ExceptionObject & err );
130 
134  virtual void SetCurrentPositionPublic( const ParametersType & param )
135  {
136  this->Superclass1::SetCurrentPosition( param );
137  }
138 
139 
141  itkSetMacro( MaximumNumberOfSamplingAttempts, unsigned long );
142 
144  itkGetConstReferenceMacro( MaximumNumberOfSamplingAttempts, unsigned long );
145 
146 protected:
147 
150 
151 private:
152 
153  StandardGradientDescent( const Self & ); // purposely not implemented
154  void operator=( const Self & ); // purposely not implemented
155 
160 
161 };
162 
163 } // end namespace elastix
164 
165 #ifndef ITK_MANUAL_INSTANTIATION
166 #include "elxStandardGradientDescent.hxx"
167 #endif
168 
169 #endif // end #ifndef __elxStandardGradientDescent_h
Superclass::RegistrationPointer RegistrationPointer
Superclass2::ConfigurationPointer ConfigurationPointer
virtual void SetCurrentPosition(const ParametersType &param)
A gradient descent optimizer with a decaying gain.
Superclass2::ElastixPointer ElastixPointer
This class is the elastix base class for all Optimizers.
Superclass2::ConfigurationType ConfigurationType
virtual void StartOptimization(void)
Superclass::ElastixType ElastixType
Superclass::ConfigurationPointer ConfigurationPointer
virtual void MetricErrorResponse(itk::ExceptionObject &err)
Superclass2::RegistrationType RegistrationType
This class implements a gradient descent optimizer with a decaying gain.
Superclass1::ParametersType ParametersType
Superclass::ElastixPointer ElastixPointer
virtual void AfterEachResolution(void)
virtual void BeforeEachResolution(void)
Superclass2::RegistrationPointer RegistrationPointer
Superclass::ConfigurationType ConfigurationType
virtual void BeforeRegistration(void)
virtual void AfterEachIteration(void)
Superclass1::CostFunctionPointer CostFunctionPointer
itk::Optimizer ITKBaseType
itk::SmartPointer< const Self > ConstPointer
virtual void AfterRegistration(void)
virtual void SetCurrentPositionPublic(const ParametersType &param)
Superclass1::CostFunctionType CostFunctionType
Superclass1::StopConditionType StopConditionType
Superclass::RegistrationType RegistrationType
StandardGradientDescentOptimizer Superclass1
elxClassNameMacro("StandardGradientDescent")


Generated on 04-09-2015 for elastix by doxygen 1.8.9.1 elastix logo