ITK  5.0.0
Insight Segmentation and Registration Toolkit
itkConditionalConstIterator.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright Insight Software Consortium
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 itkConditionalConstIterator_h
19 #define itkConditionalConstIterator_h
20 
21 #include "itkIndex.h"
22 
23 namespace itk
24 {
37 template< typename TImage >
38 class ITK_TEMPLATE_EXPORT ConditionalConstIterator
39 {
40 public:
43 
48  static constexpr unsigned int NDimension = TImage::ImageDimension;
49 
51  using IndexType = typename TImage::IndexType;
52 
54  using SizeType = typename TImage::SizeType;
55 
57  using RegionType = typename TImage::RegionType;
58 
60  using ImageType = TImage;
61 
63  using InternalPixelType = typename TImage::InternalPixelType;
64 
66  using PixelType = typename TImage::PixelType;
67 
69  virtual bool IsPixelIncluded(const IndexType & index) const = 0;
70 
73  Self & operator=(const Self & it)
74  {
75  m_IsAtEnd = it.m_IsAtEnd; // copy the end flag
76  m_Image = it.m_Image; // copy the smart pointer
77  m_Region = it.m_Region; // copy the region
78  return *this;
79  }
80 
82  static unsigned int GetIteratorDimension()
83  {
84  return Self::NDimension;
85  }
86 
88  virtual const IndexType GetIndex() = 0;
89 
91  virtual const PixelType Get() const = 0;
92 
94  virtual bool IsAtEnd() const = 0;
95 
97  virtual void operator++() = 0;
98 
100  ConditionalConstIterator() = default;
101 
103  virtual ~ConditionalConstIterator() = default;
104 
105 protected: //made protected so other iterators can access
107  //SmartPointer<const ImageType> m_Image;
108  typename ImageType::ConstWeakPointer m_Image;
109 
112 
114  bool m_IsAtEnd{false};
115 };
116 } // end namespace itk
117 
118 #endif
typename TImage::RegionType RegionType
typename TImage::InternalPixelType InternalPixelType
typename TImage::PixelType PixelType
typename TImage::IndexType IndexType
A base class for other iterators where membership in the set of output pixels is conditional upon som...