ITK  5.2.0
Insight Toolkit
itkConstrainedValueAdditionImageFilter.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 itkConstrainedValueAdditionImageFilter_h
19 #define itkConstrainedValueAdditionImageFilter_h
20 
22 #include "itkNumericTraits.h"
23 
24 namespace itk
25 {
26 namespace Functor
27 {
33 template <typename TInput1, typename TInput2, typename TOutput>
35 {
36 public:
37  ConstrainedValueAddition() = default;
38  ~ConstrainedValueAddition() = default;
39  bool
41  {
42  return false;
43  }
45 
46  bool
47  operator==(const ConstrainedValueAddition & other) const
48  {
49  return !(*this != other);
50  }
51 
52  inline TOutput
53  operator()(const TInput1 & A, const TInput2 & B) const
54  {
55  const auto dA = static_cast<double>(A);
56  const auto dB = static_cast<double>(B);
57  const double add = dA + dB;
58  const double cadd1 = (add < NumericTraits<TOutput>::max()) ? add : NumericTraits<TOutput>::max();
59  const double cadd2 =
61 
62  return static_cast<TOutput>(cadd2);
63  }
64 };
65 } // namespace Functor
66 
97 template <typename TInputImage1, typename TInputImage2, typename TOutputImage>
98 class ConstrainedValueAdditionImageFilter : public BinaryGeneratorImageFilter<TInputImage1, TInputImage2, TOutputImage>
99 {
100 public:
101  ITK_DISALLOW_COPY_AND_MOVE(ConstrainedValueAdditionImageFilter);
102 
108  using FunctorType = Functor::ConstrainedValueAddition<typename TInputImage1::PixelType,
109  typename TInputImage2::PixelType,
110  typename TOutputImage::PixelType>;
111 
113  itkNewMacro(Self);
114 
117 
118 #ifdef ITK_USE_CONCEPT_CHECKING
119  // Begin concept checking
124  // End concept checking
125 #endif
126 
127 protected:
129  {
130 #if !defined(ITK_WRAPPING_PARSER)
132 #endif
133  }
134  ~ConstrainedValueAdditionImageFilter() override = default;
135 };
136 } // end namespace itk
137 
138 #endif
itk::ConstrainedValueAdditionImageFilter::ConstrainedValueAdditionImageFilter
ConstrainedValueAdditionImageFilter()
Definition: itkConstrainedValueAdditionImageFilter.h:128
itk::ConstrainedValueAdditionImageFilter::FunctorType
Functor::ConstrainedValueAddition< typename TInputImage1::PixelType, typename TInputImage2::PixelType, typename TOutputImage::PixelType > FunctorType
Definition: itkConstrainedValueAdditionImageFilter.h:110
itk::Functor::ConstrainedValueAddition::operator()
TOutput operator()(const TInput1 &A, const TInput2 &B) const
Definition: itkConstrainedValueAdditionImageFilter.h:53
itk::NumericTraits::NonpositiveMin
static constexpr T NonpositiveMin()
Definition: itkNumericTraits.h:97
itk::Functor::ConstrainedValueAddition
Definition: itkConstrainedValueAdditionImageFilter.h:34
itk::BinaryGeneratorImageFilter
Implements pixel-wise generic operation of two images, or of an image and a constant.
Definition: itkBinaryGeneratorImageFilter.h:56
itk::SmartPointer< Self >
itk::ConstrainedValueAdditionImageFilter::~ConstrainedValueAdditionImageFilter
~ConstrainedValueAdditionImageFilter() override=default
itkBinaryGeneratorImageFilter.h
itk::ImageSource
Base class for all process objects that output image data.
Definition: itkImageSource.h:67
itk::Functor::ConstrainedValueAddition::operator==
bool operator==(const ConstrainedValueAddition &other) const
Definition: itkConstrainedValueAdditionImageFilter.h:47
itk::ConstrainedValueAdditionImageFilter
Implements pixel-wise the computation of constrained value addition.
Definition: itkConstrainedValueAdditionImageFilter.h:98
itk::Functor::ConstrainedValueAddition::operator!=
bool operator!=(const ConstrainedValueAddition &) const
Definition: itkConstrainedValueAdditionImageFilter.h:40
itk::NumericTraits
Define additional traits for native types such as int or float.
Definition: itkNumericTraits.h:58
itk::NumericTraits::max
static constexpr T max(const T &)
Definition: itkNumericTraits.h:167
itk::Functor::ConstrainedValueAddition::~ConstrainedValueAddition
~ConstrainedValueAddition()=default
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::Concept::Convertible
Definition: itkConceptChecking.h:214
itkNumericTraits.h
itk::Concept::LessThanComparable
Definition: itkConceptChecking.h:260
itk::BinaryGeneratorImageFilter::SetFunctor
void SetFunctor(const std::function< ConstRefFunctionType > &f)
Definition: itkBinaryGeneratorImageFilter.h:150
itk::Functor::ConstrainedValueAddition::ConstrainedValueAddition
ConstrainedValueAddition()=default