ITK  5.4.0
Insight Toolkit
itkSquaredDifferenceImageFilter.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  * https://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 itkSquaredDifferenceImageFilter_h
19 #define itkSquaredDifferenceImageFilter_h
20 
22 
23 namespace itk
24 {
54 namespace Functor
55 {
56 template <typename TInput1, typename TInput2, typename TOutput>
58 {
59 public:
60  bool
62  {
63  return true;
64  }
68 
69  inline TOutput
70  operator()(const TInput1 & A, const TInput2 & B) const
71  {
72  const auto dA = static_cast<double>(A);
73  const auto dB = static_cast<double>(B);
74  const double diff = dA - dB;
75 
76  return static_cast<TOutput>(diff * diff);
77  }
78 };
79 } // namespace Functor
80 
81 template <typename TInputImage1, typename TInputImage2, typename TOutputImage>
82 class ITK_TEMPLATE_EXPORT SquaredDifferenceImageFilter
83  : public BinaryGeneratorImageFilter<TInputImage1, TInputImage2, TOutputImage>
84 {
85 public:
86  ITK_DISALLOW_COPY_AND_MOVE(SquaredDifferenceImageFilter);
87 
91 
94 
95  using FunctorType = Functor::SquaredDifference2<typename TInputImage1::PixelType,
96  typename TInputImage2::PixelType,
97  typename TOutputImage::PixelType>;
98 
100  itkNewMacro(Self);
101 
103  itkOverrideGetNameOfClassMacro(SquaredDifferenceImageFilter);
104 
105 #ifdef ITK_USE_CONCEPT_CHECKING
106  // Begin concept checking
110  // End concept checking
111 #endif
112 
113 protected:
115  {
116 #if !defined(ITK_WRAPPING_PARSER)
117  Superclass::SetFunctor(FunctorType());
118 #endif
119  }
120  ~SquaredDifferenceImageFilter() override = default;
121 };
122 } // end namespace itk
123 
124 #endif
itk::SquaredDifferenceImageFilter
Implements pixel-wise the computation of squared difference.
Definition: itkSquaredDifferenceImageFilter.h:82
itk::Functor::SquaredDifference2::operator()
TOutput operator()(const TInput1 &A, const TInput2 &B) const
Definition: itkSquaredDifferenceImageFilter.h:70
itk::BinaryGeneratorImageFilter
Implements pixel-wise generic operation of two images, or of an image and a constant.
Definition: itkBinaryGeneratorImageFilter.h:56
itk::SmartPointer< Self >
itkBinaryGeneratorImageFilter.h
itk::ImageSource
Base class for all process objects that output image data.
Definition: itkImageSource.h:67
itk::SquaredDifferenceImageFilter::SquaredDifferenceImageFilter
SquaredDifferenceImageFilter()
Definition: itkSquaredDifferenceImageFilter.h:114
itk::Functor::SquaredDifference2::ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION
ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(SquaredDifference2)
FunctorType
Functor::Add2< typename TInputImage1::PixelType, typename TInputImage2::PixelType, typename TOutputImage::PixelType > FunctorType
Definition: itkAddImageFilter.h:97
itkConceptMacro
#define itkConceptMacro(name, concept)
Definition: itkConceptChecking.h:65
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:139
itk::Concept::Convertible
Definition: itkConceptChecking.h:216
itk::Functor::SquaredDifference2
Definition: itkSquaredDifferenceImageFilter.h:57
itk::Functor::SquaredDifference2::operator==
bool operator==(const SquaredDifference2 &) const
Definition: itkSquaredDifferenceImageFilter.h:61