itkMultiInputImageToImageMetricBase.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.
 *
 *=========================================================================*/
#ifndef itkMultiInputImageToImageMetricBase_h
#define itkMultiInputImageToImageMetricBase_h
 
#include "itkAdvancedImageToImageMetric.h"
#include <vector>

#define itkSetNumberOfMacro(name)                                                                                      \
  virtual void SetNumberOf##name##s(const unsigned int _arg)                                                           \
  {                                                                                                                    \
    if (this->m_NumberOf##name##s != _arg)                                                                             \
    {                                                                                                                  \
      this->m_##name##Vector.resize(_arg);                                                                             \
      this->m_NumberOf##name##s = _arg;                                                                                \
      this->Modified();                                                                                                \
    }                                                                                                                  \
  } // comments for allowing ; after calling the macro
 
namespace itk
{

 
template <class TFixedImage, class TMovingImage>
class ITK_TEMPLATE_EXPORT MultiInputImageToImageMetricBase
  : public AdvancedImageToImageMetric<TFixedImage, TMovingImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MultiInputImageToImageMetricBase);

  using Self = MultiInputImageToImageMetricBase;
  using Superclass = AdvancedImageToImageMetric<TFixedImage, TMovingImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkTypeMacro(MultiInputImageToImageMetricBase, AdvancedImageToImageMetric);

  itkStaticConstMacro(MovingImageDimension, unsigned int, TMovingImage::ImageDimension);
  itkStaticConstMacro(FixedImageDimension, unsigned int, TFixedImage::ImageDimension);

  using typename Superclass::CoordinateRepresentationType;
  using typename Superclass::MovingImageType;
  using typename Superclass::MovingImagePixelType;
  using typename Superclass::MovingImagePointer;
  using typename Superclass::MovingImageConstPointer;
  using typename Superclass::FixedImageType;
  using typename Superclass::FixedImagePointer;
  using typename Superclass::FixedImageConstPointer;
  using typename Superclass::FixedImageRegionType;
  using typename Superclass::TransformType;
  using typename Superclass::TransformPointer;
  using typename Superclass::InputPointType;
  using typename Superclass::OutputPointType;
  using typename Superclass::TransformParametersType;
  using typename Superclass::TransformJacobianType;
  using typename Superclass::InterpolatorType;
  using typename Superclass::InterpolatorPointer;
  using typename Superclass::RealType;
  using typename Superclass::GradientPixelType;
  using typename Superclass::GradientImageType;
  using typename Superclass::GradientImagePointer;
  using typename Superclass::FixedImageMaskType;
  using typename Superclass::FixedImageMaskPointer;
  using typename Superclass::FixedImageMaskConstPointer;
  using typename Superclass::MovingImageMaskType;
  using typename Superclass::MovingImageMaskPointer;
  using typename Superclass::MovingImageMaskConstPointer;
  using typename Superclass::MeasureType;
  using typename Superclass::DerivativeType;
  using typename Superclass::ParametersType;
 
  using FixedImageInterpolatorType = InterpolateImageFunction<FixedImageType, CoordinateRepresentationType>;
  using FixedImageInterpolatorPointer = typename FixedImageInterpolatorType::Pointer;

  using FixedImageVectorType = std::vector<FixedImageConstPointer>;
  using FixedImageMaskVectorType = std::vector<FixedImageMaskConstPointer>;
  using FixedImageRegionVectorType = std::vector<FixedImageRegionType>;
  using MovingImageVectorType = std::vector<MovingImageConstPointer>;
  using MovingImageMaskVectorType = std::vector<MovingImageMaskConstPointer>;
  using InterpolatorVectorType = std::vector<InterpolatorPointer>;
  using FixedImageInterpolatorVectorType = std::vector<FixedImageInterpolatorPointer>;


  virtual void
  SetFixedImage(const FixedImageType * _arg, unsigned int pos);

  void
  SetFixedImage(const FixedImageType * _arg) override
  {
    this->SetFixedImage(_arg, 0);
  }
 

  virtual const FixedImageType *
  GetFixedImage(unsigned int pos) const;

  const FixedImageType *
  GetFixedImage() const override
  {
    return this->GetFixedImage(0);
  }
 

  itkSetNumberOfMacro(FixedImage);

  itkGetConstMacro(NumberOfFixedImages, unsigned int);


  virtual void
  SetFixedImageMask(const FixedImageMaskType * _arg, unsigned int pos);

  void
  SetFixedImageMask(const FixedImageMaskType * _arg) override
  {
    this->SetFixedImageMask(_arg, 0);
  }
 

  virtual const FixedImageMaskType *
  GetFixedImageMask(unsigned int pos) const;

  const FixedImageMaskType *
  GetFixedImageMask() const override
  {
    return this->GetFixedImageMask(0);
  }
 

  itkSetNumberOfMacro(FixedImageMask);

  itkGetConstMacro(NumberOfFixedImageMasks, unsigned int);


  virtual void
  SetFixedImageRegion(const FixedImageRegionType _arg, unsigned int pos);

  void
  SetFixedImageRegion(const FixedImageRegionType _arg) override
  {
    this->SetFixedImageRegion(_arg, 0);
  }
 

  virtual const FixedImageRegionType &
  GetFixedImageRegion(unsigned int pos) const;

  const FixedImageRegionType &
  GetFixedImageRegion() const override
  {
    return this->GetFixedImageRegion(0);
  }
 

  itkSetNumberOfMacro(FixedImageRegion);

  itkGetConstMacro(NumberOfFixedImageRegions, unsigned int);


  virtual void
  SetMovingImage(const MovingImageType * _arg, unsigned int pos);

  void
  SetMovingImage(const MovingImageType * _arg) override
  {
    this->SetMovingImage(_arg, 0);
  }
 

  virtual const MovingImageType *
  GetMovingImage(unsigned int pos) const;

  const MovingImageType *
  GetMovingImage() const override
  {
    return this->GetMovingImage(0);
  }
 

  itkSetNumberOfMacro(MovingImage);

  itkGetConstMacro(NumberOfMovingImages, unsigned int);


  virtual void
  SetMovingImageMask(const MovingImageMaskType * _arg, unsigned int pos);

  void
  SetMovingImageMask(const MovingImageMaskType * _arg) override
  {
    this->SetMovingImageMask(_arg, 0);
  }
 

  virtual const MovingImageMaskType *
  GetMovingImageMask(unsigned int pos) const;

  const MovingImageMaskType *
  GetMovingImageMask() const override
  {
    return this->GetMovingImageMask(0);
  }
 

  itkSetNumberOfMacro(MovingImageMask);

  itkGetConstMacro(NumberOfMovingImageMasks, unsigned int);


  virtual void
  SetInterpolator(InterpolatorType * _arg, unsigned int pos);

  void
  SetInterpolator(InterpolatorType * _arg) override
  {
    return this->SetInterpolator(_arg, 0);
  }
 

  virtual InterpolatorType *
  GetInterpolator(unsigned int pos) const;

  InterpolatorType *
  GetInterpolator() override
  {
    return this->GetInterpolator(0);
  }

  const InterpolatorType *
  GetInterpolator() const override
  {
    return this->GetInterpolator(0);
  }
 

  itkSetNumberOfMacro(Interpolator);

  itkGetConstMacro(NumberOfInterpolators, unsigned int);

  itkGetConstMacro(InterpolatorsAreBSpline, bool);


  virtual void
  SetFixedImageInterpolator(FixedImageInterpolatorType * _arg, unsigned int pos);

  virtual void
  SetFixedImageInterpolator(FixedImageInterpolatorType * _arg)
  {
    return this->SetFixedImageInterpolator(_arg, 0);
  }
 

  virtual FixedImageInterpolatorType *
  GetFixedImageInterpolator(unsigned int pos) const;

  virtual FixedImageInterpolatorType *
  GetFixedImageInterpolator() const
  {
    return this->GetFixedImageInterpolator(0);
  }
 

  itkSetNumberOfMacro(FixedImageInterpolator);

  itkGetConstMacro(NumberOfFixedImageInterpolators, unsigned int);


  void
  Initialize() override;
 
protected:
  MultiInputImageToImageMetricBase() = default;

  ~MultiInputImageToImageMetricBase() override = default;

  using typename Superclass::MovingImagePointType;
  using typename Superclass::MovingImageIndexType;
  using typename Superclass::MovingImageDerivativeType;
  using typename Superclass::MovingImageContinuousIndexType;

  using typename Superclass::BSplineInterpolatorType;
  using BSplineInterpolatorPointer = typename BSplineInterpolatorType::Pointer;
  using BSplineInterpolatorVectorType = std::vector<BSplineInterpolatorPointer>;

  void
  InitializeImageSampler() override;

  virtual void
  CheckForBSplineInterpolators();

  bool
  EvaluateMovingImageValueAndDerivative(const MovingImagePointType & mappedPoint,
                                        RealType &                   movingImageValue,
                                        MovingImageDerivativeType *  gradient) const override;

  bool
  IsInsideMovingMask(const MovingImagePointType & mappedPoint) const override;

  FixedImageVectorType             m_FixedImageVector{};
  FixedImageMaskVectorType         m_FixedImageMaskVector{};
  FixedImageRegionVectorType       m_FixedImageRegionVector{};
  MovingImageVectorType            m_MovingImageVector{};
  MovingImageMaskVectorType        m_MovingImageMaskVector{};
  InterpolatorVectorType           m_InterpolatorVector{};
  FixedImageInterpolatorVectorType m_FixedImageInterpolatorVector{};
 
  bool                          m_InterpolatorsAreBSpline{ false };
  BSplineInterpolatorVectorType m_BSplineInterpolatorVector{};
 
private:
  // Private using-declarations, to avoid `-Woverloaded-virtual` warnings from GCC (GCC 11.4) or clang (macos-12).
  using Superclass::SetFixedImageMask;
  using Superclass::SetMovingImageMask;

  void
  FastEvaluateMovingImageValueAndDerivative(...) const = delete;

  FixedImageRegionType m_DummyFixedImageRegion{};
 
  unsigned int m_NumberOfFixedImages{ 0 };
  unsigned int m_NumberOfFixedImageMasks{ 0 };
  unsigned int m_NumberOfFixedImageRegions{ 0 };
  unsigned int m_NumberOfMovingImages{ 0 };
  unsigned int m_NumberOfMovingImageMasks{ 0 };
  unsigned int m_NumberOfInterpolators{ 0 };
  unsigned int m_NumberOfFixedImageInterpolators{ 0 };
};
 
} // end namespace itk
 
#undef itkSetNumberOfMacro
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkMultiInputImageToImageMetricBase.hxx"
#endif
 
#endif // end #ifndef itkMultiInputImageToImageMetricBase_h