ITK  6.0.0
Insight Toolkit
itkConditionalConstIterator.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 itkConditionalConstIterator_h
19#define itkConditionalConstIterator_h
20
21#include "itkIndex.h"
22
23namespace itk
24{
37template <typename TImage>
38class ITK_TEMPLATE_EXPORT ConditionalConstIterator
39{
40public:
43
48 static constexpr unsigned int NDimension = TImage::ImageDimension;
49
51 using IndexType = typename TImage::IndexType;
52
54 using SizeType = typename TImage::SizeType;
55
58
60 using ImageType = TImage;
61
63 using InternalPixelType = typename TImage::InternalPixelType;
64
66 using PixelType = typename TImage::PixelType;
67
69 virtual bool
70 IsPixelIncluded(const IndexType & index) const = 0;
71
74 Self &
75 operator=(const Self & it)
76 {
77 m_IsAtEnd = it.m_IsAtEnd; // copy the end flag
78 m_Image = it.m_Image; // copy the smart pointer
79 m_Region = it.m_Region; // copy the region
80 return *this;
81 }
82
84 static unsigned int
86 {
87 return Self::NDimension;
88 }
89
91 virtual const IndexType
92 GetIndex() = 0;
93
95 virtual const PixelType
96 Get() const = 0;
97
99 virtual bool
100 IsAtEnd() const = 0;
101
103 virtual void
105
108
110 virtual ~ConditionalConstIterator() = default;
111
112protected: // made protected so other iterators can access
114 // SmartPointer<const ImageType> m_Image;
115 typename ImageType::ConstWeakPointer m_Image{};
116
118 RegionType m_Region{};
119
121 bool m_IsAtEnd{ false };
122};
123} // end namespace itk
124
125#endif
A base class for other iterators where membership in the set of output pixels is conditional upon som...
virtual bool IsPixelIncluded(const IndexType &index) const =0
typename TImage::IndexType IndexType
virtual ~ConditionalConstIterator()=default
typename TImage::PixelType PixelType
typename TImage::InternalPixelType InternalPixelType
virtual const PixelType Get() const =0
virtual const IndexType GetIndex()=0
virtual bool IsAtEnd() const =0
typename TImage::RegionType RegionType
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....