ITK  5.2.0
Insight Toolkit
itkSquareImageFilter.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 itkSquareImageFilter_h
19 #define itkSquareImageFilter_h
20 
22 
23 namespace itk
24 {
37 namespace Functor
38 {
39 template <typename TInput, typename TOutput>
40 class Square
41 {
42 public:
44  Square() = default;
45  ~Square() = default;
46  bool
47  operator!=(const Square &) const
48  {
49  return false;
50  }
51 
52  bool
53  operator==(const Square & other) const
54  {
55  return !(*this != other);
56  }
57 
58  inline TOutput
59  operator()(const TInput & A) const
60  {
61  const auto ra = static_cast<RealType>(A);
62 
63  return static_cast<TOutput>(ra * ra);
64  }
65 };
66 } // namespace Functor
67 template <typename TInputImage, typename TOutputImage>
68 class SquareImageFilter : public UnaryGeneratorImageFilter<TInputImage, TOutputImage>
69 {
70 public:
71  ITK_DISALLOW_COPY_AND_ASSIGN(SquareImageFilter);
72 
79 
81  itkNewMacro(Self);
82 
85 
86 #ifdef ITK_USE_CONCEPT_CHECKING
87  // Begin concept checking
89  itkConceptMacro(RealTypeMultiplyOperatorCheck,
91  // End concept checking
92 #endif
93 
94 protected:
96  {
97 #if !defined(ITK_WRAPPING_PARSER)
99 #endif
100  }
101 
102  ~SquareImageFilter() override = default;
103 };
104 } // end namespace itk
105 
106 #endif
itk::SquareImageFilter
Computes the square of the intensity values pixel-wise.
Definition: itkSquareImageFilter.h:68
itk::Concept::HasNumericTraits
Definition: itkConceptChecking.h:712
itk::UnaryGeneratorImageFilter::SetFunctor
void SetFunctor(const std::function< ConstRefFunctionType > &f)
Definition: itkUnaryGeneratorImageFilter.h:92
itk::Functor::Square
Definition: itkSquareImageFilter.h:40
itk::Functor::Square::operator()
TOutput operator()(const TInput &A) const
Definition: itkSquareImageFilter.h:59
itk::SquareImageFilter::SquareImageFilter
SquareImageFilter()
Definition: itkSquareImageFilter.h:95
itk::Functor::Square::operator!=
bool operator!=(const Square &) const
Definition: itkSquareImageFilter.h:47
itk::UnaryGeneratorImageFilter
Implements pixel-wise generic "operation" on one image.
Definition: itkUnaryGeneratorImageFilter.h:55
itk::SmartPointer< Self >
itkUnaryGeneratorImageFilter.h
itk::ImageSource
Base class for all process objects that output image data.
Definition: itkImageSource.h:67
itk::Functor::Square::operator==
bool operator==(const Square &other) const
Definition: itkSquareImageFilter.h:53
itk::SquareImageFilter::~SquareImageFilter
~SquareImageFilter() override=default
itk::Concept::MultiplyOperator
Definition: itkConceptChecking.h:417
itk::NumericTraits
Define additional traits for native types such as int or float.
Definition: itkNumericTraits.h:58
itkConceptMacro
#define itkConceptMacro(name, concept)
Definition: itkConceptChecking.h:64
itk::SquareImageFilter::FunctorType
Functor::Square< typename TInputImage::PixelType, typename TOutputImage::PixelType > FunctorType
Definition: itkSquareImageFilter.h:78
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::NumericTraits::RealType
double RealType
Definition: itkNumericTraits.h:84
itk::Functor::Square::RealType
typename NumericTraits< TInput >::RealType RealType
Definition: itkSquareImageFilter.h:43
itk::Functor::Square::Square
Square()=default
itk::Functor::Square::~Square
~Square()=default