/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkRegistrationParameterScalesFromShiftBase_h
#define itkRegistrationParameterScalesFromShiftBase_h

#include "itkRegistrationParameterScalesEstimator.h"

namespace itk
{

/**
 * \class RegistrationParameterScalesFromShiftBase
 *  \brief Registration helper base class for estimating scales of
 * transform parameters from the maximum voxel shift caused by a parameter
 * change.
 *
 * Derived classes provide estimation using physical or index space.
 *
 * The scale of a parameter is estimated from the maximum voxel shift produced
 * from a small variation of this parameter. The maximization is done by checking
 * sample points within the metric's virtual domain. Sample points are generated
 * differently depending on the type of metric transform or metric type.
 * See RegistrationParameterScalesEstimator documentation.
 *
 * \sa RegistrationParameterScalesEstimator
 * \ingroup ITKOptimizersv4
 */
template <typename TMetric>
class ITK_TEMPLATE_EXPORT RegistrationParameterScalesFromShiftBase
  : public RegistrationParameterScalesEstimator<TMetric>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(RegistrationParameterScalesFromShiftBase);

  /** Standard class type aliases. */
  using Self = RegistrationParameterScalesFromShiftBase;
  using Superclass = RegistrationParameterScalesEstimator<TMetric>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  /** \see LightObject::GetNameOfClass() */
  itkOverrideGetNameOfClassMacro(RegistrationParameterScalesFromShiftBase);

  /** Type of scales */
  using typename Superclass::ScalesType;

  /** Type of parameters of the optimizer */
  using typename Superclass::ParametersType;
  using ParametersValueType = typename ParametersType::ValueType;

  /** Type of float */
  using typename Superclass::FloatType;

  using typename Superclass::VirtualPointType;
  using typename Superclass::VirtualIndexType;
  using typename Superclass::MovingTransformType;
  using typename Superclass::FixedTransformType;
  using typename Superclass::JacobianType;
  using typename Superclass::VirtualImageConstPointer;

  /** Estimate parameter scales */
  void
  EstimateScales(ScalesType & parameterScales) override;

  /** Estimate the scale of a step */
  FloatType
  EstimateStepScale(const ParametersType & step) override;

  /** Estimate the scales of local steps */
  void
  EstimateLocalStepScales(const ParametersType & step, ScalesType & localStepScales) override;

  /** Set/get small parameter variation */
  /** @ITKStartGrouping */
  itkSetMacro(SmallParameterVariation, ParametersValueType);
  itkGetConstMacro(SmallParameterVariation, ParametersValueType);
  /** @ITKEndGrouping */
protected:
  RegistrationParameterScalesFromShiftBase();
  ~RegistrationParameterScalesFromShiftBase() override = default;

  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  /** Compute the shift in voxels when deltaParameters is applied onto the
   * current parameters. */
  virtual FloatType
  ComputeMaximumVoxelShift(const ParametersType & deltaParameters);

  /** Compute the sample shifts.
   */
  virtual void
  ComputeSampleShifts(const ParametersType & deltaParameters, ScalesType & localShifts) = 0;

private:
  // A small variation of parameters
  ParametersValueType m_SmallParameterVariation{};

}; // class RegistrationParameterScalesFromShiftBase


} // namespace itk


#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkRegistrationParameterScalesFromShiftBase.hxx"
#endif

#endif /* itkRegistrationParameterScalesFromShiftBase_h */
