itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  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 itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4_h
#define itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4_h
 
#include "itkPointSetToPointSetMetricv4.h"
 
#include "itkManifoldParzenWindowsPointSetFunction.h"
 
namespace itk
{

 
template <typename TPointSet, class TInternalComputationValueType = double>
class ITK_TEMPLATE_EXPORT JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4
  : public PointSetToPointSetMetricv4<TPointSet, TPointSet, TInternalComputationValueType>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4);

  using Self = JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4;
  using Superclass = PointSetToPointSetMetricv4<TPointSet, TPointSet, TInternalComputationValueType>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkSimpleNewMacro(Self);

  itkOverrideGetNameOfClassMacro(JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4);
 
  using PointSetType = TPointSet;
  using PointsContainer = typename PointSetType::PointsContainer;
  using PointsContainerConstIterator = typename PointsContainer::ConstIterator;
 
  static constexpr unsigned int PointDimension = TPointSet::PointDimension;

  using typename Superclass::MeasureType;
  using typename Superclass::DerivativeType;
  using typename Superclass::DerivativeValueType;
  using typename Superclass::LocalDerivativeType;
  using typename Superclass::PointType;
  using typename Superclass::PixelType;
  using typename Superclass::CoordinateType;
  using typename Superclass::PointIdentifier;
  using typename Superclass::NeighborsIdentifierType;
  using typename Superclass::NumberOfParametersType;
 
  using typename Superclass::JacobianType;
  using typename Superclass::FixedTransformJacobianType;
  using typename Superclass::MovingTransformJacobianType;
 
  using RealType = MeasureType;

  using DensityFunctionType = ManifoldParzenWindowsPointSetFunction<PointSetType, RealType>;
  using GaussianType = typename DensityFunctionType::GaussianType;
  using DensityFunctionPointer = typename DensityFunctionType::Pointer;

  void
  Initialize() override;

  itkSetClampMacro(Alpha, RealType, 1.0, 2.0);

  itkGetConstMacro(Alpha, RealType);

  itkSetMacro(PointSetSigma, RealType);

  itkGetConstMacro(PointSetSigma, RealType);

  itkSetMacro(EvaluationKNeighborhood, unsigned int);

  itkGetConstMacro(EvaluationKNeighborhood, unsigned int);

  itkSetMacro(UseAnisotropicCovariances, bool);

  itkGetConstMacro(UseAnisotropicCovariances, bool);

  itkBooleanMacro(UseAnisotropicCovariances);

  itkSetMacro(CovarianceKNeighborhood, unsigned int);

  itkGetConstMacro(CovarianceKNeighborhood, unsigned int);

  itkSetMacro(KernelSigma, RealType);

  itkGetConstMacro(KernelSigma, RealType);
 
  MeasureType
  GetLocalNeighborhoodValue(const PointType & point, const PixelType & pixel = 0) const override;

  void
  GetLocalNeighborhoodValueAndDerivative(const PointType &,
                                         MeasureType &,
                                         LocalDerivativeType &,
                                         const PixelType & pixel = 0) const override;

  typename LightObject::Pointer
  InternalClone() const override;
 
protected:
  JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4();
  ~JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4() override = default;
 
  void
  ComputeValueAndDerivative(const PointType &     samplePoint,
                            MeasureType &         value,
                            LocalDerivativeType & derivativeReturn,
                            bool                  calcValue,
                            bool                  calcDerivative) const;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  bool
  RequiresFixedPointsLocator() const override
  {
    return false;
  }
 
  bool
  RequiresMovingPointsLocator() const override
  {
    return false;
  }
 
private:
  DensityFunctionPointer m_MovingDensityFunction{};
 
  bool m_UseAnisotropicCovariances{ false };
 
  RealType     m_PointSetSigma{};
  RealType     m_KernelSigma{};
  unsigned int m_CovarianceKNeighborhood{};
  unsigned int m_EvaluationKNeighborhood{};
 
  RealType m_Alpha{};

  mutable RealType m_TotalNumberOfPoints{};
  mutable RealType m_Prefactor0{};
  mutable RealType m_Prefactor1{};
};
 
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.hxx"
#endif
 
#endif