itkFFTWInverseFFTImageFilter.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 itkFFTWInverseFFTImageFilter_h
#define itkFFTWInverseFFTImageFilter_h
 
#include "itkInverseFFTImageFilter.h"
#include "itkFFTWCommon.h"
// Include fftw3.h directly: the proxy header skips it when first included before ITK_USE_FFTW* is defined.
#if defined(ITK_USE_FFTWF) || defined(ITK_USE_FFTWD)
#  include "fftw3.h"
#endif
 
#include "itkFFTImageFilterFactory.h"
 
namespace itk
{
template <typename TInputImage,
          typename TOutputImage = Image<typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
class ITK_TEMPLATE_EXPORT FFTWInverseFFTImageFilter : public InverseFFTImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(FFTWInverseFFTImageFilter);

  using InputImageType = TInputImage;
  using InputPixelType = typename InputImageType::PixelType;
  using InputSizeType = typename InputImageType::SizeType;
  using OutputImageType = TOutputImage;
  using OutputPixelType = typename OutputImageType::PixelType;
  using OutputSizeType = typename OutputImageType::SizeType;
 
  using Self = FFTWInverseFFTImageFilter;
  using Superclass = InverseFFTImageFilter<InputImageType, OutputImageType>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  using FFTWProxyType = typename fftw::Proxy<OutputPixelType>;
 
  using OutputImageRegionType = typename OutputImageType::RegionType;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(FFTWInverseFFTImageFilter);

  static constexpr unsigned int ImageDimension = InputImageType::ImageDimension;

  virtual void
  SetPlanRigor(const int & value)
  {
#ifndef ITK_USE_CUFFTW
    // Use that method to check the value.
    FFTWGlobalConfiguration::GetPlanRigorName(value);
#endif
    if (m_PlanRigor != value)
    {
      m_PlanRigor = value;
      this->Modified();
    }
  }
  itkGetConstReferenceMacro(PlanRigor, int);
  void
  SetPlanRigor(const std::string & name)
  {
#ifndef ITK_USE_CUFFTW
    this->SetPlanRigor(FFTWGlobalConfiguration::GetPlanRigorValue(name));
#endif
  }

  SizeValueType
  GetSizeGreatestPrimeFactor() const override;
 
protected:
  FFTWInverseFFTImageFilter();
  ~FFTWInverseFFTImageFilter() override = default;
 
  void
  BeforeThreadedGenerateData() override;
 
  void
  DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  int m_PlanRigor{};
};
 
 
// Describe whether input/output are real- or complex-valued
// for factory registration
template <>
struct FFTImageFilterTraits<FFTWInverseFFTImageFilter>
{
  template <typename TUnderlying>
  using InputPixelType = std::complex<TUnderlying>;
  template <typename TUnderlying>
  using OutputPixelType = TUnderlying;
  using FilterDimensions = std::integer_sequence<unsigned int, 4, 3, 2, 1>;
};
 
// Disable the precision whose FFTW backend is absent (avoids instantiating an undefined fftw proxy).
#if !defined(ITK_USE_FFTWF)
template <>
struct FFTImageFilterEnableFloat<FFTWInverseFFTImageFilter> : std::false_type
{};
#endif
#if !defined(ITK_USE_FFTWD)
template <>
struct FFTImageFilterEnableDouble<FFTWInverseFFTImageFilter> : std::false_type
{};
#endif
 
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkFFTWInverseFFTImageFilter.hxx"
#endif
 
#endif // itkFFTWInverseFFTImageFilter_h