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
|
/*=========================================================================
*
* 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 itkArray2D_h
#define itkArray2D_h
#include "itkMacro.h"
#include "itkIntTypes.h"
#include "vnl/vnl_matrix.h"
namespace itk
{
/** \class Array2D
* \brief Array2D class representing a 2D array.
*
* This class derives from the vnl_matrix<> class.
*
* The class is templated over the type of the elements.
*
* Template parameters for class Array2D:
*
* - TValue = Element type stored at each location in the array.
*
* \ingroup DataRepresentation
* \ingroup ITKCommon
*/
template <typename TValue>
class ITK_TEMPLATE_EXPORT Array2D : public vnl_matrix<TValue>
{
public:
/** The element type stored at each location in the Array2D. */
using ValueType = TValue;
using Self = Array2D;
using VnlMatrixType = vnl_matrix<TValue>;
/** Default-constructor. Creates a matrix of size zero (0 rows and 0 columns). */
Array2D() = default;
/** Constructs a matrix of the specified number of rows and columns. */
Array2D(unsigned int numberOfRows, unsigned int numberOfCols);
/** Constructs a matrix of the specified number of rows and columns, with each element having the specified initial
* value. */
Array2D(unsigned int numberOfRows, unsigned int numberOfCols, const TValue & initialValue);
/** Copy-constructor. */
Array2D(const Self & array);
/** Converting constructor. Implicitly converts the specified matrix to an Array2D. */
Array2D(const VnlMatrixType & matrix);
/** Copy-assignment operator. */
Self &
operator=(const Self & array);
/** Assigns the specified matrix to an Array2D. */
Self &
operator=(const VnlMatrixType & matrix);
void
Fill(TValue const & v)
{
this->fill(v);
}
/** Get one element */
const TValue &
GetElement(SizeValueType row, SizeValueType col) const
{
return this->operator()(static_cast<unsigned int>(row), static_cast<unsigned int>(col));
}
/** Set one element */
void
SetElement(SizeValueType row, SizeValueType col, const TValue & value)
{
this->operator()(static_cast<unsigned int>(row), static_cast<unsigned int>(col)) = value;
}
/** Destructively set the size to that given. Will lose data. */
void
SetSize(unsigned int m, unsigned int n);
/** Destructor. */
~Array2D() override = default;
};
template <typename TValue>
std::ostream &
operator<<(std::ostream & os, const Array2D<TValue> & arr)
{
const unsigned int numberOfRows = arr.rows();
const unsigned int numberOfColumns = arr.cols();
for (unsigned int r = 0; r < numberOfRows; ++r)
{
os << '[';
if (numberOfColumns >= 1)
{
const unsigned int lastColumn = numberOfColumns - 1;
for (unsigned int c = 0; c < lastColumn; ++c)
{
os << arr(r, c) << ", ";
}
os << arr(r, lastColumn);
}
os << ']' << std::endl;
}
return os;
}
// declaration of specialization
template <>
ITKCommon_EXPORT std::ostream &
operator<<(std::ostream & os, const Array2D<float> & arr);
template <>
ITKCommon_EXPORT std::ostream &
operator<<(std::ostream & os, const Array2D<double> & arr);
} // namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkArray2D.hxx"
#endif
#endif
|
