itkMaskedFFTNormalizedCorrelationImageFilter.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 itkMaskedFFTNormalizedCorrelationImageFilter_h
#define itkMaskedFFTNormalizedCorrelationImageFilter_h
 
#include "itkImageToImageFilter.h"
#include "itkImage.h"
 
namespace itk
{
 
template <typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
class ITK_TEMPLATE_EXPORT MaskedFFTNormalizedCorrelationImageFilter
  : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MaskedFFTNormalizedCorrelationImageFilter);

  using Self = MaskedFFTNormalizedCorrelationImageFilter;
  using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(MaskedFFTNormalizedCorrelationImageFilter);

  static constexpr unsigned int ImageDimension = TOutputImage::ImageDimension;

  using InputImageType = TInputImage;
  using InputRegionType = typename InputImageType::RegionType;
  using InputImagePointer = typename InputImageType::Pointer;
  using InputImageConstPointer = typename InputImageType::ConstPointer;
  using InputSizeType = typename InputImageType::SizeType;
  using SizeValueType = itk::SizeValueType;
 
  using OutputImageType = TOutputImage;
  using OutputImagePointer = typename OutputImageType::Pointer;
  using OutputPixelType = typename OutputImageType::PixelType;
 
  using RealPixelType = OutputPixelType;
  using RealImageType = Image<RealPixelType, ImageDimension>;
  using RealImagePointer = typename RealImageType::Pointer;
  using RealIndexType = typename RealImageType::IndexType;
  using RealSizeType = typename RealImageType::SizeType;
  using RealRegionType = typename RealImageType::RegionType;
  using RealPointType = typename RealImageType::PointType;
 
  using MaskImageType = TMaskImage;
  using MaskImagePointer = typename MaskImageType::Pointer;
 
  using FFTImageType = Image<std::complex<RealPixelType>, ImageDimension>;
  using FFTImagePointer = typename FFTImageType::Pointer;

  itkSetInputMacro(FixedImage, InputImageType);
  itkGetInputMacro(FixedImage, InputImageType);

  itkSetInputMacro(MovingImage, InputImageType);
  itkGetInputMacro(MovingImage, InputImageType);

  itkSetInputMacro(FixedImageMask, MaskImageType);
  itkGetInputMacro(FixedImageMask, MaskImageType);

  itkSetInputMacro(MovingImageMask, MaskImageType);
  itkGetInputMacro(MovingImageMask, MaskImageType);

  itkSetMacro(RequiredNumberOfOverlappingPixels, SizeValueType);
  itkGetMacro(RequiredNumberOfOverlappingPixels, SizeValueType);

  itkGetMacro(RequiredFractionOfOverlappingPixels, RealPixelType);
  itkSetClampMacro(RequiredFractionOfOverlappingPixels, RealPixelType, 0.0f, 1.0f);

  itkGetMacro(MaximumNumberOfOverlappingPixels, SizeValueType);
 
  itkConceptMacro(OutputPixelTypeIsFloatingPointCheck, (Concept::IsFloatingPoint<OutputPixelType>));
 
protected:
  MaskedFFTNormalizedCorrelationImageFilter()
  {
    // #0 "FixedImage" required
    Self::SetPrimaryInputName("FixedImage");
 
    // #1 "MaskImage" required
    Self::AddRequiredInputName("MovingImage", 1);
 
    // #2 "FixedImageMask" optional
    Self::AddOptionalInputName("FixedImageMask", 2);
 
    // #3 "MaskImageMask" optional
    Self::AddOptionalInputName("MovingImageMask", 3);
 
    m_RequiredNumberOfOverlappingPixels = 0;
    m_RequiredFractionOfOverlappingPixels = 0;
    m_MaximumNumberOfOverlappingPixels = 0;
    m_AccumulatedProgress = 0.0;
  }
  ~MaskedFFTNormalizedCorrelationImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  VerifyInputInformation() const override;

  void
  GenerateData() override;

  void
  GenerateInputRequestedRegion() override;

  void
  GenerateOutputInformation() override;
 
  void
  EnlargeOutputRequestedRegion(DataObject * output) override;
 
  typename TMaskImage::Pointer
  PreProcessMask(const InputImageType * inputImage, const MaskImageType * inputMask);
 
  typename TInputImage::Pointer
  PreProcessImage(const InputImageType * inputImage, const MaskImageType * inputMask);
 
  template <typename LocalInputImageType>
  typename LocalInputImageType::Pointer
  RotateImage(LocalInputImageType * inputImage);
 
  template <typename LocalInputImageType, typename LocalOutputImageType>
  typename LocalOutputImageType::Pointer
  CalculateForwardFFT(LocalInputImageType * inputImage, InputSizeType & FFTImageSize);
 
  template <typename LocalInputImageType, typename LocalOutputImageType>
  typename LocalOutputImageType::Pointer
  CalculateInverseFFT(LocalInputImageType * inputImage, RealSizeType & combinedImageSize);
 
  // Helper math methods.
  template <typename LocalInputImageType, typename LocalOutputImageType>
  typename LocalOutputImageType::Pointer
  ElementProduct(LocalInputImageType * inputImage1, LocalInputImageType * inputImage2);
 
  template <typename LocalInputImageType>
  typename LocalInputImageType::Pointer
  ElementQuotient(LocalInputImageType * inputImage1, LocalInputImageType * inputImage2);
 
  template <typename LocalInputImageType>
  typename LocalInputImageType::Pointer
  ElementSubtraction(LocalInputImageType * inputImage1, LocalInputImageType * inputImage2);
 
  template <typename LocalInputImageType>
  typename LocalInputImageType::Pointer
  ElementPositive(LocalInputImageType * inputImage);
 
  template <typename LocalInputImageType, typename LocalOutputImageType>
  typename LocalOutputImageType::Pointer
  ElementRound(LocalInputImageType * inputImage);
 
  // This function factorizes the image size uses factors of 2, 3, and
  // 5.  After this factorization, if there are any remaining values,
  // the function returns this value.
  int
  FactorizeNumber(int n);
 
  // Find the closest valid dimension above the desired dimension.  This
  // will be a combination of 2s, 3s, and 5s.
  int
  FindClosestValidDimension(int n);
 
  template <typename LocalInputImageType>
  double
  CalculatePrecisionTolerance(LocalInputImageType * inputImage);
 
private:
  SizeValueType m_RequiredNumberOfOverlappingPixels{};

  RealPixelType m_RequiredFractionOfOverlappingPixels{};

  SizeValueType m_MaximumNumberOfOverlappingPixels{};

  const unsigned int m_TotalForwardAndInverseFFTs{ 12 };

  float m_AccumulatedProgress{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkMaskedFFTNormalizedCorrelationImageFilter.hxx"
#endif
 
#endif