elxAdaGrad.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 elxAdaGrad_h
#define elxAdaGrad_h
 
#include "elxIncludes.h" // include first to avoid MSVS warning
#include "itkAdaptiveStepsizeOptimizer.h"
 
#include "itkComputePreconditionerUsingDisplacementDistribution.h"
#include "itkComputeDisplacementDistribution.h" // For fast step size estimation
 
#include "elxProgressCommand.h"
#include "itkAdvancedTransform.h"
#include "itkMersenneTwisterRandomVariateGenerator.h"
#include "itkAdvancedBSplineDeformableTransformBase.h"
#include "itkImageRandomSampler.h"
 
 
namespace elastix
{
 
template <typename TElastix>
class ITK_TEMPLATE_EXPORT AdaGrad
  : public itk::AdaptiveStepsizeOptimizer
  , public OptimizerBase<TElastix>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(AdaGrad);

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

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(AdaGrad);

  elxClassNameMacro("AdaGrad");

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

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

  using typename Superclass1::ParametersType;

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

  void
  StartOptimization() override;

  void
  AdvanceOneStep() override;

  void
  ResumeOptimization() override;

  void
  MetricErrorResponse(itk::ExceptionObject & err) override;

  itkSetMacro(AutomaticParameterEstimation, bool);
  itkGetConstMacro(AutomaticParameterEstimation, bool);

  itkSetMacro(MaximumStepLength, double);
  itkGetConstReferenceMacro(MaximumStepLength, double);

  itkSetClampMacro(RegularizationKappa, double, 0.0, 1.0);
  itkGetConstReferenceMacro(RegularizationKappa, double);

  itkSetMacro(MaximumNumberOfSamplingAttempts, SizeValueType);
  itkGetConstReferenceMacro(MaximumNumberOfSamplingAttempts, SizeValueType);
 
protected:
  AdaGrad();
  ~AdaGrad() override = default;

  using FixedImageType = typename RegistrationType::FixedImageType;
  using MovingImageType = typename RegistrationType::MovingImageType;
 
  using FixedImageRegionType = typename FixedImageType::RegionType;
  using FixedImageIndexType = typename FixedImageType::IndexType;
  using FixedImagePointType = typename FixedImageType::PointType;
  using itkRegistrationType = typename RegistrationType::ITKBaseType;
  using TransformType = typename itkRegistrationType::TransformType;
  using JacobianType = typename TransformType::JacobianType;
  using JacobianValueType = typename JacobianType::ValueType;
  using typename Superclass2::SettingsType;
  using typename Superclass2::SettingsVectorType;
  using OutputImageType = typename ElastixType::FixedImageType;
 
  using PreconditionerEstimationType =
    itk::ComputePreconditionerUsingDisplacementDistribution<FixedImageType, TransformType>;
  using PreconditionerEstimationPointer = typename PreconditionerEstimationType::Pointer;
 
  using ComputeDisplacementDistributionType = itk::ComputeDisplacementDistribution<FixedImageType, TransformType>;
 

  using ImageSamplerBaseType = itk::ImageSamplerBase<FixedImageType>;
  using ImageSamplerBasePointer = typename ImageSamplerBaseType::Pointer;
  using ImageRandomSamplerBaseType = itk::ImageRandomSamplerBase<FixedImageType>;
  using ImageRandomSamplerBasePointer = typename ImageRandomSamplerBaseType::Pointer;
  using ImageRandomCoordinateSamplerType = itk::ImageRandomCoordinateSampler<FixedImageType>;
  using ImageRandomCoordinateSamplerPointer = typename ImageRandomCoordinateSamplerType::Pointer;
  using ImageRandomSamplerType = itk::ImageRandomSampler<FixedImageType>;
  using ImageRandomSamplerPointer = typename ImageRandomSamplerType::Pointer;
  using ImageGridSamplerType = itk::ImageGridSampler<FixedImageType>;
  using ImageGridSamplerPointer = typename ImageGridSamplerType::Pointer;
  using ImageSampleContainerType = typename ImageGridSamplerType::ImageSampleContainerType;
  using ImageSampleContainerPointer = typename ImageSampleContainerType::Pointer;

  using RandomGeneratorType = itk::Statistics::MersenneTwisterRandomVariateGenerator;
  using RandomGeneratorPointer = typename RandomGeneratorType::Pointer;

  using TransformJacobianType = JacobianType;
  itkStaticConstMacro(FixedImageDimension, unsigned int, FixedImageType::ImageDimension);
  itkStaticConstMacro(MovingImageDimension, unsigned int, MovingImageType::ImageDimension);
  using CoordinateRepresentationType = typename TransformType::ScalarType;
 
  using AdvancedTransformType =
    itk::AdvancedTransform<CoordinateRepresentationType, Self::FixedImageDimension, Self::MovingImageDimension>;
  using AdvancedTransformPointer = typename AdvancedTransformType::Pointer;
  using NonZeroJacobianIndicesType = typename AdvancedTransformType::NonZeroJacobianIndicesType;
 
  using AdvancedBSplineDeformableTransformType =
    itk::AdvancedBSplineDeformableTransformBase<CoordinateRepresentationType, Self::FixedImageDimension>;
  using BSplineTransformBasePointer = typename AdvancedBSplineDeformableTransformType::Pointer;

  SettingsVectorType m_SettingsVector;

  SizeValueType m_NumberOfGradientMeasurements;
  SizeValueType m_NumberOfJacobianMeasurements;
  SizeValueType m_NumberOfSamplesForNoiseCompensationFactor;
  SizeValueType m_NumberOfSamplesForPrecondition;
  SizeValueType m_NumberOfSpatialSamples;

  AdvancedTransformPointer m_AdvancedTransform;
 
  double m_SigmoidScaleFactor;
  double m_NoiseFactor;
  double m_GlobalStepSize;
  double m_RegularizationKappa;
  double m_ConditionNumber;

  virtual void
  AutomaticPreconditionerEstimation();

  virtual void
  SampleGradients(const ParametersType & mu0, double perturbationSigma, double & gg, double & ee);

  virtual void
  GetScaledDerivativeWithExceptionHandling(const ParametersType & parameters, DerivativeType & derivative);

  virtual void
  AddRandomPerturbation(ParametersType & parameters, double sigma);
 
private:
  elxOverrideGetSelfMacro;
 
  bool   m_AutomaticParameterEstimation;
  double m_MaximumStepLength;
  double m_MaximumStepLengthRatio;

  SizeValueType m_MaximumNumberOfSamplingAttempts;
  SizeValueType m_CurrentNumberOfSamplingAttempts;
  SizeValueType m_PreviousErrorAtIteration;
  bool          m_AutomaticParameterEstimationDone;

  SizeValueType m_MaxBandCovSize;
  SizeValueType m_NumberOfBandStructureSamples;

  bool m_UseNoiseCompensation;
  bool m_OriginalButSigmoidToDefault;
};
 
} // end namespace elastix
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "elxAdaGrad.hxx"
#endif
 
#endif // end #ifndef elxAdaGrad_h