Zivid C++ API 2.9.0+4dbba385-1
Defining the Future of 3D Machine Vision
Frame.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
91#include "Zivid/CameraInfo.h"
92#include "Zivid/CameraState.h"
94#include "Zivid/Detail/Pimpl.h"
95#include "Zivid/FrameInfo.h"
96#include "Zivid/PointCloud.h"
97#include "Zivid/Settings.h"
98
99#include <memory>
100
101namespace Zivid
102{
114 class Frame
115 {
116 ZIVID_PIMPL_REFERENCE_SEMANTICS(Frame, ZIVID_CORE_EXPORT);
117
118 public:
121
123 ZIVID_CORE_EXPORT explicit Frame(const std::string &fileName);
124
131
137
143
149
155
162 ZIVID_CORE_EXPORT void save(const std::string &fileName) const;
163
165 ZIVID_CORE_EXPORT void load(const std::string &fileName);
166
172 ZIVID_CORE_EXPORT std::string toString() const;
173 };
174} // namespace Zivid
#define ZIVID_CORE_EXPORT
Definition: CoreExport.h:101
Information about camera model, serial number etc.
Definition: CameraInfo.h:123
Information about camera connection state, temperatures, etc.
Definition: CameraState.h:123
Various information for a frame
Definition: FrameInfo.h:123
A frame captured by a Zivid camera
Definition: Frame.h:115
ZIVID_CORE_EXPORT Frame(const std::string &fileName)
Creates a frame by loading data from a file
ZIVID_CORE_EXPORT FrameInfo info() const
Get information collected at the time of the frame capture
ZIVID_CORE_EXPORT PointCloud pointCloud() const
Get the point cloud
ZIVID_CORE_EXPORT std::string toString() const
Get string representation of the frame
ZIVID_CORE_EXPORT Settings settings() const
Get the settings used to capture this frame
ZIVID_CORE_EXPORT void save(const std::string &fileName) const
Save the frame to file
ZIVID_CORE_EXPORT CameraState state() const
Get the camera state data at the time of the frame capture
ZIVID_CORE_EXPORT Frame()
Construct a new frame
ZIVID_CORE_EXPORT void load(const std::string &fileName)
Load a frame from a Zivid data file
ZIVID_CORE_EXPORT CameraInfo cameraInfo() const
Get information about the camera used to capture the frame
Point cloud with x, y, z, RGB color and SNR laid out on a 2D grid
Definition: PointCloud.h:115
Settings used when capturing with a Zivid camera
Definition: Settings.h:124
The main Zivid namespace. All Zivid code is found here
Definition: Application.h:99