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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: itkSize.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 __itkSize_h
#define __itkSize_h
#include <cstring>
#include "itkMacro.h"
namespace itk
{
/** \class Size
* \brief Represent the size (bounds) of a n-dimensional image.
*
* Size is a class to represent multi-dimensional array bounds,
* templated over the dimension. Insight assumes that the first
* element of Size is the fastest moving index.
*
* For the sake of efficiency, Size does not define a default constructor, a
* copy constructor, or an operator=. We rely on the compiler to provide
* efficient bitwise copies.
*
* Size is an "aggregate" class. Its data is public (m_Size)
* allowing for fast and convenient instantiations/assignments.
*
* The following syntax for assigning a size is allowed/suggested:
* Size<3> size = {256, 256, 20};
*
* \sa Index
* \ingroup ImageObjects
*/
template<unsigned int VDimension=2>
class Size {
public:
/** Standard class typedefs. */
typedef Size Self;
/** Compatible Size and value typedef */
typedef Size<VDimension> SizeType;
typedef unsigned long SizeValueType;
/** Get the dimension of the size object. */
static unsigned int GetSizeDimension(void) { return VDimension; }
/** Add two sizes. */
const Self
operator+(const Self &vec) const
{
Self result;
for (unsigned int i=0; i < VDimension; i++)
{ result[i] = m_Size[i] + vec.m_Size[i]; }
return result;
}
/** Increment size by a size. */
const Self &
operator+=(const Self &vec)
{
for (unsigned int i=0; i < VDimension; i++)
{ m_Size[i] += vec.m_Size[i]; }
return *this;
}
/** Subtract two sizes. */
const Self
operator-(const Self &vec) const
{
Self result;
for (unsigned int i=0; i < VDimension; i++)
{ result[i] = m_Size[i] - vec.m_Size[i]; }
return result;
}
/** Decrement size by a size. */
const Self &
operator-=(const Self &vec)
{
for (unsigned int i=0; i < VDimension; i++)
{ m_Size[i] -= vec.m_Size[i]; }
return *this;
}
/** Multiply two sizes (elementwise product). */
const Self
operator*(const Self &vec) const
{
Self result;
for (unsigned int i=0; i < VDimension; i++)
{ result[i] = m_Size[i] * vec.m_Size[i]; }
return result;
}
/** Multiply two sizes (elementwise product). */
const Self &
operator*=(const Self &vec)
{
for (unsigned int i=0; i < VDimension; i++)
{ m_Size[i] *= vec.m_Size[i]; }
return *this;
}
/** Compare two sizes. */
bool
operator==(const Self &vec) const
{
bool same=1;
for (unsigned int i=0; i < VDimension && same; i++)
{ same = (m_Size[i] == vec.m_Size[i]); }
return same;
}
/** Compare two sizes. */
bool
operator!=(const Self &vec) const
{
bool same=1;
for (unsigned int i=0; i < VDimension && same; i++)
{ same = (m_Size[i] == vec.m_Size[i]); }
return !same;
}
/** Access an element of the size. Elements are numbered
* 0, ..., VDimension-1. No bounds checking is performed. */
SizeValueType & operator[](unsigned int dim)
{ return m_Size[dim]; }
/** Access an element of the size. Elements are numbered
* 0, ..., VDimension-1. This version can only be an rvalue.
* No bounds checking is performed. */
SizeValueType operator[](unsigned int dim) const
{ return m_Size[dim]; }
/** Get the size. This provides a read only reference to the size.
* \sa SetSize */
const SizeValueType *GetSize() const { return m_Size; }
/** Set the size.
* Try to prototype this function so that val has to point to a block of
* memory that is the appropriate size. \sa GetSize */
void SetSize(const SizeValueType val[VDimension])
{ memcpy(m_Size, val, sizeof(SizeValueType)*VDimension); }
/** Set an element of the Size.
* sets the value of one of the elements in the Size
* This method is mainly intended to facilitate the access to elements
* from Tcl and Python where C++ notation is not very convenient.
* \warning No bound checking is performed.
* \sa SetSize() \sa GetElement() */
void SetElement(unsigned long element, SizeValueType val )
{ m_Size[ element ] = val; }
/** Get an element of the Size.
* gets the value of one of the elements in the size
* This method is mainly intended to facilitate the access to elements
* from Tcl and Python where C++ notation is not very convenient.
* \warning No bound checking is performed
* \sa GetSize() \sa SetElement() */
SizeValueType GetElement( unsigned long element ) const
{ return m_Size[ element ]; }
/** Set one value for the index in all dimensions. Useful for initializing
* an offset to zero. */
void Fill(SizeValueType value)
{ for(unsigned int i=0;i < VDimension; ++i) m_Size[i] = value; }
/** Size is an "aggregate" class. Its data is public (m_Size)
* allowing for fast and convenient instantiations/assignments.
*
* The following syntax for assigning a size is allowed/suggested:
*
* Size<3> size = {{256, 256, 20}};
*
* The doubled braces {{ and }} are required to prevent `gcc -Wall'
* (and perhaps other compilers) from complaining about a partly
* bracketed initializer. */
SizeValueType m_Size[VDimension];
// force gccxml to find the constructors found before the internal upgrade to gcc 4.2
#if defined(CABLE_CONFIGURATION)
Size(); //purposely not implemented
Size(const Self&); //purposely not implemented
void operator=(const Self&); //purposely not implemented
#endif
};
template<unsigned int VDimension>
std::ostream & operator<<(std::ostream &os, const Size<VDimension> &size)
{
os << "[";
for (unsigned int i=0; i+1 < VDimension; ++i)
{
os << size[i] << ", ";
}
if (VDimension >= 1)
{
os << size[VDimension-1];
}
os << "]";
return os;
}
} // end namespace itk
#endif
|
