itkSingleValuedPointSetToPointSetMetric.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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
 *
 *        http://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.
 *
 *=========================================================================*/
/*=========================================================================
 
  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkSingleValuedPointSetToPointSetMetric.h,v $
  Date:      $Date: 2009-01-26 21:45:56 $
  Version:   $Revision: 1.2 $
 
  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.
 
=========================================================================*/
#ifndef itkSingleValuedPointSetToPointSetMetric_h
#define itkSingleValuedPointSetToPointSetMetric_h
 
#include "itkImageBase.h"
#include "itkAdvancedTransform.h"
#include "itkSingleValuedCostFunction.h"
#include "itkMacro.h"
#include "itkImageMaskSpatialObject.h"
#include "itkPointSet.h"
#include "itkDeref.h"
 
namespace itk
{

 
template <typename TFixedPointSet, typename TMovingPointSet>
class ITK_TEMPLATE_EXPORT SingleValuedPointSetToPointSetMetric : public SingleValuedCostFunction
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(SingleValuedPointSetToPointSetMetric);

  using Self = SingleValuedPointSetToPointSetMetric;
  using Superclass = SingleValuedCostFunction;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  using CoordinateRepresentationType = Superclass::ParametersValueType;

  itkOverrideGetNameOfClassMacro(SingleValuedPointSetToPointSetMetric);

  using FixedPointSetType = TFixedPointSet;
  using FixedPointSetConstPointer = typename FixedPointSetType::ConstPointer;
  using MovingPointSetType = TMovingPointSet;
  using MovingPointSetConstPointer = typename MovingPointSetType::ConstPointer;
  using PointIterator = typename FixedPointSetType::PointsContainer::ConstIterator;

  itkStaticConstMacro(FixedPointSetDimension, unsigned int, TFixedPointSet::PointDimension);
  itkStaticConstMacro(MovingPointSetDimension, unsigned int, TMovingPointSet::PointDimension);

  using TransformType =
    AdvancedTransform<CoordinateRepresentationType, Self::FixedPointSetDimension, Self::MovingPointSetDimension>;
  using TransformPointer = typename TransformType::Pointer;
  using InputPointType = typename TransformType::InputPointType;
  using OutputPointType = typename TransformType::OutputPointType;
  using TransformParametersType = typename TransformType::ParametersType;
  using TransformJacobianType = typename TransformType::JacobianType;
 
  using FixedImageMaskType = ImageMaskSpatialObject<Self::FixedPointSetDimension>;
  using FixedImageMaskPointer = typename FixedImageMaskType::Pointer;
  using FixedImageMaskConstPointer = typename FixedImageMaskType::ConstPointer;
  using MovingImageMaskType = ImageMaskSpatialObject<Self::MovingPointSetDimension>;
  using MovingImageMaskPointer = typename MovingImageMaskType::Pointer;
  using MovingImageMaskConstPointer = typename MovingImageMaskType::ConstPointer;

  using Superclass::MeasureType;
  using Superclass::DerivativeType;
  using DerivativeValueType = typename DerivativeType::ValueType;
  using Superclass::ParametersType;

  using NonZeroJacobianIndicesType = typename TransformType::NonZeroJacobianIndicesType;

  itkSetConstObjectMacro(FixedPointSet, FixedPointSetType);

  itkGetConstObjectMacro(FixedPointSet, FixedPointSetType);

  itkSetConstObjectMacro(MovingPointSet, MovingPointSetType);

  itkGetConstObjectMacro(MovingPointSet, MovingPointSetType);

  itkSetObjectMacro(Transform, TransformType);

  itkGetConstObjectMacro(Transform, TransformType);

  void
  SetTransformParameters(const ParametersType & parameters) const;

  unsigned int
  GetNumberOfParameters() const override
  {
    return this->m_Transform->GetNumberOfParameters();
  }

  virtual void
  Initialize();

  // \todo: currently not used
  itkSetConstObjectMacro(FixedImageMask, FixedImageMaskType);

  itkGetConstObjectMacro(FixedImageMask, FixedImageMaskType);

  itkSetConstObjectMacro(MovingImageMask, MovingImageMaskType);

  itkGetConstObjectMacro(MovingImageMask, MovingImageMaskType);

  virtual void
  BeforeThreadedGetValueAndDerivative(const TransformParametersType & parameters) const;

  itkSetMacro(UseMetricSingleThreaded, bool);
  itkGetConstReferenceMacro(UseMetricSingleThreaded, bool);
  itkBooleanMacro(UseMetricSingleThreaded);
 
protected:
  SingleValuedPointSetToPointSetMetric() = default;
  ~SingleValuedPointSetToPointSetMetric() override = default;

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

  const auto &
  GetFixedPoints() const
  {
    // Sanity check.
    if (!m_FixedPointSet)
    {
      itkExceptionMacro("Fixed point set has not been assigned");
    }
    return Deref(m_FixedPointSet->GetPoints()).CastToSTLConstContainer();
  }

  const auto &
  GetMovingPoints() const
  {
    // Sanity check.
    if (!m_MovingPointSet)
    {
      itkExceptionMacro("Moving point set has not been assigned");
    }
    return Deref(m_MovingPointSet->GetPoints()).CastToSTLConstContainer();
  }

  FixedPointSetConstPointer   m_FixedPointSet{ nullptr };
  MovingPointSetConstPointer  m_MovingPointSet{ nullptr };
  FixedImageMaskConstPointer  m_FixedImageMask{ nullptr };
  MovingImageMaskConstPointer m_MovingImageMask{ nullptr };
  mutable TransformPointer    m_Transform{ nullptr };
 
  mutable unsigned int m_NumberOfPointsCounted{ 0 };

  bool m_UseMetricSingleThreaded{ true };
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkSingleValuedPointSetToPointSetMetric.hxx"
#endif
 
#endif