ITK  5.2.0
Insight Toolkit
itkComplexToPhaseImageFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 #ifndef itkComplexToPhaseImageFilter_h
19 #define itkComplexToPhaseImageFilter_h
20 
22 #include "itkMath.h"
23 
24 namespace itk
25 {
33 namespace Functor
34 {
35 template <typename TInput, typename TOutput>
37 {
38 public:
39  ComplexToPhase() = default;
40  ~ComplexToPhase() = default;
41  bool
42  operator!=(const ComplexToPhase &) const
43  {
44  return false;
45  }
47 
48  bool
49  operator==(const ComplexToPhase & other) const
50  {
51  return !(*this != other);
52  }
53 
54  inline TOutput
55  operator()(const TInput & A) const
56  {
57  return static_cast<TOutput>(std::atan2(A.imag(), A.real()));
58  }
59 };
60 } // namespace Functor
61 
62 template <typename TInputImage, typename TOutputImage>
63 class ComplexToPhaseImageFilter : public UnaryGeneratorImageFilter<TInputImage, TOutputImage>
64 {
65 public:
66  ITK_DISALLOW_COPY_AND_MOVE(ComplexToPhaseImageFilter);
67 
74 
76  itkNewMacro(Self);
77 
80 
81  using InputPixelType = typename TInputImage::PixelType;
82  using OutputPixelType = typename TOutputImage::PixelType;
84 
85 #ifdef ITK_USE_CONCEPT_CHECKING
86  // Begin concept checking
88  // End concept checking
89 #endif
90 
91 protected:
93  {
94 #if !defined(ITK_WRAPPING_PARSER)
96 #endif
97  }
98 
99  ~ComplexToPhaseImageFilter() override = default;
100 };
101 } // end namespace itk
102 
103 #endif
itk::ComplexToPhaseImageFilter::InputPixelValueType
typename NumericTraits< InputPixelType >::ValueType InputPixelValueType
Definition: itkComplexToPhaseImageFilter.h:83
itk::UnaryGeneratorImageFilter::SetFunctor
void SetFunctor(const std::function< ConstRefFunctionType > &f)
Definition: itkUnaryGeneratorImageFilter.h:92
itk::Functor::ComplexToPhase::operator()
TOutput operator()(const TInput &A) const
Definition: itkComplexToPhaseImageFilter.h:55
itk::ComplexToPhaseImageFilter::InputPixelType
typename TInputImage::PixelType InputPixelType
Definition: itkComplexToPhaseImageFilter.h:81
itk::UnaryGeneratorImageFilter
Implements pixel-wise generic "operation" on one image.
Definition: itkUnaryGeneratorImageFilter.h:55
itk::SmartPointer< Self >
itkUnaryGeneratorImageFilter.h
itk::Functor::ComplexToPhase::ComplexToPhase
ComplexToPhase()=default
itk::ImageSource
Base class for all process objects that output image data.
Definition: itkImageSource.h:67
itk::Functor::ComplexToPhase::operator!=
bool operator!=(const ComplexToPhase &) const
Definition: itkComplexToPhaseImageFilter.h:42
itk::NumericTraits
Define additional traits for native types such as int or float.
Definition: itkNumericTraits.h:58
itk::ComplexToPhaseImageFilter::ComplexToPhaseImageFilter
ComplexToPhaseImageFilter()
Definition: itkComplexToPhaseImageFilter.h:92
itkConceptMacro
#define itkConceptMacro(name, concept)
Definition: itkConceptChecking.h:64
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::ProcessObject
The base class for all process objects (source, filters, mappers) in the Insight data processing pipe...
Definition: itkProcessObject.h:138
itk::ComplexToPhaseImageFilter::~ComplexToPhaseImageFilter
~ComplexToPhaseImageFilter() override=default
itk::Concept::Convertible
Definition: itkConceptChecking.h:214
itk::Functor::ComplexToPhase
Definition: itkComplexToPhaseImageFilter.h:36
itk::ComplexToPhaseImageFilter
Computes pixel-wise the modulus of a complex image.
Definition: itkComplexToPhaseImageFilter.h:63
itk::ComplexToPhaseImageFilter::OutputPixelType
typename TOutputImage::PixelType OutputPixelType
Definition: itkComplexToPhaseImageFilter.h:82
itk::ComplexToPhaseImageFilter::FunctorType
Functor::ComplexToPhase< typename TInputImage::PixelType, typename TOutputImage::PixelType > FunctorType
Definition: itkComplexToPhaseImageFilter.h:73
itkMath.h
itk::Functor::ComplexToPhase::~ComplexToPhase
~ComplexToPhase()=default
itk::Functor::ComplexToPhase::operator==
bool operator==(const ComplexToPhase &other) const
Definition: itkComplexToPhaseImageFilter.h:49