itkImageToSpatialObjectMetric.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 itkImageToSpatialObjectMetric_h
#define itkImageToSpatialObjectMetric_h
 
#include "itkSingleValuedCostFunction.h"
#include "itkMinimumMaximumImageCalculator.h"
#include "itkLinearInterpolateImageFunction.h"
#include "vnl/vnl_vector_fixed.h"
#include "itkTransform.h"
 
namespace itk
{
 
template <typename TFixedImage, typename TMovingSpatialObject>
class ITK_TEMPLATE_EXPORT ImageToSpatialObjectMetric : public SingleValuedCostFunction
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ImageToSpatialObjectMetric);
 
  using Self = ImageToSpatialObjectMetric;
  using Superclass = SingleValuedCostFunction;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  using FixedImageType = TFixedImage;

  using MovingSpatialObjectType = TMovingSpatialObject;

  using CoordinateRepresentationType = Superclass::ParametersValueType;

  static constexpr unsigned int ImageDimension = FixedImageType::ImageDimension;

  static constexpr unsigned int ObjectDimension = MovingSpatialObjectType::ObjectDimension;

  using TransformType = Transform<CoordinateRepresentationType, Self::ObjectDimension, Self::ImageDimension>;
 
  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 = LinearInterpolateImageFunction<TFixedImage, CoordinateRepresentationType>;
 
  using InterpolatorPointer = typename InterpolatorType::Pointer;

  using VectorType = vnl_vector_fixed<double, Self::ObjectDimension>;

  using MeasureType = Superclass::MeasureType;

  using DerivativeType = Superclass::DerivativeType;

  using FixedImagePointer = typename FixedImageType::Pointer;

  using MovingSpatialObjectPointer = typename MovingSpatialObjectType::Pointer;

  using FixedImageConstPointer = typename FixedImageType::ConstPointer;

  using MovingSpatialObjectConstPointer = typename MovingSpatialObjectType::ConstPointer;

  using ParametersType = Superclass::ParametersType;

  itkOverrideGetNameOfClassMacro(ImageToSpatialObjectMetric);

  itkSetConstObjectMacro(FixedImage, FixedImageType);
  itkGetConstObjectMacro(FixedImage, FixedImageType);

  itkSetConstObjectMacro(MovingSpatialObject, MovingSpatialObjectType);
  itkGetConstObjectMacro(MovingSpatialObject, MovingSpatialObjectType);

  itkSetObjectMacro(Interpolator, InterpolatorType);

  itkGetModifiableObjectMacro(Interpolator, InterpolatorType);

  void
  GetValueAndDerivative(const ParametersType & parameters,
                        MeasureType &          Value,
                        DerivativeType &       Derivative) const override = 0;

  unsigned int
  GetNumberOfParameters() const override;

  virtual void
  Initialize();

  itkGetConstReferenceMacro(LastTransformParameters, ParametersType);

  itkSetObjectMacro(Transform, TransformType);
 
protected:
  ImageToSpatialObjectMetric();
  ~ImageToSpatialObjectMetric() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  MeasureType              m_MatchMeasure{ 0 };
  DerivativeType           m_MatchMeasureDerivatives{};
  mutable TransformPointer m_Transform{};
  InterpolatorPointer      m_Interpolator{};
 
  MovingSpatialObjectConstPointer m_MovingSpatialObject{};
  FixedImageConstPointer          m_FixedImage{};
  ParametersType                  m_LastTransformParameters{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkImageToSpatialObjectMetric.hxx"
#endif
 
#endif