File: cmtkRegionIndexIterator.h

package info (click to toggle)
cmtk 3.3.1p2%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 10,524 kB
  • sloc: cpp: 87,098; ansic: 23,347; sh: 3,896; xml: 1,551; perl: 707; makefile: 334
file content (153 lines) | stat: -rw-r--r-- 3,881 bytes parent folder | download | duplicates (5)
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
/*
//
//  Copyright 2010-2012 SRI International
//
//  Copyright 2010 Torsten Rohlfing
//
//  This file is part of the Computational Morphometry Toolkit.
//
//  http://www.nitrc.org/projects/cmtk/
//
//  The Computational Morphometry Toolkit is free software: you can
//  redistribute it and/or modify it under the terms of the GNU General Public
//  License as published by the Free Software Foundation, either version 3 of
//  the License, or (at your option) any later version.
//
//  The Computational Morphometry Toolkit is distributed in the hope that it
//  will be useful, but WITHOUT ANY WARRANTY; without even the implied
//  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License along
//  with the Computational Morphometry Toolkit.  If not, see
//  <http://www.gnu.org/licenses/>.
//
//  $Revision: 5436 $
//
//  $LastChangedDate: 2018-12-10 19:01:20 -0800 (Mon, 10 Dec 2018) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkRegionIndexIterator_h_included_
#define __cmtkRegionIndexIterator_h_included_

#include <cmtkconfig.h>

#include <Base/cmtkRegion.h>
#include <Base/cmtkFixedVector.h>

#include <System/cmtkSmartPtr.h>
#include <System/cmtkSmartConstPtr.h>

namespace
cmtk
{
/// Iterator for rectangular region of n-dimensional image, providing grid index of each position.
template<typename TRegion>
class RegionIndexIterator
{
public:
  /// This class.
  typedef RegionIndexIterator<TRegion> Self;

  /// Region type.
  typedef TRegion RegionType;

  /// Region dimension.
  static const size_t Dimension = RegionType::Dimension;

  /// Region scalar type.
  typedef typename RegionType::ScalarType ScalarType;

  /// Index type.
  typedef FixedVector<Self::Dimension,typename Self::ScalarType> IndexType;

  /// Smart pointer to this class.
  typedef SmartPointer<Self> SmartPtr;

  /// Smart pointer-to-const to this class.
  typedef SmartConstPointer<Self> SmartConstPtr;

  /// Constructor from two index, from and to.
  RegionIndexIterator( const typename Self::RegionType& region )
    : m_Region( region ),
      m_Index( region.From() )
  {
    this->m_End = this->m_Region.From();
    if ( this->m_Region.From() < this->m_Region.To() )
      {
      // for non-empty regions "End" index is one after last valid element.
      this->m_End[Self::Dimension-1] = this->m_Region.To()[Self::Dimension-1];
      }
    // (for empty regions, "From" is already the "End"
  }

  /// Increment operator.
  Self& operator++()
  {
    for ( size_t idx = 0; idx < Self::Dimension; ++idx)
      {
      if ( (++this->m_Index[idx]) >= this->m_Region.To()[idx] )
	{
	if ( idx+1 < Self::Dimension )
	  this->m_Index[idx] = this->m_Region.From()[idx];
	}
      else
	break;
      }
    return *this;
  }
  
  /// Get index.
  const typename Self::IndexType& Index() const
  {
    return this->m_Index;
  }

  /// Region "begin" index.
  const typename Self::IndexType begin() const
  {
    return this->m_Region.From();
  }
  
  /// Region "end" index.
  const typename Self::IndexType& end() const
  {
    return this->m_End;
  }

  /// Assign index.
  Self& operator=( const typename Self::IndexType& index )
  {
    this->m_Index = index;
    return *this;
  }

  /// Index equality.
  bool operator==( const typename Self::IndexType& index )
  {
    return (this->m_Index == index);
  }

  /// Index inequality.
  bool operator!=( const typename Self::IndexType& index )
  {
    return !(this->m_Index == index);
  }

private:
  /// Iterated region.
  typename Self::RegionType m_Region;

  /// End index (i.e., first non-valid index).
  typename Self::IndexType m_End;

  /// Current index.
  typename Self::IndexType m_Index;
};

} // namespace cmtk

#endif // #ifndef __cmtkRegionIndexIterator_h_included_