/*=========================================================================
 *
 *  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 itkWarpHarmonicEnergyCalculator_h
#define itkWarpHarmonicEnergyCalculator_h

#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkConstNeighborhoodIterator.h"
#include "itkVector.h"

namespace itk
{
/** \class WarpHarmonicEnergyCalculator
 *
 * \brief Compute the harmonic energy of a deformation field.
 *
 * This class computes the harmonic energy of a deformation
 * field which is a measure inversely related to the smoothness
 * of the deformation field.
 *
 * \author Tom Vercauteren, INRIA & Mauna Kea Technologies
 *
 * This implementation was taken from the Insight Journal paper:
 * https://www.insight-journal.org/browse/publication/154
 *
 * \ingroup Operators
 * \ingroup ITKReview
 */
template <typename TInputImage>
class ITK_TEMPLATE_EXPORT WarpHarmonicEnergyCalculator : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(WarpHarmonicEnergyCalculator);

  /** Standard class type aliases. */
  using Self = WarpHarmonicEnergyCalculator;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  /** Method for creation through the object factory. */
  itkNewMacro(Self);

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

  /** Type definition for the input image. */
  using ImageType = TInputImage;

  /** Pointer type for the image. */
  using ImagePointer = typename TInputImage::Pointer;

  /** Const Pointer type for the image. */
  using ImageConstPointer = typename TInputImage::ConstPointer;

  /** Type definition for the input image pixel type. */
  using PixelType = typename TInputImage::PixelType;

  /** Type definition for the input image index type. */
  using IndexType = typename TInputImage::IndexType;

  /** Type definition for the input image region type. */
  using RegionType = typename TInputImage::RegionType;

  /** The dimensionality of the input image. */
  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  /** Length of the vector pixel type of the input image. */
  static constexpr unsigned int VectorDimension = PixelType::Dimension;

  /** Type of the iterator that will be used to move through the image.  Also
      the type which will be passed to the evaluate function */
  using ConstNeighborhoodIteratorType = ConstNeighborhoodIterator<ImageType>;
  using RadiusType = typename ConstNeighborhoodIteratorType::RadiusType;

  /** Set/Get whether or not the filter will use the spacing of the input
   *  image in its calculations.
   *  When set to "On", the derivative weights according to the spacing of the
   *  input image (1/spacing). Use this option if you want to calculate the
   *  Jacobian determinant in the space in which the data was acquired.
   *  Setting the value to "Off" resets the derivative weights to ignore image
   *  spacing. Use this option if you want to calculate the Jacobian
   *  determinant in the image space.
   *  Default value is "On". */
  void
  SetUseImageSpacing(bool);
  itkGetConstMacro(UseImageSpacing, bool);
  itkBooleanMacro(UseImageSpacing);

  using WeightsType = FixedArray<double, ImageDimension>;

  /** Set/Get the array of weights used to scale partial derivatives in the
   *  gradient calculations.
   *  Note that calling UseImageSpacingOn will clobber these values. */
  itkSetMacro(DerivativeWeights, WeightsType);
  itkGetConstReferenceMacro(DerivativeWeights, WeightsType);

  /** Set the input image. */
  itkSetConstObjectMacro(Image, ImageType);

  /** Compute the minimum and maximum values of intensity of the input image. */
  void
  Compute();

  /** Return the smoothness value. */
  itkGetConstMacro(HarmonicEnergy, double);

  /** Set the region over which the values will be computed */
  void
  SetRegion(const RegionType & region);

protected:
  WarpHarmonicEnergyCalculator();
  ~WarpHarmonicEnergyCalculator() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  /** Get/Set the neighborhood radius used for gradient computation */
  itkGetConstReferenceMacro(NeighborhoodRadius, RadiusType);
  itkSetMacro(NeighborhoodRadius, RadiusType);

  double
  EvaluateAtNeighborhood(ConstNeighborhoodIteratorType & it) const;

private:
  double            m_HarmonicEnergy{ 0.0 };
  ImageConstPointer m_Image{};

  RegionType m_Region{};
  bool       m_RegionSetByUser{ false };

  bool m_UseImageSpacing{ true };

  WeightsType m_DerivativeWeights{};

  RadiusType m_NeighborhoodRadius{};
};
} // end namespace itk

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

#endif /* itkWarpHarmonicEnergyCalculator_h */