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 itkConstantPadImageFilter_h
#define itkConstantPadImageFilter_h
#include "itkPadImageFilter.h"
#include "itkMath.h"
#include "itkConstantBoundaryCondition.h"
namespace itk
{
/** \class ConstantPadImageFilter
* \brief Increase the image size by padding with a constant value.
*
* ConstantPadImageFilter changes the output image region. If the output
* image region is larger than the input image region, the extra pixels are
* filled in by a constant value. The output image region must be specified.
*
* \image html PadImageFilter.png "Visual explanation of padding regions."
*
* This filter is implemented as a multithreaded filter. It provides a
* DynamicThreadedGenerateData() method for its implementation.
*
* \ingroup GeometricTransform
* \sa WrapPadImageFilter, MirrorPadImageFilter
* \ingroup ITKImageGrid
*
* \sphinx
* \sphinxexample{Filtering/ImageGrid/PadAnImageWithAConstant,Pad An Image With A Constant}
* \endsphinx
*/
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT ConstantPadImageFilter : public PadImageFilter<TInputImage, TOutputImage>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(ConstantPadImageFilter);
/** Standard class type aliases. */
using Self = ConstantPadImageFilter;
using Superclass = PadImageFilter<TInputImage, TOutputImage>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(ConstantPadImageFilter);
/** Typedef to describe the output image region type. */
using typename Superclass::OutputImageRegionType;
using typename Superclass::InputImageRegionType;
/** Typedef to describe the type of pixel. */
using typename Superclass::OutputImagePixelType;
using typename Superclass::InputImagePixelType;
/** Typedef to describe the output and input image index and size types. */
using typename Superclass::OutputImageIndexType;
using typename Superclass::InputImageIndexType;
using typename Superclass::OutputImageSizeType;
using typename Superclass::InputImageSizeType;
/** ImageDimension constants */
static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;
/** Set/Get the pad value. Default is Zero. */
void
SetConstant(OutputImagePixelType constant)
{
if (Math::NotExactlyEquals(constant, m_InternalBoundaryCondition.GetConstant()))
{
m_InternalBoundaryCondition.SetConstant(constant);
this->Modified();
}
}
OutputImagePixelType
GetConstant() const
{
return m_InternalBoundaryCondition.GetConstant();
}
#ifdef ITK_USE_CONCEPT_CHECKING
// Begin concept checking
itkConceptMacro(OutputEqualityComparableCheck, (Concept::EqualityComparable<OutputImagePixelType>));
itkConceptMacro(InputConvertibleToOutputCheck, (Concept::Convertible<InputImagePixelType, OutputImagePixelType>));
itkConceptMacro(SameDimensionCheck, (Concept::SameDimension<ImageDimension, OutputImageDimension>));
itkConceptMacro(OutputOStreamWritableCheck, (Concept::OStreamWritable<OutputImagePixelType>));
// End concept checking
#endif
protected:
ConstantPadImageFilter();
~ConstantPadImageFilter() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
private:
ConstantBoundaryCondition<TInputImage, TOutputImage> m_InternalBoundaryCondition{};
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkConstantPadImageFilter.hxx"
#endif
#endif
|
