itkComplexToComplex1DFFTImageFilter.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 itkComplexToComplex1DFFTImageFilter_h
#define itkComplexToComplex1DFFTImageFilter_h
 
#include <complex>
 
#include "itkImage.h"
#include "itkImageToImageFilter.h"
#include "itkMacro.h"
 
namespace itk
{
template <typename TInputImage, typename TOutputImage = TInputImage>
class ITK_TEMPLATE_EXPORT ComplexToComplex1DFFTImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ComplexToComplex1DFFTImageFilter);

  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;
  using OutputImageRegionType = typename OutputImageType::RegionType;
 
  using Self = ComplexToComplex1DFFTImageFilter;
  using Superclass = ImageToImageFilter<InputImageType, OutputImageType>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  static constexpr unsigned int ImageDimension = InputImageType::ImageDimension;
 
  itkOverrideGetNameOfClassMacro(ComplexToComplex1DFFTImageFilter);

  itkFactoryOnlyNewMacro(Self);

  enum TransformDirectionType
  {
    DIRECT = 1,
    INVERSE
  };

  itkSetMacro(TransformDirection, TransformDirectionType);
  itkGetConstMacro(TransformDirection, TransformDirectionType);

  itkGetConstMacro(Direction, unsigned int);

  itkSetClampMacro(Direction, unsigned int, 0, InputImageType::ImageDimension - 1);

  virtual SizeValueType
  GetSizeGreatestPrimeFactor() const
  {
    return 2;
  }
 
protected:
  ComplexToComplex1DFFTImageFilter();
  ~ComplexToComplex1DFFTImageFilter() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  GenerateInputRequestedRegion() override;
  void
  EnlargeOutputRequestedRegion(DataObject * output) override;

  unsigned int m_Direction{ 0 };

  TransformDirectionType m_TransformDirection{ DIRECT };
 
private:
};
 
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkComplexToComplex1DFFTImageFilter.hxx"
#endif
 
#ifdef ITK_FFTIMAGEFILTERINIT_FACTORY_REGISTER_MANAGER
#  include "itkFFTImageFilterInitFactoryRegisterManager.h"
#endif
 
#endif // itkComplexToComplex1DFFTImageFilter_h