itkFFTWComplexToComplexFFTImageFilter.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 itkFFTWComplexToComplexFFTImageFilter_h
#define itkFFTWComplexToComplexFFTImageFilter_h
 
#include "itkComplexToComplexFFTImageFilter.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 = TInputImage>
class ITK_TEMPLATE_EXPORT FFTWComplexToComplexFFTImageFilter
  : public ComplexToComplexFFTImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(FFTWComplexToComplexFFTImageFilter);

  using Self = FFTWComplexToComplexFFTImageFilter;
  using Superclass = ComplexToComplexFFTImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using typename Superclass::ImageType;
  using PixelType = typename ImageType::PixelType;
  using typename Superclass::InputImageType;
  using typename Superclass::OutputImageType;
  using OutputImageRegionType = typename OutputImageType::RegionType;
 
  // the proxy type is a wrapper for the fftw API
  // since the proxy is only defined over double and float,
  // trying to use any other pixel type is inoperative, as
  // is trying to use double if only the float FFTW version is
  // configured in, or float if only double is configured.
  //
  using FFTWProxyType = typename fftw::Proxy<typename PixelType::value_type>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(FFTWComplexToComplexFFTImageFilter);
 
  static constexpr unsigned int ImageDimension = ImageType::ImageDimension;

  using ImageSizeType = typename ImageType::SizeType;

  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
  }

protected:
  FFTWComplexToComplexFFTImageFilter();
  ~FFTWComplexToComplexFFTImageFilter() override = default;
 
  void
  UpdateOutputData(DataObject * output) override;
 
  void
  BeforeThreadedGenerateData() override;
 
  void
  DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  bool m_CanUseDestructiveAlgorithm{};
 
  int m_PlanRigor{};
};
 
 
// Describe whether input/output are real- or complex-valued
// for factory registration
template <>
struct FFTImageFilterTraits<FFTWComplexToComplexFFTImageFilter>
{
  template <typename TUnderlying>
  using InputPixelType = std::complex<TUnderlying>;
  template <typename TUnderlying>
  using OutputPixelType = std::complex<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<FFTWComplexToComplexFFTImageFilter> : std::false_type
{};
#endif
#if !defined(ITK_USE_FFTWD)
template <>
struct FFTImageFilterEnableDouble<FFTWComplexToComplexFFTImageFilter> : std::false_type
{};
#endif
 
 
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkFFTWComplexToComplexFFTImageFilter.hxx"
#endif
 
#endif // itkFFTWComplexToComplexFFTImageFilter_h