itkFFTConvolutionImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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 itkFFTConvolutionImageFilter_h
#define itkFFTConvolutionImageFilter_h

#include "itkConvolutionImageFilterBase.h"

#include "itkProgressAccumulator.h"
#include "itkHalfHermitianToRealInverseFFTImageFilter.h"
#include "itkRealToHalfHermitianForwardFFTImageFilter.h"
#include "itkZeroFluxNeumannBoundaryCondition.h"

namespace itk
{
template< typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision=double >
class FFTConvolutionImageFilter :
  public ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >

{
public:
  typedef FFTConvolutionImageFilter                       Self;
  typedef ConvolutionImageFilterBase< TInputImage,
                                      TKernelImage,
                                      TOutputImage >
                                                          Superclass;
  typedef SmartPointer< Self >                            Pointer;
  typedef SmartPointer< const Self >                      ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(FFTConvolutionImageFilter, ConvolutionImageFilterBase);

  itkStaticConstMacro(ImageDimension, unsigned int,
                      TInputImage::ImageDimension);

  typedef TInputImage                           InputImageType;
  typedef TOutputImage                          OutputImageType;
  typedef TKernelImage                          KernelImageType;
  typedef typename InputImageType::PixelType    InputPixelType;
  typedef typename OutputImageType::PixelType   OutputPixelType;
  typedef typename KernelImageType::PixelType   KernelPixelType;
  typedef typename InputImageType::IndexType    InputIndexType;
  typedef typename OutputImageType::IndexType   OutputIndexType;
  typedef typename KernelImageType::IndexType   KernelIndexType;
  typedef typename InputImageType::SizeType     InputSizeType;
  typedef typename OutputImageType::SizeType    OutputSizeType;
  typedef typename KernelImageType::SizeType    KernelSizeType;
  typedef typename InputSizeType::SizeValueType SizeValueType;
  typedef typename InputImageType::RegionType   InputRegionType;
  typedef typename OutputImageType::RegionType  OutputRegionType;
  typedef typename KernelImageType::RegionType  KernelRegionType;

  typedef Image< TInternalPrecision, TInputImage::ImageDimension >  InternalImageType;
  typedef typename InternalImageType::Pointer                       InternalImagePointerType;
  typedef std::complex< TInternalPrecision >                        InternalComplexType;
  typedef Image< InternalComplexType, TInputImage::ImageDimension > InternalComplexImageType;
  typedef typename InternalComplexImageType::Pointer                InternalComplexImagePointerType;

  typedef typename Superclass::BoundaryConditionType        BoundaryConditionType;
  typedef typename Superclass::BoundaryConditionPointerType BoundaryConditionPointerType;

  itkSetMacro(SizeGreatestPrimeFactor, SizeValueType);
  itkGetMacro(SizeGreatestPrimeFactor, SizeValueType);

protected:
  FFTConvolutionImageFilter();
  ~FFTConvolutionImageFilter() {}

  typedef RealToHalfHermitianForwardFFTImageFilter< InternalImageType,
                                                    InternalComplexImageType >
    FFTFilterType;
  typedef HalfHermitianToRealInverseFFTImageFilter< InternalComplexImageType,
                                                    InternalImageType >
    IFFTFilterType;

  void GenerateInputRequestedRegion() ITK_OVERRIDE;

  void GenerateData() ITK_OVERRIDE;

  void PrepareInputs(const InputImageType * input,
                     const KernelImageType * kernel,
                     InternalComplexImagePointerType & preparedInput,
                     InternalComplexImagePointerType & preparedKernel,
                     ProgressAccumulator * progress, float progressWeight);

  void PrepareInput(const InputImageType * input,
                    InternalComplexImagePointerType & preparedInput,
                    ProgressAccumulator * progress, float progressWeight);

  void PadInput(const InputImageType * input,
                InternalImagePointerType & paddedInput,
                ProgressAccumulator * progress, float progressWeight);

  void TransformPaddedInput(const InternalImageType * paddedInput,
                            InternalComplexImagePointerType & transformedInput,
                            ProgressAccumulator * progress, float progressWeight);

  void PrepareKernel(const KernelImageType * kernel,
                     InternalComplexImagePointerType & preparedKernel,
                     ProgressAccumulator * progress, float progressWeight);

  void ProduceOutput(InternalComplexImageType * paddedOutput,
                     ProgressAccumulator * progress,
                     float progressWeight);

  void CropOutput(InternalImageType * paddedOutput,
                  ProgressAccumulator * progress,
                  float progressWeight);

  InputSizeType GetPadLowerBound() const;

  InputSizeType GetPadSize() const;

  bool GetXDimensionIsOdd() const;

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

private:
  FFTConvolutionImageFilter(const Self &) ITK_DELETE_FUNCTION;
  void operator=(const Self &) ITK_DELETE_FUNCTION;

  SizeValueType m_SizeGreatestPrimeFactor;
};
}

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkFFTConvolutionImageFilter.hxx"
#endif

#endif