itkParzenWindowMutualInformationImageToImageMetric.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 itkParzenWindowMutualInformationImageToImageMetric_h
#define itkParzenWindowMutualInformationImageToImageMetric_h
 
#include "itkParzenWindowHistogramImageToImageMetric.h"
 
#include "itkArray2D.h"
 
namespace itk
{

 
template <typename TFixedImage, typename TMovingImage>
class ITK_TEMPLATE_EXPORT ParzenWindowMutualInformationImageToImageMetric
  : public ParzenWindowHistogramImageToImageMetric<TFixedImage, TMovingImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ParzenWindowMutualInformationImageToImageMetric);

  using Self = ParzenWindowMutualInformationImageToImageMetric;
  using Superclass = ParzenWindowHistogramImageToImageMetric<TFixedImage, TMovingImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ParzenWindowMutualInformationImageToImageMetric);

  using typename Superclass::CoordinateRepresentationType;
  using typename Superclass::MovingImageType;
  using typename Superclass::MovingImagePixelType;
  using typename Superclass::MovingImageConstPointer;
  using typename Superclass::FixedImageType;
  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::TransformJacobianType;
  using typename Superclass::NumberOfParametersType;
  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::MovingImageMaskType;
  using typename Superclass::MovingImageMaskPointer;
  using typename Superclass::MeasureType;
  using typename Superclass::DerivativeType;
  using typename Superclass::DerivativeValueType;
  using typename Superclass::ParametersType;
  using typename Superclass::FixedImagePixelType;
  using typename Superclass::MovingImageRegionType;
  using typename Superclass::ImageSamplerType;
  using typename Superclass::ImageSamplerPointer;
  using typename Superclass::ImageSampleContainerType;
  using typename Superclass::ImageSampleContainerPointer;
  using typename Superclass::FixedImageLimiterType;
  using typename Superclass::MovingImageLimiterType;
  using typename Superclass::FixedImageLimiterOutputType;
  using typename Superclass::MovingImageLimiterOutputType;
  using typename Superclass::MovingImageDerivativeScalesType;
  using typename Superclass::ThreadInfoType;

  itkStaticConstMacro(FixedImageDimension, unsigned int, FixedImageType::ImageDimension);

  itkStaticConstMacro(MovingImageDimension, unsigned int, MovingImageType::ImageDimension);

  MeasureType
  GetValue(const ParametersType & parameters) const override;

  itkGetConstMacro(UseJacobianPreconditioning, bool);
  itkSetMacro(UseJacobianPreconditioning, bool);
 
protected:
  ParzenWindowMutualInformationImageToImageMetric();

  ~ParzenWindowMutualInformationImageToImageMetric() override = default;


  using typename Superclass::FixedImageIndexType;
  using typename Superclass::FixedImageIndexValueType;
  using typename Superclass::MovingImageIndexType;
  using typename Superclass::FixedImagePointType;
  using typename Superclass::MovingImagePointType;
  using typename Superclass::MovingImageContinuousIndexType;
  using typename Superclass::BSplineInterpolatorType;
  using typename Superclass::MovingImageDerivativeType;
  using typename Superclass::PDFValueType;
  using typename Superclass::PDFDerivativeValueType;
  using typename Superclass::MarginalPDFType;
  using typename Superclass::JointPDFType;
  using typename Superclass::JointPDFDerivativesType;
  using typename Superclass::IncrementalMarginalPDFType;
  using typename Superclass::JointPDFIndexType;
  using typename Superclass::JointPDFRegionType;
  using typename Superclass::JointPDFSizeType;
  using typename Superclass::JointPDFDerivativesIndexType;
  using typename Superclass::JointPDFDerivativesRegionType;
  using typename Superclass::JointPDFDerivativesSizeType;
  using typename Superclass::ParzenValueContainerType;
  using typename Superclass::KernelFunctionType;
  using typename Superclass::NonZeroJacobianIndicesType;

  void
  GetValueAndAnalyticDerivative(const ParametersType & parameters,
                                MeasureType &          value,
                                DerivativeType &       derivative) const override;

  virtual void
  GetValueAndAnalyticDerivativeLowMemory(const ParametersType & parameters,
                                         MeasureType &          value,
                                         DerivativeType &       derivative) const;

  void
  GetValueAndFiniteDifferenceDerivative(const ParametersType & parameters,
                                        MeasureType &          value,
                                        DerivativeType &       derivative) const override;

  virtual void
  ComputeJacobianPreconditioner(const TransformJacobianType &      jac,
                                const NonZeroJacobianIndicesType & nzji,
                                DerivativeType &                   preconditioner,
                                DerivativeType &                   divisor) const;

  void
  InitializeHistograms() override;

  struct ParzenWindowMutualInformationMultiThreaderParameterType
  {
    Self * m_Metric;
  };
  ParzenWindowMutualInformationMultiThreaderParameterType m_ParzenWindowMutualInformationThreaderParameters{};

  void
  ThreadedComputeDerivativeLowMemory(ThreadIdType threadId);

  void
  AfterThreadedComputeDerivativeLowMemory(DerivativeType & derivative) const;

  static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION
  ComputeDerivativeLowMemoryThreaderCallback(void * arg);

  void
  LaunchComputeDerivativeLowMemoryThreaderCallback() const;
 
private:
  using PRatioType = double;
  using PRatioArrayType = vnl_matrix<PRatioType>;
  mutable PRatioArrayType m_PRatioArray{};

  bool m_UseJacobianPreconditioning{ false };

  void
  ComputeDerivativeLowMemorySingleThreaded(DerivativeType & derivative) const;
 
  void
  ComputeDerivativeLowMemory(DerivativeType & derivative) const;

  void
  UpdateDerivativeLowMemory(const RealType                     fixedImageValue,
                            const RealType                     movingImageValue,
                            const DerivativeType &             imageJacobian,
                            const NonZeroJacobianIndicesType & nzji,
                            DerivativeType &                   derivative) const;

  void
  ComputeValueAndPRatioArray(double & MI) const;
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkParzenWindowMutualInformationImageToImageMetric.hxx"
#endif
 
#endif // end #ifndef itkParzenWindowMutualInformationImageToImageMetric_h