itkMagnitudeAndPhaseToComplexImageFilter.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 itkMagnitudeAndPhaseToComplexImageFilter_h
#define itkMagnitudeAndPhaseToComplexImageFilter_h
 
#include "itkBinaryGeneratorImageFilter.h"
 
namespace itk
{
namespace Functor
{
template <typename TInput1, typename TInput2, typename TOutput>
class MagnitudeAndPhaseToComplex
{
public:
  MagnitudeAndPhaseToComplex() = default;
  ~MagnitudeAndPhaseToComplex() = default;
  bool
  operator==(const MagnitudeAndPhaseToComplex &) const
  {
    return true;
  }
 
  ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(MagnitudeAndPhaseToComplex);
 
  inline std::complex<TOutput>
  operator()(const TInput1 & A, const TInput2 & B) const
  {
    return std::complex<TOutput>(std::polar(static_cast<TOutput>(A), static_cast<TOutput>(B)));
  }
};
} // namespace Functor
 
template <typename TInputImage1,
          typename TInputImage2 = TInputImage1,
          typename TOutputImage =
            itk::Image<std::complex<typename TInputImage1::PixelType>, TInputImage1::ImageDimension>>
class MagnitudeAndPhaseToComplexImageFilter
  : public BinaryGeneratorImageFilter<TInputImage1, TInputImage2, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MagnitudeAndPhaseToComplexImageFilter);
 
  using Self = MagnitudeAndPhaseToComplexImageFilter;
 
  using Superclass = BinaryGeneratorImageFilter<TInputImage1, TInputImage2, TOutputImage>;
 
  using InputPixel1Type = typename TInputImage1::PixelType;
  using InputPixel2Type = typename TInputImage2::PixelType;
  using OutputPixelType = typename TOutputImage::PixelType;
 
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using FunctorType = Functor::MagnitudeAndPhaseToComplex<typename TInputImage1::PixelType,
                                                          typename TInputImage2::PixelType,
                                                          typename TOutputImage::PixelType::value_type>;
 
  itkNewMacro(Self);
 
  itkTypeMacro(MagnitudeAndPhaseToComplexImageFilter, BinaryGeneratorImageFilter);
 
#ifdef ITK_USE_CONCEPT_CHECKING
  // Begin concept checking
  itkConceptMacro(Input1ConvertibleToDoubleCheck, (Concept::Convertible<InputPixel1Type, double>));
  itkConceptMacro(Input2ConvertibleToDoubleCheck, (Concept::Convertible<InputPixel2Type, double>));
  itkConceptMacro(DoubleConvertibleToOutputCheck, (Concept::Convertible<double, OutputPixelType>));
  // End concept checking
#endif
 
protected:
  MagnitudeAndPhaseToComplexImageFilter()
  {
#if !defined(ITK_WRAPPING_PARSER)
    Superclass::SetFunctor(FunctorType());
#endif
  }
 
  ~MagnitudeAndPhaseToComplexImageFilter() override = default;
};
} // end namespace itk
 
#endif