itkComplexToComplexFFTImageFilter.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 itkComplexToComplexFFTImageFilter_h
#define itkComplexToComplexFFTImageFilter_h
 
#include "itkImageToImageFilter.h"
#include "itkMacro.h"
#include "ITKFFTExport.h"
#include <complex>
 
namespace itk
{
class ComplexToComplexFFTImageFilterEnums
{
public:
  enum class TransformDirection : uint8_t
  {
    FORWARD = 1,
    INVERSE = 2
  };
};
// Define how to print enumeration
extern ITKFFT_EXPORT std::ostream &
operator<<(std::ostream & out, const ComplexToComplexFFTImageFilterEnums::TransformDirection value);

template <typename TInputImage, typename TOutputImage = TInputImage>
class ITK_TEMPLATE_EXPORT ComplexToComplexFFTImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ComplexToComplexFFTImageFilter);

  using ImageType = TInputImage;
  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;

  using Self = ComplexToComplexFFTImageFilter;
  using Superclass = ImageToImageFilter<InputImageType, OutputImageType>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  static constexpr unsigned int ImageDimension = InputImageType::ImageDimension;

  itkOverrideGetNameOfClassMacro(ComplexToComplexFFTImageFilter);

  itkFactoryOnlyNewMacro(Self);
 
  using TransformDirectionEnum = ComplexToComplexFFTImageFilterEnums::TransformDirection;
#if !defined(ITK_LEGACY_REMOVE)
  static constexpr TransformDirectionEnum FORWARD = TransformDirectionEnum::FORWARD;
  static constexpr TransformDirectionEnum INVERSE = TransformDirectionEnum::INVERSE;
#endif

  using ImageSizeType = typename ImageType::SizeType;

  itkSetEnumMacro(TransformDirection, TransformDirectionEnum);
  itkGetConstMacro(TransformDirection, TransformDirectionEnum);
 
protected:
  ComplexToComplexFFTImageFilter() = default;
 
  void
  GenerateInputRequestedRegion() override;
 
private:
  TransformDirectionEnum m_TransformDirection{ TransformDirectionEnum::FORWARD };
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkComplexToComplexFFTImageFilter.hxx"
#endif
 
#ifdef ITK_FFTIMAGEFILTERINIT_FACTORY_REGISTER_MANAGER
#  include "itkFFTImageFilterInitFactoryRegisterManager.h"
#endif
 
#endif