itkExpectationBasedPointSetToPointSetMetricv4.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 itkExpectationBasedPointSetToPointSetMetricv4_h
#define itkExpectationBasedPointSetToPointSetMetricv4_h
 
#include "itkPointSetToPointSetMetricv4.h"
#include "itkPointSet.h"
#include "itkImage.h"
 
namespace itk
{
template <typename TFixedPointSet,
          typename TMovingPointSet = TFixedPointSet,
          class TInternalComputationValueType = double>
class ITK_TEMPLATE_EXPORT ExpectationBasedPointSetToPointSetMetricv4
  : public PointSetToPointSetMetricv4<TFixedPointSet, TMovingPointSet, TInternalComputationValueType>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ExpectationBasedPointSetToPointSetMetricv4);

  using Self = ExpectationBasedPointSetToPointSetMetricv4;
  using Superclass = PointSetToPointSetMetricv4<TFixedPointSet, TMovingPointSet, TInternalComputationValueType>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkSimpleNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ExpectationBasedPointSetToPointSetMetricv4);

  using typename Superclass::MeasureType;
  using typename Superclass::DerivativeType;
  using typename Superclass::LocalDerivativeType;
  using typename Superclass::PointType;
  using typename Superclass::PixelType;
  using typename Superclass::CoordinateType;
  using typename Superclass::PointIdentifier;
  using typename Superclass::NeighborsIdentifierType;

  MeasureType
  GetLocalNeighborhoodValue(const PointType &, const PixelType & pixel = 0) const override;

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

  itkSetMacro(PointSetSigma, CoordinateType);

  itkGetConstMacro(PointSetSigma, CoordinateType);

  itkSetMacro(EvaluationKNeighborhood, unsigned int);

  itkGetConstMacro(EvaluationKNeighborhood, unsigned int);
 
  void
  Initialize() override;

  typename LightObject::Pointer
  InternalClone() const override;
 
protected:
  ExpectationBasedPointSetToPointSetMetricv4();
  ~ExpectationBasedPointSetToPointSetMetricv4() override = default;
 
  bool
  RequiresFixedPointsLocator() const override
  {
    return false;
  }

  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  using VectorType = typename PointType::VectorType;
  using NeighborsIterator = typename NeighborsIdentifierType::const_iterator;
 
  CoordinateType m_PointSetSigma{};
  MeasureType    m_PreFactor{};
  MeasureType    m_Denominator{};
  unsigned int   m_EvaluationKNeighborhood{ 50 };
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkExpectationBasedPointSetToPointSetMetricv4.hxx"
#endif
 
#endif