elxStandardGradientDescent.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef __elxStandardGradientDescent_h
#define __elxStandardGradientDescent_h
 
#include "elxIncludes.h" // include first to avoid MSVS warning
#include "itkStandardGradientDescentOptimizer.h"
 
namespace elastix
{
 
template< class TElastix >
class StandardGradientDescent :
  public
  itk::StandardGradientDescentOptimizer,
  public
  OptimizerBase< TElastix >
{
public:
 
  typedef StandardGradientDescent          Self;
  typedef StandardGradientDescentOptimizer Superclass1;
  typedef OptimizerBase< TElastix >        Superclass2;
  typedef itk::SmartPointer< Self >        Pointer;
  typedef itk::SmartPointer< const Self >  ConstPointer;
 
  itkNewMacro( Self );
 
  itkTypeMacro( StandardGradientDescent, StandardGradientDescentOptimizer );
 
  elxClassNameMacro( "StandardGradientDescent" );
 
  typedef Superclass1::CostFunctionType    CostFunctionType;
  typedef Superclass1::CostFunctionPointer CostFunctionPointer;
  typedef Superclass1::StopConditionType   StopConditionType;
 
  typedef typename Superclass2::ElastixType          ElastixType;
  typedef typename Superclass2::ElastixPointer       ElastixPointer;
  typedef typename Superclass2::ConfigurationType    ConfigurationType;
  typedef typename Superclass2::ConfigurationPointer ConfigurationPointer;
  typedef typename Superclass2::RegistrationType     RegistrationType;
  typedef typename Superclass2::RegistrationPointer  RegistrationPointer;
  typedef typename Superclass2::ITKBaseType          ITKBaseType;
 
  typedef typename Superclass1::ParametersType ParametersType;
 
  void BeforeRegistration( void ) override;
 
  void BeforeEachResolution( void ) override;
 
  void AfterEachResolution( void ) override;
 
  void AfterEachIteration( void ) override;
 
  void AfterRegistration( void ) override;
 
  void StartOptimization( void ) override;
 
  void MetricErrorResponse( itk::ExceptionObject & err ) override;
 
  void SetCurrentPositionPublic( const ParametersType & param ) override
  {
    this->Superclass1::SetCurrentPosition( param );
  }
 
 
  itkSetMacro( MaximumNumberOfSamplingAttempts, unsigned long );
 
  itkGetConstReferenceMacro( MaximumNumberOfSamplingAttempts, unsigned long );
 
protected:
 
  StandardGradientDescent();
  ~StandardGradientDescent() override {}
 
private:
 
  StandardGradientDescent( const Self & );  // purposely not implemented
  void operator=( const Self & );           // purposely not implemented
 
  unsigned long m_MaximumNumberOfSamplingAttempts;
  unsigned long m_CurrentNumberOfSamplingAttempts;
  unsigned long m_PreviousErrorAtIteration;
 
};
 
} // end namespace elastix
 
#ifndef ITK_MANUAL_INSTANTIATION
#include "elxStandardGradientDescent.hxx"
#endif
 
#endif // end #ifndef __elxStandardGradientDescent_h