1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
/*=========================================================================
*
* 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 itkAddImageFilter_h
#define itkAddImageFilter_h
#include "itkBinaryGeneratorImageFilter.h"
#include "itkArithmeticOpsFunctors.h"
#include "itkNumericTraits.h"
namespace itk
{
/**
* \class AddImageFilter
* \brief Pixel-wise addition of two images.
*
* This class is templated over the types of the two
* input images and the type of the output image.
* Numeric conversions (castings) are done by the C++ defaults.
*
* The pixel type of the input 1 image must have a valid definition of
* the operator+ with a pixel type of the image 2. This condition is
* required because internally this filter will perform the operation
*
\code
pixel_from_image_1 + pixel_from_image_2
\endcode
*
* Additionally the type resulting from the sum, will be cast to
* the pixel type of the output image.
*
* The total operation over one pixel will be
\code
output_pixel = static_cast<OutputPixelType>( input1_pixel + input2_pixel )
\endcode
*
* For example, this filter could be used directly for adding images whose
* pixels are vectors of the same dimension, and to store the resulting vector
* in an output image of vector pixels.
*
* The images to be added are set using the methods:
\code
SetInput1( image1 );
SetInput2( image2 );
\endcode
*
* Additionally, this filter can be used to add a constant to every pixel of an
* image by using
\code
SetInput1( image1 );
SetConstant2( constant );
\endcode
*
* \warning No numeric overflow checking is performed in this filter.
*
* \ingroup IntensityImageFilters
* \ingroup MultiThreaded
* \ingroup ITKImageIntensity
*
* \sphinx
* \sphinxexample{Filtering/ImageIntensity/AddTwoImages,Add Two Images Together}
* \sphinxexample{Filtering/ImageIntensity/AddConstantToEveryPixel,Add Constant To Every Pixel}
* \endsphinx
*/
template <typename TInputImage1, typename TInputImage2 = TInputImage1, typename TOutputImage = TInputImage1>
class ITK_TEMPLATE_EXPORT AddImageFilter : public BinaryGeneratorImageFilter<TInputImage1, TInputImage2, TOutputImage>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(AddImageFilter);
/** Standard class type aliases. */
using Self = AddImageFilter;
using Superclass = BinaryGeneratorImageFilter<TInputImage1, TInputImage2, TOutputImage>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
using FunctorType =
Functor::Add2<typename TInputImage1::PixelType, typename TInputImage2::PixelType, typename TOutputImage::PixelType>;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(AddImageFilter);
#ifdef ITK_USE_CONCEPT_CHECKING
// Begin concept checking
itkConceptMacro(Input1Input2OutputAdditiveOperatorsCheck,
(Concept::AdditiveOperators<typename TInputImage1::PixelType,
typename TInputImage2::PixelType,
typename TOutputImage::PixelType>));
// End concept checking
#endif
protected:
AddImageFilter()
{
#if !defined(ITK_WRAPPING_PARSER)
Superclass::SetFunctor(FunctorType());
#endif
}
~AddImageFilter() override = default;
};
} // end namespace itk
#endif
|
