go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
elxQuasiNewtonLBFGS.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 __elxQuasiNewtonLBFGS_h
19 #define __elxQuasiNewtonLBFGS_h
20 
21 #include "elxIncludes.h" // include first to avoid MSVS warning
24 
25 namespace elastix
26 {
27 
87 template< class TElastix >
89  public
91  public
92  OptimizerBase< TElastix >
93 {
94 public:
95 
100  typedef itk::SmartPointer< Self > Pointer;
101  typedef itk::SmartPointer< const Self > ConstPointer;
102 
104  itkNewMacro( Self );
105 
108 
113  elxClassNameMacro( "QuasiNewtonLBFGS" );
114 
117  typedef Superclass1::CostFunctionPointer CostFunctionPointer;
122 
131 
135  typedef itk::ReceptorMemberCommand< Self > EventPassThroughType;
136  typedef typename EventPassThroughType::Pointer EventPassThroughPointer;
137 
140  virtual void StartOptimization( void );
141 
144  virtual void BeforeRegistration( void );
145 
146  virtual void BeforeEachResolution( void );
147 
148  virtual void AfterEachResolution( void );
149 
150  virtual void AfterEachIteration( void );
151 
152  virtual void AfterRegistration( void );
153 
154  itkGetConstMacro( StartLineSearch, bool );
155 
156 protected:
157 
159  virtual ~QuasiNewtonLBFGS() {}
160 
162 
164  virtual std::string GetLineSearchStopCondition( void ) const;
165 
168  virtual std::string DeterminePhase( void ) const;
169 
173  virtual bool TestConvergence( bool firstLineSearchDone );
174 
179  virtual void LineSearch(
180  const ParametersType searchDir,
181  double & step,
182  ParametersType & x,
183  MeasureType & f,
184  DerivativeType & g );
185 
186 private:
187 
188  QuasiNewtonLBFGS( const Self & ); // purposely not implemented
189  void operator=( const Self & ); // purposely not implemented
190 
191  void InvokeIterationEvent( const itk::EventObject & event );
192 
199 
200 };
201 
202 } // end namespace elastix
203 
204 #ifndef ITK_MANUAL_INSTANTIATION
205 #include "elxQuasiNewtonLBFGS.hxx"
206 #endif
207 
208 #endif // end #ifndef __elxQuasiNewtonLBFGS_h
itk::MoreThuenteLineSearchOptimizer
ITK version of the MoreThuente line search algorithm.
Definition: itkMoreThuenteLineSearchOptimizer.h:72
elastix::QuasiNewtonLBFGS::CostFunctionType
Superclass1::CostFunctionType CostFunctionType
Definition: elxQuasiNewtonLBFGS.h:116
elastix::QuasiNewtonLBFGS::DeterminePhase
virtual std::string DeterminePhase(void) const
elastix::OptimizerBase::RegistrationPointer
Superclass::RegistrationPointer RegistrationPointer
Definition: elxOptimizerBase.h:70
elastix::QuasiNewtonLBFGS::EventPassThroughType
itk::ReceptorMemberCommand< Self > EventPassThroughType
Definition: elxQuasiNewtonLBFGS.h:135
elastix::QuasiNewtonLBFGS::AfterEachResolution
virtual void AfterEachResolution(void)
SmartPointer< Self >
elastix::QuasiNewtonLBFGS::TestConvergence
virtual bool TestConvergence(bool firstLineSearchDone)
elastix::QuasiNewtonLBFGS::ElastixPointer
Superclass2::ElastixPointer ElastixPointer
Definition: elxQuasiNewtonLBFGS.h:125
elastix::QuasiNewtonLBFGS::StartOptimization
virtual void StartOptimization(void)
elastix::QuasiNewtonLBFGS::ElastixType
Superclass2::ElastixType ElastixType
Definition: elxQuasiNewtonLBFGS.h:124
elastix::OptimizerBase::RegistrationType
Superclass::RegistrationType RegistrationType
Definition: elxOptimizerBase.h:69
elastix::OptimizerBase::ConfigurationPointer
Superclass::ConfigurationPointer ConfigurationPointer
Definition: elxOptimizerBase.h:68
itkQuasiNewtonLBFGSOptimizer.h
elastix::QuasiNewtonLBFGS::QuasiNewtonLBFGS
QuasiNewtonLBFGS()
elastix::QuasiNewtonLBFGS::elxClassNameMacro
elxClassNameMacro("QuasiNewtonLBFGS")
itkMoreThuenteLineSearchOptimizer.h
elastix::QuasiNewtonLBFGS::Superclass1
QuasiNewtonLBFGSOptimizer Superclass1
Definition: elxQuasiNewtonLBFGS.h:98
elastix::QuasiNewtonLBFGS::Self
QuasiNewtonLBFGS Self
Definition: elxQuasiNewtonLBFGS.h:97
itk::QuasiNewtonLBFGSOptimizer::DerivativeType
Superclass::DerivativeType DerivativeType
Definition: itkQuasiNewtonLBFGSOptimizer.h:71
elastix::QuasiNewtonLBFGS::AfterEachIteration
virtual void AfterEachIteration(void)
elastix::QuasiNewtonLBFGS::StopConditionType
Superclass1::StopConditionType StopConditionType
Definition: elxQuasiNewtonLBFGS.h:118
elastix::QuasiNewtonLBFGS::m_StopIfWolfeNotSatisfied
bool m_StopIfWolfeNotSatisfied
Definition: elxQuasiNewtonLBFGS.h:197
itk::QuasiNewtonLBFGSOptimizer::StopConditionType
StopConditionType
Definition: itkQuasiNewtonLBFGSOptimizer.h:85
elastix::QuasiNewtonLBFGS::Pointer
itk::SmartPointer< Self > Pointer
Definition: elxQuasiNewtonLBFGS.h:100
itk::QuasiNewtonLBFGSOptimizer
ITK version of the lbfgs algorithm ...
Definition: itkQuasiNewtonLBFGSOptimizer.h:59
itk::QuasiNewtonLBFGSOptimizer::ParametersType
Superclass::ParametersType ParametersType
Definition: itkQuasiNewtonLBFGSOptimizer.h:68
elastix::QuasiNewtonLBFGS::~QuasiNewtonLBFGS
virtual ~QuasiNewtonLBFGS()
Definition: elxQuasiNewtonLBFGS.h:159
elastix::QuasiNewtonLBFGS::LineOptimizerType
itk::MoreThuenteLineSearchOptimizer LineOptimizerType
Definition: elxQuasiNewtonLBFGS.h:133
elastix::OptimizerBase
This class is the elastix base class for all Optimizers.
Definition: elxOptimizerBase.h:54
elastix::QuasiNewtonLBFGS::DerivativeType
Superclass1::DerivativeType DerivativeType
Definition: elxQuasiNewtonLBFGS.h:120
elastix::QuasiNewtonLBFGS::RegistrationPointer
Superclass2::RegistrationPointer RegistrationPointer
Definition: elxQuasiNewtonLBFGS.h:129
itk::ScaledSingleValuedNonLinearOptimizer::DerivativeType
Superclass::DerivativeType DerivativeType
Definition: itkScaledSingleValuedNonLinearOptimizer.h:83
elastix::QuasiNewtonLBFGS::ConfigurationPointer
Superclass2::ConfigurationPointer ConfigurationPointer
Definition: elxQuasiNewtonLBFGS.h:127
elastix::QuasiNewtonLBFGS::m_SearchDirectionMagnitude
double m_SearchDirectionMagnitude
Definition: elxQuasiNewtonLBFGS.h:194
elastix::QuasiNewtonLBFGS::m_EventPasser
EventPassThroughPointer m_EventPasser
Definition: elxQuasiNewtonLBFGS.h:193
elastix::QuasiNewtonLBFGS::QuasiNewtonLBFGS
QuasiNewtonLBFGS(const Self &)
elastix::QuasiNewtonLBFGS::ParametersType
Superclass1::ParametersType ParametersType
Definition: elxQuasiNewtonLBFGS.h:119
elastix::QuasiNewtonLBFGS::GetLineSearchStopCondition
virtual std::string GetLineSearchStopCondition(void) const
elastix::OptimizerBase::ConfigurationType
Superclass::ConfigurationType ConfigurationType
Definition: elxOptimizerBase.h:67
itk::ScaledSingleValuedNonLinearOptimizer::MeasureType
Superclass::MeasureType MeasureType
Definition: itkScaledSingleValuedNonLinearOptimizer.h:78
elastix::QuasiNewtonLBFGS::BeforeRegistration
virtual void BeforeRegistration(void)
itk::QuasiNewtonLBFGSOptimizer::CostFunctionType
Superclass::CostFunctionType CostFunctionType
Definition: itkQuasiNewtonLBFGSOptimizer.h:72
itk::ScaledSingleValuedNonLinearOptimizer
Definition: itkScaledSingleValuedNonLinearOptimizer.h:64
elastix::QuasiNewtonLBFGS::operator=
void operator=(const Self &)
elastix::QuasiNewtonLBFGS::ConfigurationType
Superclass2::ConfigurationType ConfigurationType
Definition: elxQuasiNewtonLBFGS.h:126
elastix::QuasiNewtonLBFGS::BeforeEachResolution
virtual void BeforeEachResolution(void)
elastix::OptimizerBase::ElastixPointer
Superclass::ElastixPointer ElastixPointer
Definition: elxOptimizerBase.h:66
elastix::QuasiNewtonLBFGS::AfterRegistration
virtual void AfterRegistration(void)
elxIncludes.h
elastix::QuasiNewtonLBFGS::m_StartLineSearch
bool m_StartLineSearch
Definition: elxQuasiNewtonLBFGS.h:195
elastix::QuasiNewtonLBFGS::ConstPointer
itk::SmartPointer< const Self > ConstPointer
Definition: elxQuasiNewtonLBFGS.h:101
elastix::QuasiNewtonLBFGS::m_LineOptimizer
LineOptimizerPointer m_LineOptimizer
Definition: elxQuasiNewtonLBFGS.h:161
elastix::QuasiNewtonLBFGS::m_GenerateLineSearchIterations
bool m_GenerateLineSearchIterations
Definition: elxQuasiNewtonLBFGS.h:196
elastix::QuasiNewtonLBFGS::LineOptimizerPointer
LineOptimizerType::Pointer LineOptimizerPointer
Definition: elxQuasiNewtonLBFGS.h:134
elastix::QuasiNewtonLBFGS::InvokeIterationEvent
void InvokeIterationEvent(const itk::EventObject &event)
elastix::QuasiNewtonLBFGS::m_WolfeIsStopCondition
bool m_WolfeIsStopCondition
Definition: elxQuasiNewtonLBFGS.h:198
elastix::QuasiNewtonLBFGS::ScalesType
Superclass1::ScalesType ScalesType
Definition: elxQuasiNewtonLBFGS.h:121
elastix::QuasiNewtonLBFGS::RegistrationType
Superclass2::RegistrationType RegistrationType
Definition: elxQuasiNewtonLBFGS.h:128
itk::ScaledSingleValuedNonLinearOptimizer::ParametersType
Superclass::ParametersType ParametersType
Definition: itkScaledSingleValuedNonLinearOptimizer.h:82
elastix::QuasiNewtonLBFGS::ITKBaseType
Superclass2::ITKBaseType ITKBaseType
Definition: elxQuasiNewtonLBFGS.h:130
elastix::QuasiNewtonLBFGS::LineSearch
virtual void LineSearch(const ParametersType searchDir, double &step, ParametersType &x, MeasureType &f, DerivativeType &g)
elastix::OptimizerBase::ITKBaseType
itk::Optimizer ITKBaseType
Definition: elxOptimizerBase.h:73
elastix::QuasiNewtonLBFGS
An optimizer based on the itk::QuasiNewtonLBFGSOptimizer.
Definition: elxQuasiNewtonLBFGS.h:93
elastix::QuasiNewtonLBFGS::CostFunctionPointer
Superclass1::CostFunctionPointer CostFunctionPointer
Definition: elxQuasiNewtonLBFGS.h:117
elastix::OptimizerBase::ElastixType
Superclass::ElastixType ElastixType
Definition: elxOptimizerBase.h:62
elastix
Definition: elxFixedGenericPyramid.h:25
elastix::QuasiNewtonLBFGS::EventPassThroughPointer
EventPassThroughType::Pointer EventPassThroughPointer
Definition: elxQuasiNewtonLBFGS.h:136
itk::QuasiNewtonLBFGSOptimizer::ScalesType
Superclass::ScalesType ScalesType
Definition: itkQuasiNewtonLBFGSOptimizer.h:75
elastix::QuasiNewtonLBFGS::Superclass2
OptimizerBase< TElastix > Superclass2
Definition: elxQuasiNewtonLBFGS.h:99


Generated on OURCE_DATE_EPOCH for elastix by doxygen 1.8.18 elastix logo