itkEuclideanDistancePointMetric.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 itkEuclideanDistancePointMetric_h
#define itkEuclideanDistancePointMetric_h
 
#include "itkPointSetToPointSetMetric.h"
#include "itkCovariantVector.h"
#include "itkPointSet.h"
#include "itkImage.h"
 
namespace itk
{
template <typename TFixedPointSet,
          typename TMovingPointSet,
          typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
class ITK_TEMPLATE_EXPORT EuclideanDistancePointMetric
  : public PointSetToPointSetMetric<TFixedPointSet, TMovingPointSet>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(EuclideanDistancePointMetric);

  using Self = EuclideanDistancePointMetric;
  using Superclass = PointSetToPointSetMetric<TFixedPointSet, TMovingPointSet>;
 
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(EuclideanDistancePointMetric);

  using typename Superclass::TransformType;
  using typename Superclass::TransformPointer;
  using typename Superclass::TransformParametersType;
  using typename Superclass::TransformJacobianType;
 
  using typename Superclass::MeasureType;
  using typename Superclass::DerivativeType;
  using typename Superclass::FixedPointSetType;
  using typename Superclass::MovingPointSetType;
  using typename Superclass::FixedPointSetConstPointer;
  using typename Superclass::MovingPointSetConstPointer;
 
  using typename Superclass::FixedPointIterator;
  using typename Superclass::FixedPointDataIterator;
 
  using typename Superclass::MovingPointIterator;
  using typename Superclass::MovingPointDataIterator;
 
  using DistanceMapType = TDistanceMap;
  using DistanceMapPointer = typename DistanceMapType::ConstPointer;

  unsigned int
  GetNumberOfValues() const override;

  void
  GetDerivative(const TransformParametersType & itkNotUsed(parameters),
                DerivativeType &                itkNotUsed(derivative)) const override
  {}

  MeasureType
  GetValue(const TransformParametersType & parameters) const override;

  void
  GetValueAndDerivative(const TransformParametersType & parameters,
                        MeasureType &                   value,
                        DerivativeType &                derivative) const;

  itkSetConstObjectMacro(DistanceMap, DistanceMapType);
  itkGetConstObjectMacro(DistanceMap, DistanceMapType);

  itkSetMacro(ComputeSquaredDistance, bool);
  itkGetConstMacro(ComputeSquaredDistance, bool);
  itkBooleanMacro(ComputeSquaredDistance);
 
protected:
  EuclideanDistancePointMetric();
  ~EuclideanDistancePointMetric() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  DistanceMapPointer m_DistanceMap{};
  bool               m_ComputeSquaredDistance{ false };
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkEuclideanDistancePointMetric.hxx"
#endif
 
#endif