Zivid C++ API 2.13.1+18e79e79-1
Frame.h
Go to the documentation of this file.
1/*******************************************************************************
2 * This file is part of the Zivid API
3 *
4 * Copyright 2015-2024 (C) Zivid AS
5 * All rights reserved.
6 *
7 * Zivid Software License, v1.0
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are met:
11 *
12 * 1. Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * 2. Redistributions in binary form must reproduce the above copyright notice,
16 * this list of conditions and the following disclaimer in the documentation
17 * and/or other materials provided with the distribution.
18 *
19 * 3. Neither the name of Zivid AS nor the names of its contributors may be used
20 * to endorse or promote products derived from this software without specific
21 * prior written permission.
22 *
23 * 4. This software, with or without modification, must not be used with any
24 * other 3D camera than from Zivid AS.
25 *
26 * 5. Any software provided in binary form under this license must not be
27 * reverse engineered, decompiled, modified and/or disassembled.
28 *
29 * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
30 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
31 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
32 * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
33 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
35 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
36 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
38 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Contact: Zivid Customer Success Team <customersuccess@zivid.com>
41 * Info: http://www.zivid.com
42 ******************************************************************************/
43
44#pragma once
45
46#include "Zivid/CameraInfo.h"
47#include "Zivid/CameraState.h"
49#include "Zivid/Detail/Pimpl.h"
50#include "Zivid/FrameInfo.h"
51#include "Zivid/PointCloud.h"
52#include "Zivid/Settings.h"
53
54#include <memory>
55
56namespace Zivid
57{
69 class Frame
70 {
72
73 public:
76
78 ZIVID_CORE_EXPORT explicit Frame(const std::string &fileName);
79
86
92
98
104
110
117 ZIVID_CORE_EXPORT void save(const std::string &fileName) const;
118
120 ZIVID_CORE_EXPORT void load(const std::string &fileName);
121
127 ZIVID_CORE_EXPORT std::string toString() const;
128
140 };
141} // namespace Zivid
#define ZIVID_CORE_EXPORT
Definition CoreExport.h:56
#define ZIVID_PIMPL_REFERENCE_SEMANTICS(ClassName, Attributes)
Definition Pimpl.h:139
Information about camera model, serial number etc.
Definition CameraInfo.h:79
Information about camera connection state, temperatures, etc.
Definition CameraState.h:79
Various information for a frame.
Definition FrameInfo.h:79
A frame captured by a Zivid camera.
Definition Frame.h:70
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.
ZIVID_CORE_EXPORT Frame clone() const
Returns a clone of the frame. The clone will include a copy of all of the point cloud data on the com...
Point cloud with x, y, z, RGB color and SNR laid out on a 2D grid.
Definition PointCloud.h:70
Settings used when capturing with a Zivid camera.
Definition Settings.h:80
The main Zivid namespace. All Zivid code is found here.
Definition Application.h:56