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
126
127
|
/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: itkImageRandomIteratorWithIndex.h
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) Insight Software Consortium. All rights reserved.
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef __itkImageRandomIteratorWithIndex_h
#define __itkImageRandomIteratorWithIndex_h
#include "itkImageRandomConstIteratorWithIndex.h"
#include "itkImageIteratorWithIndex.h"
namespace itk
{
/** \class ImageRandomIteratorWithIndex
* \brief A multi-dimensional image iterator that visits a random set of pixels
* within an image region.
*
* This class is a subclass of itkImageRandomConstIteratorWithIndex that adds
* write-access functionality. Please see itkImageRandomConstIteratorWithIndex
* for more information.
*
* \par MORE INFORMATION
* For a complete description of the ITK Image Iterators and their API, please
* see the Iterators chapter in the ITK Software Guide. The ITK Software Guide
* is available in print and as a free .pdf download from http://www.itk.org.
*
* \ingroup ImageIterators
*
* \sa ImageConstIterator \sa ConditionalConstIterator
* \sa ConstNeighborhoodIterator \sa ConstShapedNeighborhoodIterator
* \sa ConstSliceIterator \sa CorrespondenceDataStructureIterator
* \sa FloodFilledFunctionConditionalConstIterator
* \sa FloodFilledImageFunctionConditionalConstIterator
* \sa FloodFilledImageFunctionConditionalIterator
* \sa FloodFilledSpatialFunctionConditionalConstIterator
* \sa FloodFilledSpatialFunctionConditionalIterator
* \sa ImageConstIterator \sa ImageConstIteratorWithIndex
* \sa ImageIterator \sa ImageIteratorWithIndex
* \sa ImageLinearConstIteratorWithIndex \sa ImageLinearIteratorWithIndex
* \sa ImageRandomConstIteratorWithIndex \sa ImageRandomIteratorWithIndex
* \sa ImageRegionConstIterator \sa ImageRegionConstIteratorWithIndex
* \sa ImageRegionExclusionConstIteratorWithIndex
* \sa ImageRegionExclusionIteratorWithIndex
* \sa ImageRegionIterator \sa ImageRegionIteratorWithIndex
* \sa ImageRegionReverseConstIterator \sa ImageRegionReverseIterator
* \sa ImageReverseConstIterator \sa ImageReverseIterator
* \sa ImageSliceConstIteratorWithIndex \sa ImageSliceIteratorWithIndex
* \sa NeighborhoodIterator \sa PathConstIterator \sa PathIterator
* \sa ShapedNeighborhoodIterator \sa SliceIterator
* \sa ImageConstIteratorWithIndex */
template<typename TImage>
class ITK_EXPORT ImageRandomIteratorWithIndex : public ImageRandomConstIteratorWithIndex<TImage>
{
public:
/** Standard class typedefs. */
typedef ImageRandomIteratorWithIndex Self;
typedef ImageRandomConstIteratorWithIndex<TImage> Superclass;
/** Types inherited from the Superclass */
typedef typename Superclass::IndexType IndexType;
typedef typename Superclass::IndexValueType IndexValueType;
typedef typename Superclass::SizeType SizeType;
typedef typename Superclass::SizeValueType SizeValueType;
typedef typename Superclass::OffsetType OffsetType;
typedef typename Superclass::OffsetValueType OffsetValueType;
typedef typename Superclass::RegionType RegionType;
typedef typename Superclass::ImageType ImageType;
typedef typename Superclass::PixelContainer PixelContainer;
typedef typename Superclass::PixelContainerPointer PixelContainerPointer;
typedef typename Superclass::InternalPixelType InternalPixelType;
typedef typename Superclass::PixelType PixelType;
typedef typename Superclass::AccessorType AccessorType;
/** Default constructor. Needed since we provide a cast constructor. */
ImageRandomIteratorWithIndex();
/** Constructor establishes an iterator to walk a particular image and a
* particular region of that image. */
ImageRandomIteratorWithIndex(ImageType *ptr, const RegionType& region);
/** Constructor that can be used to cast from an ImageIterator to an
* ImageRandomIteratorWithIndex. Many routines return an ImageIterator but for a
* particular task, you may want an ImageRandomIteratorWithIndex. Rather than
* provide overloaded APIs that return different types of Iterators, itk
* returns ImageIterators and uses constructors to cast from an
* ImageIterator to a ImageRandomIteratorWithIndex. */
ImageRandomIteratorWithIndex( const ImageIteratorWithIndex<TImage> &it);
/** Set the pixel value */
void Set( const PixelType & value) const
{ this->m_PixelAccessorFunctor.Set(*(const_cast<InternalPixelType *>(this->m_Position)),value); }
/** Return a reference to the pixel
* This method will provide the fastest access to pixel
* data, but it will NOT support ImageAdaptors. */
PixelType & Value(void)
{ return *(const_cast<InternalPixelType *>(this->m_Position)); }
protected:
/** the construction from a const iterator is declared protected
in order to enforce const correctness. */
ImageRandomIteratorWithIndex( const ImageRandomConstIteratorWithIndex<TImage> &it);
Self & operator=(const ImageRandomConstIteratorWithIndex<TImage> & it);
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkImageRandomIteratorWithIndex.txx"
#endif
#endif
|
