Zivid C++ API 2.9.0+4dbba385-1
Defining the Future of 3D Machine Vision
Array2D.h
Go to the documentation of this file.
1
2
3/*******************************************************************************
4
5 * This file is part of the Zivid 3D Camera API
6
7 *
8
9 * Copyright 2015-2023 (C) Zivid AS
10
11 * All rights reserved.
12
13 *
14
15 * Zivid Software License, v1.0
16
17 *
18
19 * Redistribution and use in source and binary forms, with or without
20
21 * modification, are permitted provided that the following conditions are met:
22
23 *
24
25 * 1. Redistributions of source code must retain the above copyright notice,
26
27 * this list of conditions and the following disclaimer.
28
29 *
30
31 * 2. Redistributions in binary form must reproduce the above copyright notice,
32
33 * this list of conditions and the following disclaimer in the documentation
34
35 * and/or other materials provided with the distribution.
36
37 *
38
39 * 3. Neither the name of Zivid AS nor the names of its contributors may be used
40
41 * to endorse or promote products derived from this software without specific
42
43 * prior written permission.
44
45 *
46
47 * 4. This software, with or without modification, must not be used with any
48
49 * other 3D camera than from Zivid AS.
50
51 *
52
53 * 5. Any software provided in binary form under this license must not be
54
55 * reverse engineered, decompiled, modified and/or disassembled.
56
57 *
58
59 * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
60
61 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
62
63 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
64
65 * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
66
67 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
68
69 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
70
71 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
72
73 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
74
75 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
76
77 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
78
79 *
80
81 * Contact: Zivid Customer Success Team <customersuccess@zivid.com>
82
83 * Info: http://www.zivid.com
84
85 ******************************************************************************/
86
87
88
89#pragma once
90
92
93#include <memory>
94#include <string>
95#include <type_traits>
96
97namespace Zivid
98{
99#ifndef NO_DOC
101 namespace Detail
102 {
103 ZIVID_CORE_EXPORT std::string array2DToString(std::size_t width, std::size_t height);
104 } // namespace Detail
105#endif
106
117 template<typename DataFormat>
119 {
120 public:
122 using ValueType = DataFormat;
123
127 using ConstIterator = const DataFormat *;
128
131 : m_width{ 0 }
132 , m_height{ 0 }
133 {}
134
136 size_t width() const
137 {
138 return m_width;
139 }
140
142 size_t height() const
143 {
144 return m_height;
145 }
146
149 size_t size() const
150 {
151 return width() * height();
152 }
153
155 bool isEmpty() const
156 {
157 return size() == 0;
158 }
159
162 const DataFormat *data() const
163 {
164 return m_data.get();
165 }
166
174 const DataFormat &operator()(size_t idx) const
175 {
176 return *(data() + idx);
177 }
178
187 const DataFormat &operator()(size_t i, size_t j) const
188 {
189 return operator()(width() * i + j);
190 }
191
194 {
195 return data();
196 }
197
200 {
201 return data() + size();
202 }
203
206 {
207 return data();
208 }
209
212 {
213 return data() + size();
214 }
215
217 std::string toString() const
218 {
219 return Detail::array2DToString(width(), height());
220 }
221
222 private:
223 friend class Array2DFactory;
224
225 Array2D(std::size_t width, std::size_t height, std::unique_ptr<DataFormat[]> data)
226 : m_width{ width }
227 , m_height{ height }
228 , m_data{ // Due to poor support for shared_ptr array types in C++11 the data
229 // ownership is transferred from the std::unique_ptr to a std::shared_ptr
230 // of non-array type with a specified array deleter.
231 data.release(),
232 std::default_delete<DataFormat[]>()
233 }
234 {}
235
236 std::size_t m_width;
237 std::size_t m_height;
238 std::shared_ptr<DataFormat> m_data;
239 };
240
242 template<typename T>
243 std::ostream &operator<<(std::ostream &stream, const Array2D<T> &array)
244 {
245 return stream << array.toString();
246 }
247} // namespace Zivid
#define ZIVID_CORE_EXPORT
Definition: CoreExport.h:101
Two-dimensional container of data
Definition: Array2D.h:119
ConstIterator cbegin() const
Iterator to the beginning of the array
Definition: Array2D.h:205
const DataFormat * ConstIterator
The iterator type for immutable access. It iterates over individual Array2D elements in row major ord...
Definition: Array2D.h:127
friend class Array2DFactory
Definition: Array2D.h:223
const DataFormat & operator()(size_t i, size_t j) const
Constant reference to an element given by row and column
Definition: Array2D.h:187
ConstIterator cend() const
Iterator to the end of the array
Definition: Array2D.h:211
const DataFormat & operator()(size_t idx) const
Constant reference to an element given by a 1D linear index
Definition: Array2D.h:174
size_t height() const
Get the height of the array (number of rows)
Definition: Array2D.h:142
const DataFormat * data() const
Pointer to the first data element of the array
Definition: Array2D.h:162
bool isEmpty() const
Check if the array is empty
Definition: Array2D.h:155
std::string toString() const
Get array information as string
Definition: Array2D.h:217
ConstIterator end() const
Iterator to the end of the array
Definition: Array2D.h:199
DataFormat ValueType
The type of the elements stored in the Array2D
Definition: Array2D.h:122
size_t size() const
Get the number of elements in the array
Definition: Array2D.h:149
size_t width() const
Get the width of the array (number of columns)
Definition: Array2D.h:136
ConstIterator begin() const
Iterator to the beginning of the array
Definition: Array2D.h:193
Array2D()
Create an empty Array2D
Definition: Array2D.h:130
The main Zivid namespace. All Zivid code is found here
Definition: Application.h:99
std::ostream & operator<<(std::ostream &stream, const Array2D< T > &array)
Serialize array information to a stream
Definition: Array2D.h:243