forked from InsightSoftwareConsortium/ITK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
itkImageIteratorWithIndex.h
142 lines (118 loc) · 5.75 KB
/
itkImageIteratorWithIndex.h
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: itkImageIteratorWithIndex.h
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) Insight Software Consortium. All rights reserved.
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef __itkImageIteratorWithIndex_h
#define __itkImageIteratorWithIndex_h
#include "itkImageConstIteratorWithIndex.h"
namespace itk
{
/**
* \class ImageIteratorWithIndex
* \brief A base class for multi-dimensional iterators templated over image
* type that are designed to efficiently keep track of the iterator
* position.
*
* This class inherits from ImageConstIteratorWithIndex and only adds
* write-access functionality. See ImageConstIteratorWithIndex for more
* information.
*
* \par MORE INFORMATION
* For a complete description of the ITK Image Iterators and their API, please
* see the Iterators chapter in the ITK Software Guide. The ITK Software Guide
* is available in print and as a free .pdf download from http://www.itk.org.
*
* \ingroup ImageIterators
*
* \sa ImageConstIterator \sa ConditionalConstIterator
* \sa ConstNeighborhoodIterator \sa ConstShapedNeighborhoodIterator
* \sa ConstSliceIterator \sa CorrespondenceDataStructureIterator
* \sa FloodFilledFunctionConditionalConstIterator
* \sa FloodFilledImageFunctionConditionalConstIterator
* \sa FloodFilledImageFunctionConditionalIterator
* \sa FloodFilledSpatialFunctionConditionalConstIterator
* \sa FloodFilledSpatialFunctionConditionalIterator
* \sa ImageConstIterator \sa ImageConstIteratorWithIndex
* \sa ImageIterator \sa ImageIteratorWithIndex
* \sa ImageLinearConstIteratorWithIndex \sa ImageLinearIteratorWithIndex
* \sa ImageRandomConstIteratorWithIndex \sa ImageRandomIteratorWithIndex
* \sa ImageRegionConstIterator \sa ImageRegionConstIteratorWithIndex
* \sa ImageRegionExclusionConstIteratorWithIndex
* \sa ImageRegionExclusionIteratorWithIndex
* \sa ImageRegionIterator \sa ImageRegionIteratorWithIndex
* \sa ImageRegionReverseConstIterator \sa ImageRegionReverseIterator
* \sa ImageReverseConstIterator \sa ImageReverseIterator
* \sa ImageSliceConstIteratorWithIndex \sa ImageSliceIteratorWithIndex
* \sa NeighborhoodIterator \sa PathConstIterator \sa PathIterator
* \sa ShapedNeighborhoodIterator \sa SliceIterator
* \sa ImageConstIteratorWithIndex
*
* */
template<typename TImage>
class ITK_EXPORT ImageIteratorWithIndex : public ImageConstIteratorWithIndex<TImage>
{
public:
/** Standard class typedefs. */
typedef ImageIteratorWithIndex Self;
/** Dimension of the image the iterator walks. This constant is needed so
* 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. */
itkStaticConstMacro(ImageIteratorDimension, unsigned int,
TImage::ImageDimension);
/** Define the superclass */
typedef ImageConstIteratorWithIndex<TImage> Superclass;
/** Inherit types from the superclass */
typedef typename Superclass::IndexType IndexType;
typedef typename Superclass::IndexValueType IndexValueType;
typedef typename Superclass::SizeType SizeType;
typedef typename Superclass::SizeValueType SizeValueType;
typedef typename Superclass::OffsetType OffsetType;
typedef typename Superclass::OffsetValueType OffsetValueType;
typedef typename Superclass::RegionType RegionType;
typedef typename Superclass::ImageType ImageType;
typedef typename Superclass::PixelContainer PixelContainer;
typedef typename Superclass::PixelContainerPointer PixelContainerPointer;
typedef typename Superclass::InternalPixelType InternalPixelType;
typedef typename Superclass::PixelType PixelType;
typedef typename Superclass::AccessorType AccessorType;
/** Default Constructor. Need to provide a default constructor since we
* provide a copy constructor. */
ImageIteratorWithIndex();
/** Default Destructor */
~ImageIteratorWithIndex() {};
/** Copy Constructor. The copy constructor is provided to make sure the
* handle to the image is properly reference counted. */
ImageIteratorWithIndex(const Self& it);
/** Constructor establishes an iterator to walk a particular image and a
* particular region of that image. */
ImageIteratorWithIndex(TImage *ptr, const RegionType& region);
/** operator= is provided to make sure the handle to the image is properly
* reference counted. */
Self &operator=(const Self& it);
/** Set the pixel value */
void Set( const PixelType & value) const
{ this->m_PixelAccessor.Set(*(const_cast<InternalPixelType *>(this->m_Position)),value); }
/** Return a reference to the pixel
* This method will provide the fastest access to pixel
* data, but it will NOT support ImageAdaptors. */
PixelType & Value(void)
{ return *(const_cast<InternalPixelType *>(this->m_Position)); }
protected:
/** This constructor is declared protected in order to enforce const-correctness */
ImageIteratorWithIndex(const ImageConstIteratorWithIndex<TImage> & it);
Self &operator=(const ImageConstIteratorWithIndex<TImage> & it);
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkImageIteratorWithIndex.txx"
#endif
#endif