itkPointSetToImageMetric.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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.
 *
 *=========================================================================*/
#ifndef itkPointSetToImageMetric_h
#define itkPointSetToImageMetric_h

#include "itkImageBase.h"
#include "itkTransform.h"
#include "itkInterpolateImageFunction.h"
#include "itkSingleValuedCostFunction.h"
#include "itkMacro.h"
#include "itkGradientRecursiveGaussianImageFilter.h"

namespace itk
{
template< typename TFixedPointSet,  typename TMovingImage >
class ITK_TEMPLATE_EXPORT PointSetToImageMetric:public SingleValuedCostFunction
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(PointSetToImageMetric);

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

  using CoordinateRepresentationType = Superclass::ParametersValueType;

  itkTypeMacro(PointSetToImageMetric, SingleValuedCostFunction);

  using MovingImageType = TMovingImage;
  using MovingImagePixelType = typename TMovingImage::PixelType;
  using MovingImageConstPointer = typename MovingImageType::ConstPointer;

  using FixedPointSetType = TFixedPointSet;
  using FixedPointSetConstPointer = typename FixedPointSetType::ConstPointer;

  static constexpr unsigned int MovingImageDimension = TMovingImage::ImageDimension;
  static constexpr unsigned int FixedPointSetDimension = TFixedPointSet::PointDimension;

  using PointIterator = typename FixedPointSetType::PointsContainer::ConstIterator;
  using PointDataIterator = typename FixedPointSetType::PointDataContainer::ConstIterator;

  using TransformType = Transform< CoordinateRepresentationType,
                     Self::MovingImageDimension,
                     Self::FixedPointSetDimension >;

  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 InterpolatorType = InterpolateImageFunction<
    MovingImageType,
    CoordinateRepresentationType >;

  using RealType = typename NumericTraits< MovingImagePixelType >::RealType;
  using GradientPixelType = CovariantVector< RealType,
                           Self::MovingImageDimension >;
  using GradientImageType = Image< GradientPixelType,
                 Self::MovingImageDimension >;
  using GradientImagePointer = SmartPointer< GradientImageType >;
  using GradientImageFilterType = GradientRecursiveGaussianImageFilter< MovingImageType,
                                                GradientImageType >;

  using GradientImageFilterPointer = typename GradientImageFilterType::Pointer;

  using InterpolatorPointer = typename InterpolatorType::Pointer;

  using MeasureType = Superclass::MeasureType;

  using DerivativeType = Superclass::DerivativeType;

  using ParametersType = Superclass::ParametersType;

  itkSetConstObjectMacro(FixedPointSet, FixedPointSetType);
  itkGetConstObjectMacro(FixedPointSet, FixedPointSetType);

  itkSetConstObjectMacro(MovingImage, MovingImageType);
  itkGetConstObjectMacro(MovingImage, MovingImageType);

  itkSetObjectMacro(Transform, TransformType);

  itkGetModifiableObjectMacro(Transform, TransformType);

  itkSetObjectMacro(Interpolator, InterpolatorType);

  itkGetModifiableObjectMacro(Interpolator, InterpolatorType);

  itkGetModifiableObjectMacro(GradientImage, GradientImageType);

  itkGetConstReferenceMacro(NumberOfPixelsCounted, SizeValueType);

  void SetTransformParameters(const ParametersType & parameters) const;

  itkSetMacro(ComputeGradient, bool);
  itkGetConstReferenceMacro(ComputeGradient, bool);

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

  virtual void Initialize();

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

  mutable SizeValueType m_NumberOfPixelsCounted;

  FixedPointSetConstPointer m_FixedPointSet;

  MovingImageConstPointer m_MovingImage;

  mutable TransformPointer m_Transform;

  InterpolatorPointer m_Interpolator;

  bool m_ComputeGradient;

  GradientImagePointer m_GradientImage;
};
} // end namespace itk

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

#endif