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 <typename TElastix>
class ITK_TEMPLATE_EXPORT StandardGradientDescent
  : public itk::StandardGradientDescentOptimizer
  , public OptimizerBase<TElastix>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(StandardGradientDescent);

  using Self = StandardGradientDescent;
  using Superclass1 = StandardGradientDescentOptimizer;
  using Superclass2 = OptimizerBase<TElastix>;
  using Pointer = itk::SmartPointer<Self>;
  using ConstPointer = itk::SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(StandardGradientDescent);

  elxClassNameMacro("StandardGradientDescent");

  using Superclass1::CostFunctionType;
  using Superclass1::CostFunctionPointer;
  using Superclass1::StopConditionType;

  using typename Superclass2::ElastixType;
  using typename Superclass2::RegistrationType;
  using ITKBaseType = typename Superclass2::ITKBaseType;

  using typename Superclass1::ParametersType;

  void
  BeforeRegistration() override;
 
  void
  BeforeEachResolution() override;
 
  void
  AfterEachResolution() override;
 
  void
  AfterEachIteration() override;
 
  void
  AfterRegistration() override;

  void
  StartOptimization() 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 = default;
 
private:
  elxOverrideGetSelfMacro;

  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