ITK  5.3.0
Insight Toolkit
itkImageIteratorWithIndex.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 itkImageIteratorWithIndex_h
19 #define itkImageIteratorWithIndex_h
20 
22 
23 namespace itk
24 {
67 template <typename TImage>
68 class ITK_TEMPLATE_EXPORT ImageIteratorWithIndex : public ImageConstIteratorWithIndex<TImage>
69 {
70 public:
71 
74 
79  static constexpr unsigned int ImageIteratorDimension = TImage::ImageDimension;
80 
83 
85  using typename Superclass::IndexType;
86  using typename Superclass::SizeType;
87  using typename Superclass::OffsetType;
88  using typename Superclass::RegionType;
89  using typename Superclass::ImageType;
90  using typename Superclass::PixelContainer;
91  using typename Superclass::PixelContainerPointer;
92  using typename Superclass::InternalPixelType;
93  using typename Superclass::PixelType;
94  using typename Superclass::AccessorType;
95 
98  ImageIteratorWithIndex() = default;
99 
101  ~ImageIteratorWithIndex() override = default;
102 
105  ImageIteratorWithIndex(const Self & it);
106 
109  ImageIteratorWithIndex(TImage * ptr, const RegionType & region);
110 
113  Self &
114  operator=(const Self & it);
115 
117  void
118  Set(const PixelType & value) const
119  {
120  this->m_PixelAccessor.Set(*(const_cast<InternalPixelType *>(this->m_Position)), value);
121  }
122 
126  PixelType &
128  {
129  return *(const_cast<InternalPixelType *>(this->m_Position));
130  }
131 
132 protected:
136  Self &
137  operator=(const ImageConstIteratorWithIndex<TImage> & it);
138 };
139 } // end namespace itk
141 
142 #ifndef ITK_MANUAL_INSTANTIATION
143 # include "itkImageIteratorWithIndex.hxx"
144 #endif
145 
146 #endif
itk::ImageConstIteratorWithIndex::PixelContainerPointer
typename PixelContainer::Pointer PixelContainerPointer
Definition: itkImageConstIteratorWithIndex.h:122
itkImageConstIteratorWithIndex.h
itk::GTest::TypedefsAndConstructors::Dimension2::SizeType
ImageBaseType::SizeType SizeType
Definition: itkGTestTypedefsAndConstructors.h:49
itk::ImageConstIteratorWithIndex::PixelType
typename TImage::PixelType PixelType
Definition: itkImageConstIteratorWithIndex.h:128
itk::ImageIteratorWithIndex::Set
void Set(const PixelType &value) const
Definition: itkImageIteratorWithIndex.h:118
itk::ImageConstIteratorWithIndex::InternalPixelType
typename TImage::InternalPixelType InternalPixelType
Definition: itkImageConstIteratorWithIndex.h:125
itk::ImageIteratorWithIndex
A base class for multi-dimensional iterators templated over image type that are designed to efficient...
Definition: itkImageIteratorWithIndex.h:68
itk::GTest::TypedefsAndConstructors::Dimension2::IndexType
ImageBaseType::IndexType IndexType
Definition: itkGTestTypedefsAndConstructors.h:50
itk::GTest::TypedefsAndConstructors::Dimension2::RegionType
ImageBaseType::RegionType RegionType
Definition: itkGTestTypedefsAndConstructors.h:54
itk::ImageConstIteratorWithIndex::AccessorType
typename TImage::AccessorType AccessorType
Definition: itkImageConstIteratorWithIndex.h:132
itk::ImageConstIteratorWithIndex
A base class for multi-dimensional iterators templated over image type that are designed to efficient...
Definition: itkImageConstIteratorWithIndex.h:92
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::ImageConstIteratorWithIndex::RegionType
typename TImage::RegionType RegionType
Definition: itkImageConstIteratorWithIndex.h:113
itk::ImageConstIteratorWithIndex::ImageType
TImage ImageType
Definition: itkImageConstIteratorWithIndex.h:116
itk::ImageConstIteratorWithIndex::PixelContainer
typename TImage::PixelContainer PixelContainer
Definition: itkImageConstIteratorWithIndex.h:121
itk::ImageConstIteratorWithIndex::OffsetType
typename TImage::OffsetType OffsetType
Definition: itkImageConstIteratorWithIndex.h:136
itk::ImageIteratorWithIndex::Value
PixelType & Value()
Definition: itkImageIteratorWithIndex.h:127