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  This file is part of the elastix software.
4 
5  Copyright (c) University Medical Center Utrecht. All rights reserved.
6  See src/CopyrightElastix.txt or http://elastix.isi.uu.nl/legal.php for
7  details.
8 
9  This software is distributed WITHOUT ANY WARRANTY; without even
10  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
11  PURPOSE. See the above copyright notices for more information.
12 
13 ======================================================================*/
14 
15 #ifndef __elxStandardGradientDescent_h
16 #define __elxStandardGradientDescent_h
17 
19 #include "elxIncludes.h"
20 
21 namespace elastix
22 {
23 
24 
65  template <class TElastix>
67  public
69  public
70  OptimizerBase<TElastix>
71  {
72  public:
73 
78  typedef itk::SmartPointer<Self> Pointer;
79  typedef itk::SmartPointer<const Self> ConstPointer;
80 
82  itkNewMacro( Self );
83 
86 
91  elxClassNameMacro( "StandardGradientDescent" );
92 
94  typedef Superclass1::CostFunctionType CostFunctionType;
95  typedef Superclass1::CostFunctionPointer CostFunctionPointer;
96  typedef Superclass1::StopConditionType StopConditionType;
97 
106 
108  typedef typename Superclass1::ParametersType ParametersType;
109 
112  virtual void BeforeRegistration( void );
113  virtual void BeforeEachResolution( void );
114  virtual void AfterEachResolution( void );
115  virtual void AfterEachIteration( void );
116  virtual void AfterRegistration( void );
117 
120  virtual void StartOptimization( void );
121 
123  virtual void MetricErrorResponse( itk::ExceptionObject & err );
124 
128  virtual void SetCurrentPositionPublic( const ParametersType &param )
129  {
130  this->Superclass1::SetCurrentPosition( param );
131  }
132 
134  itkSetMacro( MaximumNumberOfSamplingAttempts, unsigned long );
135 
137  itkGetConstReferenceMacro( MaximumNumberOfSamplingAttempts, unsigned long );
138 
139  protected:
140 
143 
144 
145  private:
146 
147  StandardGradientDescent( const Self& ); // purposely not implemented
148  void operator=( const Self& ); // purposely not implemented
149 
154 
155  }; // end class StandardGradientDescent
156 
157 
158 } // end namespace elastix
159 
160 #ifndef ITK_MANUAL_INSTANTIATION
161 #include "elxStandardGradientDescent.hxx"
162 #endif
163 
164 #endif // end #ifndef __elxStandardGradientDescent_h
Superclass::RegistrationPointer RegistrationPointer
Superclass2::ConfigurationPointer ConfigurationPointer
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)
itk::SmartPointer< const Self > ConstPointer
virtual void AfterEachIteration(void)
Superclass1::CostFunctionPointer CostFunctionPointer
itk::Optimizer ITKBaseType
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-01-2014 for elastix by doxygen 1.8.5 elastix logo