ITK  5.3.0
Insight Toolkit
itkImageIterator.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 itkImageIterator_h
19 #define itkImageIterator_h
20 
21 #include "itkImageConstIterator.h"
22 
23 namespace itk
24 {
64 template <typename TImage>
65 class ITK_TEMPLATE_EXPORT ImageIterator : public ImageConstIterator<TImage>
66 {
67 public:
68 
71 
76  static constexpr unsigned int ImageIteratorDimension = TImage::ImageDimension;
77 
80 
82  using IndexType = typename Superclass::IndexType;
83  using SizeType = typename Superclass::SizeType;
86  using ImageType = typename Superclass::ImageType;
90  using PixelType = typename Superclass::PixelType;
92 
95  ImageIterator() = default;
96 
98  ~ImageIterator() override = default;
99 
102  ImageIterator(const Self & it);
103 
106  ImageIterator(TImage * ptr, const RegionType & region);
107 
110  Self &
111  operator=(const Self & it);
112 
114  void
115  Set(const PixelType & value) const
116  {
117  // const_cast is needed here because m_Buffer is declared as a const
118  // pointer in the superclass which is the ConstIterator.
119  this->m_PixelAccessorFunctor.Set(*(const_cast<InternalPixelType *>(this->m_Buffer) + this->m_Offset), value);
120  }
121 
125  PixelType &
127  {
128  // const_cast is needed here because m_Buffer is declared as a const
129  // pointer in the superclass which is the ConstIterator.
130  return *(const_cast<InternalPixelType *>(this->m_Buffer) + this->m_Offset);
131  }
132 
134  ImageType *
135  GetImage() const
136  {
137  // const_cast is needed here because m_Image is declared as a const pointer
138  // in the base class which is the ConstIterator.
139  return const_cast<ImageType *>(this->m_Image.GetPointer());
140  }
141 
142 protected:
146  Self &
147  operator=(const ImageConstIterator<TImage> & it);
148 };
149 } // end namespace itk
151 
152 #ifndef ITK_MANUAL_INSTANTIATION
153 # include "itkImageIterator.hxx"
154 #endif
155 
156 #endif
itkImageConstIterator.h
itk::ImageConstIterator::SizeType
typename TImage::SizeType SizeType
Definition: itkImageConstIterator.h:103
itk::ImageConstIterator::PixelType
typename TImage::PixelType PixelType
Definition: itkImageConstIterator.h:124
itk::ImageIterator::Set
void Set(const PixelType &value) const
Definition: itkImageIterator.h:115
itk::ImageConstIterator::OffsetType
typename TImage::OffsetType OffsetType
Definition: itkImageConstIterator.h:106
itk::ImageConstIterator::AccessorType
typename TImage::AccessorType AccessorType
Definition: itkImageConstIterator.h:128
itk::ImageConstIterator::RegionType
typename TImage::RegionType RegionType
Definition: itkImageConstIterator.h:109
itk::GTest::TypedefsAndConstructors::Dimension2::SizeType
ImageBaseType::SizeType SizeType
Definition: itkGTestTypedefsAndConstructors.h:49
itk::ImageConstIterator::PixelContainerPointer
typename PixelContainer::Pointer PixelContainerPointer
Definition: itkImageConstIterator.h:118
itk::GTest::TypedefsAndConstructors::Dimension2::IndexType
ImageBaseType::IndexType IndexType
Definition: itkGTestTypedefsAndConstructors.h:50
itk::ImageIterator::Value
PixelType & Value()
Definition: itkImageIterator.h:126
itk::GTest::TypedefsAndConstructors::Dimension2::RegionType
ImageBaseType::RegionType RegionType
Definition: itkGTestTypedefsAndConstructors.h:54
itk::ImageConstIterator::InternalPixelType
typename TImage::InternalPixelType InternalPixelType
Definition: itkImageConstIterator.h:121
itk::ImageIterator
A multi-dimensional iterator templated over image type.
Definition: itkImageIterator.h:65
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::ImageConstIterator
A multi-dimensional image iterator templated over image type.
Definition: itkImageConstIterator.h:84
itk::ImageConstIterator::ImageType
TImage ImageType
Definition: itkImageConstIterator.h:112
itk::ImageConstIterator::PixelContainer
typename TImage::PixelContainer PixelContainer
Definition: itkImageConstIterator.h:117
itk::ImageIterator::GetImage
ImageType * GetImage() const
Definition: itkImageIterator.h:135
itk::ImageConstIterator::IndexType
typename TImage::IndexType IndexType
Definition: itkImageConstIterator.h:100