itkJointHistogramMutualInformationImageToImageMetricv4.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 itkJointHistogramMutualInformationImageToImageMetricv4_h
#define itkJointHistogramMutualInformationImageToImageMetricv4_h
 
#include "itkImageToImageMetricv4.h"
#include "itkImage.h"
#include "itkBSplineDerivativeKernelFunction.h"
 
#include "itkJointHistogramMutualInformationComputeJointPDFThreader.h"
#include "itkJointHistogramMutualInformationGetValueAndDerivativeThreader.h"
 
namespace itk
{
template <typename TFixedImage,
          typename TMovingImage,
          typename TVirtualImage = TFixedImage,
          typename TInternalComputationValueType = double,
          typename TMetricTraits =
            DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>
class ITK_TEMPLATE_EXPORT JointHistogramMutualInformationImageToImageMetricv4
  : public ImageToImageMetricv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(JointHistogramMutualInformationImageToImageMetricv4);

  using Self = JointHistogramMutualInformationImageToImageMetricv4;
  using Superclass =
    ImageToImageMetricv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(JointHistogramMutualInformationImageToImageMetricv4);

  using typename Superclass::CoordinateRepresentationType;


  using InternalComputationValueType = TInternalComputationValueType;

  using typename Superclass::ParametersType;
  using typename Superclass::ParametersValueType;
  using typename Superclass::NumberOfParametersType;

  using typename Superclass::MeasureType;
  using typename Superclass::DerivativeType;
  using typename Superclass::FixedImagePointType;
  using typename Superclass::FixedImagePixelType;
  using FixedImageGradientType = typename Superclass::FixedGradientPixelType;
  using typename Superclass::MovingImagePointType;
  using typename Superclass::MovingImagePixelType;
  using MovingImageGradientType = typename Superclass::MovingGradientPixelType;
 
  using FixedTransformJacobianType = typename Superclass::FixedTransformType::JacobianType;
  using MovingTransformJacobianType = typename Superclass::MovingTransformType::JacobianType;
 
  using VirtualImageType = typename Superclass::VirtualImageType;
  using typename Superclass::VirtualIndexType;
  using typename Superclass::VirtualPointType;
  using typename Superclass::VirtualPointSetType;
 
  /* Image dimension accessors */
  static constexpr typename TVirtualImage::ImageDimensionType VirtualImageDimension = TVirtualImage::ImageDimension;
  static constexpr typename TMovingImage::ImageDimensionType  MovingImageDimension = TMovingImage::ImageDimension;

  using PDFValueType = TInternalComputationValueType;

  using MarginalPDFType = Image<PDFValueType, 1>;
  using MarginalPDFIndexType = typename MarginalPDFType::IndexType;
  using MarginalPDFPointType = typename MarginalPDFType::PointType;
  using JointPDFType = Image<PDFValueType, 2>;
  using JointPDFIndexType = typename JointPDFType::IndexType;
  using JointPDFPointType = typename JointPDFType::PointType;
  using JointPDFIndexValueType = typename JointPDFType::IndexValueType;

  itkGetModifiableObjectMacro(JointPDF, JointPDFType);
 
  // Declare the type for the derivative calculation
  using JPDFGradientFilterType = itk::GradientRecursiveGaussianImageFilter<JointPDFType>;
  using JPDFGradientImageType = typename JPDFGradientFilterType::OutputImageType;
  using JPDFGradientImagePointer = typename JPDFGradientImageType::Pointer;
 
  using MarginalGradientFilterType = itk::GradientRecursiveGaussianImageFilter<MarginalPDFType>;
  using MarginalGradientImageType = typename MarginalGradientFilterType::OutputImageType;
  using MarginalGradientImagePointer = typename MarginalGradientImageType::Pointer;

  using JointPDFInterpolatorType = LinearInterpolateImageFunction<JointPDFType, double>;
  using JointPDFInterpolatorPointer = typename JointPDFInterpolatorType::Pointer;
  using MarginalPDFInterpolatorType = LinearInterpolateImageFunction<MarginalPDFType, double>;
  using MarginalPDFInterpolatorPointer = typename MarginalPDFInterpolatorType::Pointer;

  using JointPDFValueType = typename JointPDFType::PixelType;
  using JointPDFRegionType = typename JointPDFType::RegionType;
  using JointPDFSizeType = typename JointPDFType::SizeType;
  using JointPDFSpacingType = typename JointPDFType::SpacingType;
 

