Zivid C++ API 2.9.0+4dbba385-1
Defining the Future of 3D Machine Vision
InfieldCorrection.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#include "Zivid/Camera.h"
94#include "Zivid/Detail/Pimpl.h"
96#include "Zivid/Point.h"
97
98#include <chrono>
99#include <iosfwd>
100#include <string>
101#include <vector>
102
103namespace Zivid
104{
105 namespace Experimental
106 {
107 namespace Calibration
108 {
119
127
145
156 {
157 public:
165
168
171
174
177 ZIVID_CORE_EXPORT explicit operator bool() const;
178
182
184 ZIVID_CORE_EXPORT std::string toString() const;
185
186 private:
187 Zivid::Calibration::DetectionResult m_detectionResult;
189 };
190
192 ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const InfieldCorrectionInput &input);
193
203 {
204 ZIVID_PIMPL_VALUE_SEMANTICS(CameraVerification, ZIVID_CORE_EXPORT);
205
206 public:
218
222
225 ZIVID_CORE_EXPORT std::string toString() const;
226 };
227
230 std::ostream &stream,
231 const CameraVerification &cameraVerification);
232
235 {
236 ZIVID_PIMPL_VALUE_SEMANTICS(AccuracyEstimate, ZIVID_CORE_EXPORT);
237
238 public:
255
258 ZIVID_CORE_EXPORT float zMin() const;
259
262 ZIVID_CORE_EXPORT float zMax() const;
263
266 ZIVID_CORE_EXPORT std::string toString() const;
267 };
268
270 ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const AccuracyEstimate &accuracyEstimate);
271
274 {
275 ZIVID_PIMPL_VALUE_SEMANTICS(CameraCorrection, ZIVID_CORE_EXPORT);
276
277 public:
285
288 ZIVID_CORE_EXPORT std::string toString() const;
289 };
290
292 ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const CameraCorrection &cameraCorrection);
293
307
330 computeCameraCorrection(const std::vector<InfieldCorrectionInput> &dataset);
331
343 Zivid::Camera &camera,
344 const CameraCorrection &cameraCorrection);
345
349
358
366 ZIVID_CORE_EXPORT std::chrono::time_point<std::chrono::system_clock> cameraCorrectionTimestamp(
367 const Zivid::Camera &camera);
368
369 } // namespace Calibration
370 } // namespace Experimental
371} // namespace Zivid
#define ZIVID_CORE_EXPORT
Definition: CoreExport.h:101
A result returned by the detectFeaturePoints(...) call
Definition: DetectionResult.h:106
Interface to one Zivid camera
Definition: Camera.h:113
A dimension accuracy estimate for a specific working volume
Definition: InfieldCorrection.h:235
ZIVID_CORE_EXPORT float zMax() const
The range of validity of the accuracy estimate (upper end)
ZIVID_CORE_EXPORT float zMin() const
The range of validity of the accuracy estimate (lower end)
ZIVID_CORE_EXPORT float dimensionAccuracy() const
The estimated dimension accuracy obtained if the correction is applied
ZIVID_CORE_EXPORT std::string toString() const
Get string representation of the accuracy estimate
An in-field correction that may be written to a camera
Definition: InfieldCorrection.h:274
ZIVID_CORE_EXPORT std::string toString() const
Get string representation of the camera correction
ZIVID_CORE_EXPORT AccuracyEstimate accuracyEstimate() const
Get an estimate for expected dimension accuracy if the correction is applied to the camera
An assessment of the current dimension trueness of a camera at a specific location
Definition: InfieldCorrection.h:203
ZIVID_CORE_EXPORT Zivid::PointXYZ position() const
Get the location at which the measurement was made
ZIVID_CORE_EXPORT std::string toString() const
Get string representation of the camera assessment
ZIVID_CORE_EXPORT float localDimensionTrueness() const
Get the estimated local dimension trueness
Container for input-data needed by in-field verification and correction functions
Definition: InfieldCorrection.h:156
ZIVID_CORE_EXPORT InfieldCorrectionInput(const Zivid::Calibration::DetectionResult &detectionResult)
Constructs an InfieldCorrectionInput instance
ZIVID_CORE_EXPORT const Zivid::Calibration::DetectionResult & detectionResult() const
Get the stored feature-point detection result
ZIVID_CORE_EXPORT InfieldCorrectionDetectionStatus status() const
Get detection status/validity as an enum
ZIVID_CORE_EXPORT std::string statusDescription() const
Get human-readable description of the status. Useful for feedback if valid() is false.
ZIVID_CORE_EXPORT bool valid() const
Check if the data is valid for use with in-field verification and correction
ZIVID_CORE_EXPORT std::string toString() const
Get string representation of the in-field correction input
A frame captured by a Zivid camera
Definition: Frame.h:115
ZIVID_CORE_EXPORT std::chrono::time_point< std::chrono::system_clock > cameraCorrectionTimestamp(const Zivid::Camera &camera)
Get the time at which the camera's in-field correction was created
ZIVID_CORE_EXPORT Zivid::Calibration::DetectionResult detectFeaturePoints(Zivid::Camera &camera)
Detects feature points from a calibration object
ZIVID_CORE_EXPORT Zivid::Frame captureCalibrationBoard(Zivid::Camera &camera)
Capture the calibration board
ZIVID_CORE_EXPORT CameraVerification verifyCamera(const InfieldCorrectionInput &input)
Verify the current camera trueness based on a single measurement
ZIVID_CORE_EXPORT std::ostream & operator<<(std::ostream &stream, const InfieldCorrectionInput &input)
Serialize the value to a stream
ZIVID_CORE_EXPORT void resetCameraCorrection(Zivid::Camera &camera)
Reset the in-field correction on a camera to factory settings
InfieldCorrectionDetectionStatus
Definition: InfieldCorrectionDetectionStatus.h:103
ZIVID_CORE_EXPORT CameraCorrection computeCameraCorrection(const std::vector< InfieldCorrectionInput > &dataset)
Calculate new in-field camera correction
ZIVID_CORE_EXPORT void writeCameraCorrection(Zivid::Camera &camera, const CameraCorrection &cameraCorrection)
Write the in-field correction on a camera
ZIVID_CORE_EXPORT bool hasCameraCorrection(const Zivid::Camera &camera)
Check if the camera has an in-field correction written to it
The main Zivid namespace. All Zivid code is found here
Definition: Application.h:99
Point with three coordinates as float
Definition: Point.h:105