ITK  5.4.0
Insight Toolkit
itkImageRandomIteratorWithIndex.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  * https://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 itkImageRandomIteratorWithIndex_h
19 #define itkImageRandomIteratorWithIndex_h
20 
23 
24 namespace itk
25 {
66 template <typename TImage>
67 class ITK_TEMPLATE_EXPORT ImageRandomIteratorWithIndex : public ImageRandomConstIteratorWithIndex<TImage>
68 {
69 public:
73 
75  using typename Superclass::IndexType;
76  using typename Superclass::SizeType;
77  using typename Superclass::OffsetType;
78  using typename Superclass::RegionType;
79  using typename Superclass::ImageType;
80  using typename Superclass::PixelContainer;
81  using typename Superclass::PixelContainerPointer;
82  using typename Superclass::InternalPixelType;
83  using typename Superclass::PixelType;
84  using typename Superclass::AccessorType;
85 
87  ImageRandomIteratorWithIndex() = default;
88 
91  ImageRandomIteratorWithIndex(ImageType * ptr, const RegionType & region);
92 
100 
102  void
103  Set(const PixelType & value) const
104  {
105  this->m_PixelAccessorFunctor.Set(*(const_cast<InternalPixelType *>(this->m_Position)), value);
106  }
107 
111  PixelType &
113  {
114  return *(const_cast<InternalPixelType *>(this->m_Position));
115  }
116 
117 protected:
121  Self &
122  operator=(const ImageRandomConstIteratorWithIndex<TImage> & it);
123 };
124 } // end namespace itk
127 #ifndef ITK_MANUAL_INSTANTIATION
128 # include "itkImageRandomIteratorWithIndex.hxx"
129 #endif
130 
131 #endif
itk::ImageConstIteratorWithIndex::PixelContainerPointer
typename PixelContainer::Pointer PixelContainerPointer
Definition: itkImageConstIteratorWithIndex.h:122
itk::GTest::TypedefsAndConstructors::Dimension2::SizeType
ImageBaseType::SizeType SizeType
Definition: itkGTestTypedefsAndConstructors.h:49
itk::ImageConstIteratorWithIndex::PixelType
typename TImage::PixelType PixelType
Definition: itkImageConstIteratorWithIndex.h:128
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
itkImageRandomConstIteratorWithIndex.h
itkImageIteratorWithIndex.h
itk::GTest::TypedefsAndConstructors::Dimension2::RegionType
ImageBaseType::RegionType RegionType
Definition: itkGTestTypedefsAndConstructors.h:54
itk::ImageConstIteratorWithIndex::AccessorType
typename TImage::AccessorType AccessorType
Definition: itkImageConstIteratorWithIndex.h:132
itk::ImageRandomIteratorWithIndex::Set
void Set(const PixelType &value) const
Definition: itkImageRandomIteratorWithIndex.h:103
itk::ImageConstIteratorWithIndex
A base class for multi-dimensional iterators templated over image type that are designed to efficient...
Definition: itkImageConstIteratorWithIndex.h:92
itk::ImageRandomIteratorWithIndex::Value
PixelType & Value()
Definition: itkImageRandomIteratorWithIndex.h:112
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::ImageRandomIteratorWithIndex
A multi-dimensional image iterator that visits a random set of pixels within an image region.
Definition: itkImageRandomIteratorWithIndex.h:67
AddImageFilter
Definition: itkAddImageFilter.h:81
itk::ImageConstIteratorWithIndex::ImageType
TImage ImageType
Definition: itkImageConstIteratorWithIndex.h:116
itk::ImageConstIteratorWithIndex::PixelContainer
typename TImage::PixelContainer PixelContainer
Definition: itkImageConstIteratorWithIndex.h:121
itk::ImageRandomConstIteratorWithIndex
A multi-dimensional image iterator that visits a random set of pixels within an image region.
Definition: itkImageRandomConstIteratorWithIndex.h:116
itk::ImageConstIteratorWithIndex::OffsetType
typename TImage::OffsetType OffsetType
Definition: itkImageConstIteratorWithIndex.h:136