  itkSetClampMacro(NumberOfHistogramBins, SizeValueType, 5, NumericTraits<SizeValueType>::max());
  itkGetConstReferenceMacro(NumberOfHistogramBins, SizeValueType);

  itkSetMacro(VarianceForJointPDFSmoothing, TInternalComputationValueType);
  itkGetMacro(VarianceForJointPDFSmoothing, TInternalComputationValueType);

  void
  Initialize() override;
 
  MeasureType
  GetValue() const override;
 
protected:
  JointHistogramMutualInformationImageToImageMetricv4();
  ~JointHistogramMutualInformationImageToImageMetricv4() override = default;

  void
  InitializeForIteration() const override;

  MeasureType
  ComputeValue() const;

  inline void
  ComputeJointPDFPoint(const FixedImagePixelType  fixedImageValue,
                       const MovingImagePixelType movingImageValue,
                       JointPDFPointType &        jointPDFpoint) const;
 
  friend class JointHistogramMutualInformationComputeJointPDFThreaderBase<
    ThreadedImageRegionPartitioner<Self::VirtualImageDimension>,
    Self>;
  friend class JointHistogramMutualInformationComputeJointPDFThreaderBase<ThreadedIndexedContainerPartitioner, Self>;
  friend class JointHistogramMutualInformationComputeJointPDFThreader<
    ThreadedImageRegionPartitioner<Self::VirtualImageDimension>,
    Self>;
  friend class JointHistogramMutualInformationComputeJointPDFThreader<ThreadedIndexedContainerPartitioner, Self>;
 
  using JointHistogramMutualInformationDenseComputeJointPDFThreaderType =
    JointHistogramMutualInformationComputeJointPDFThreader<ThreadedImageRegionPartitioner<Self::VirtualImageDimension>,
                                                           Self>;
  using JointHistogramMutualInformationSparseComputeJointPDFThreaderType =
    JointHistogramMutualInformationComputeJointPDFThreader<ThreadedIndexedContainerPartitioner, Self>;
 
  typename JointHistogramMutualInformationDenseComputeJointPDFThreaderType::Pointer
    m_JointHistogramMutualInformationDenseComputeJointPDFThreader;
  typename JointHistogramMutualInformationSparseComputeJointPDFThreaderType::Pointer
    m_JointHistogramMutualInformationSparseComputeJointPDFThreader;
 
  friend class JointHistogramMutualInformationGetValueAndDerivativeThreader<
    ThreadedImageRegionPartitioner<Superclass::VirtualImageDimension>,
    Superclass,
    Self>;
  friend class JointHistogramMutualInformationGetValueAndDerivativeThreader<ThreadedIndexedContainerPartitioner,
                                                                            Superclass,
                                                                            Self>;
 
  using JointHistogramMutualInformationDenseGetValueAndDerivativeThreaderType =
    JointHistogramMutualInformationGetValueAndDerivativeThreader<
      ThreadedImageRegionPartitioner<Superclass::VirtualImageDimension>,
      Superclass,
      Self>;
  using JointHistogramMutualInformationSparseGetValueAndDerivativeThreaderType =
    JointHistogramMutualInformationGetValueAndDerivativeThreader<ThreadedIndexedContainerPartitioner, Superclass, Self>;

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

  SizeValueType m_JointHistogramTotalCount{ 0 };
 
private:
  typename MarginalPDFType::Pointer m_FixedImageMarginalPDF{};

  typename MarginalPDFType::Pointer m_MovingImageMarginalPDF{};

  mutable typename JointPDFType::Pointer m_JointPDF{};

  TInternalComputationValueType m_VarianceForJointPDFSmoothing{};

  SizeValueType                 m_NumberOfHistogramBins{};
  TInternalComputationValueType m_FixedImageTrueMin{};
  TInternalComputationValueType m_FixedImageTrueMax{};
  TInternalComputationValueType m_MovingImageTrueMin{};
  TInternalComputationValueType m_MovingImageTrueMax{};
  TInternalComputationValueType m_FixedImageBinSize{};
  TInternalComputationValueType m_MovingImageBinSize{};
 
  TInternalComputationValueType m_JointPDFSum{};
  JointPDFSpacingType           m_JointPDFSpacing{};
 
  TInternalComputationValueType m_Log2{};
  JointPDFIndexValueType        m_Padding{};
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkJointHistogramMutualInformationImageToImageMetricv4.hxx"
#endif
 
#endif