itkComplexToPhaseImageFilter.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 itkComplexToPhaseImageFilter_h
#define itkComplexToPhaseImageFilter_h
 
#include "itkUnaryGeneratorImageFilter.h"
#include "itkMath.h"
 
namespace itk
{
namespace Functor
{
template <typename TInput, typename TOutput>
class ComplexToPhase
{
public:
  bool
  operator==(const ComplexToPhase &) const
  {
    return true;
  }
 
  ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(ComplexToPhase);
 
  inline TOutput
  operator()(const TInput & A) const
  {
    return static_cast<TOutput>(std::atan2(A.imag(), A.real()));
  }
};
} // namespace Functor
 
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT ComplexToPhaseImageFilter : public UnaryGeneratorImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ComplexToPhaseImageFilter);

  using Self = ComplexToPhaseImageFilter;
  using Superclass = UnaryGeneratorImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
  using FunctorType = Functor::ComplexToPhase<typename TInputImage::PixelType, typename TOutputImage::PixelType>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ComplexToPhaseImageFilter);
 
  using InputPixelType = typename TInputImage::PixelType;
  using OutputPixelType = typename TOutputImage::PixelType;
  using InputPixelValueType = typename NumericTraits<InputPixelType>::ValueType;
 
  itkConceptMacro(InputConvertibleToOutputCheck, (Concept::Convertible<InputPixelValueType, OutputPixelType>));
 
protected:
  ComplexToPhaseImageFilter()
  {
#if !defined(ITK_WRAPPING_PARSER)
    Superclass::SetFunctor(FunctorType());
#endif
  }
 
  ~ComplexToPhaseImageFilter() override = default;
};
} // end namespace itk
 
#endif