1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkConditionalConstIterator_h
#define itkConditionalConstIterator_h
#include "itkIndex.h"
namespace itk
{
/** \class ConditionalConstIterator
* \brief A base class for other iterators where membership in the set
* of output pixels is conditional upon some property, calculation,
* etc. For example, a threshold iterator might walk a region and
* return only those pixels which meet a minimum intensity condition.
*
* This class is the const version of the ConditionalIterator.
* For this reason, it doesn't support the Set() method.
*
* \ingroup ImageIterators
* \ingroup ITKCommon
*/
template <typename TImage>
class ITK_TEMPLATE_EXPORT ConditionalConstIterator
{
public:
/** Standard class type aliases. */
using Self = ConditionalConstIterator;
/** Dimension of the image the iterator walks. This constant is needed so
* that functions that are templated over image iterator type (as opposed to
* being templated over pixel type and dimension) can have compile time
* access to the dimension of the image that the iterator walks. */
static constexpr unsigned int NDimension = TImage::ImageDimension;
/** Index type alias support. */
using IndexType = typename TImage::IndexType;
/** Size type alias support. */
using SizeType = typename TImage::SizeType;
/** Region type alias support. */
using RegionType = typename TImage::RegionType;
/** Image type alias support. */
using ImageType = TImage;
/** Internal Pixel Type */
using InternalPixelType = typename TImage::InternalPixelType;
/** External Pixel Type */
using PixelType = typename TImage::PixelType;
/** Compute whether the index of interest should be included in the flood */
virtual bool
IsPixelIncluded(const IndexType & index) const = 0;
/** operator= is provided to make sure the handle to the image is properly
* reference counted. */
Self &
operator=(const Self & it)
{
m_IsAtEnd = it.m_IsAtEnd; // copy the end flag
m_Image = it.m_Image; // copy the smart pointer
m_Region = it.m_Region; // copy the region
return *this;
}
/** Get the dimension (size) of the index. */
static unsigned int
GetIteratorDimension()
{
return Self::NDimension;
}
/** Get the index at the current iterator location. */
virtual const IndexType
GetIndex() = 0;
/** Get the pixel value at the current iterator location. */
virtual const PixelType
Get() const = 0;
/** Is the iterator at the end of the region? */
virtual bool
IsAtEnd() const = 0;
/** Walk forward one index. */
virtual void
operator++() = 0;
/** Constructor */
ConditionalConstIterator() = default;
/** Destructor */
virtual ~ConditionalConstIterator() = default;
protected: // made protected so other iterators can access
/** Smart pointer to the source image. */
// SmartPointer<const ImageType> m_Image;
typename ImageType::ConstWeakPointer m_Image{};
/** Region type to iterate over. */
RegionType m_Region{};
/** Is the iterator at the end of its walk? */
bool m_IsAtEnd{ false };
};
} // end namespace itk
#endif
|