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
|
/*=========================================================================
*
* 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 itkLineIterator_h
#define itkLineIterator_h
#include "itkLineConstIterator.h"
namespace itk
{
/**
* \class LineIterator
* \brief An iterator that walks a Bresenham line through an ND image
* with write access to pixels.
*
* LineIterator is an iterator that walks a Bresenham line
* through an image. The iterator is constructed similar to other
* image iterators, except instead of specifying a region to
* traverse, you specify two indices. The interval specified by
* the two indices is closed. So, a line iterator specified with
* the same start and end index will visit exactly one pixel.
*
\code
LineConstIterator<ImageType> it(image, I1, I2);
while (!it.IsAtEnd())
{
// visits at least 1 pixel
}
\endcode
*
* \author Benjamin King, Experimentelle Radiologie, Medizinische
* Hochschule Hannover.
*
* \sa LineConstIterator
* \ingroup ITKCommon
*
* \sphinx
* \sphinxexample{Core/Common/IterateLineThroughImage,Iterate Line Through Image}
* \endsphinx
*/
template <typename TImage>
class ITK_TEMPLATE_EXPORT LineIterator : public LineConstIterator<TImage>
{
public:
/** Standard class type aliases. */
using Self = LineIterator;
/** Dimension of the image that the iterator walks. This constant is needed so
* that functions that are templated over image iterator type (as opposed to
* being templated over pixel type and dimension) can have compile time
* access to the dimension of the image that the iterator walks. */
static constexpr unsigned int ImageIteratorDimension = TImage::ImageDimension;
/** Define the superclass */
using Superclass = LineConstIterator<TImage>;
/** Inherit types from the superclass */
using typename Superclass::IndexType;
using typename Superclass::OffsetType;
using typename Superclass::SizeType;
using typename Superclass::RegionType;
using typename Superclass::ImageType;
using typename Superclass::PixelContainer;
using typename Superclass::PixelContainerPointer;
using typename Superclass::InternalPixelType;
using typename Superclass::PixelType;
using typename Superclass::AccessorType;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(LineIterator);
/** Set the pixel value */
void
Set(const PixelType & value)
{
// Normally, this would just be the following:
// m_Image->SetPixel(m_CurrentImageIndex,value);
// However, we don't want a warning about m_Image being a ConstPointer
// in the Superclass.
const_cast<ImageType *>(this->m_Image.GetPointer())->SetPixel(this->m_CurrentImageIndex, value);
}
/** Return a reference to the pixel.
* This method will provide the fastest access to pixel
* data, but it will NOT support ImageAdaptors. */
const PixelType &
Value()
{
return (this->m_Image->GetPixel(this->m_CurrentImageIndex));
}
/** operator= is provided to make sure the handle to the image is properly
* reference counted. */
Self &
operator=(const Self & it);
/** Constructor establishes an iterator to walk along a path */
LineIterator(ImageType * imagePtr, const IndexType & firstIndex, const IndexType & lastIndex);
/** Default Destructor. */
~LineIterator() override = default;
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkLineIterator.hxx"
#endif
#endif
|
