Zivid C++ API 2.9.0+4dbba385-1
Defining the Future of 3D Machine Vision
DetectionResult.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
93#include "Zivid/Detail/Pimpl.h"
94#include "Zivid/Point.h"
95
96#include <ostream>
97
98namespace Zivid
99{
100 namespace Calibration
101 {
106 {
107 ZIVID_PIMPL_VALUE_SEMANTICS(DetectionResult, ZIVID_CORE_EXPORT);
108
109 public:
116
122 ZIVID_CORE_EXPORT explicit operator bool() const;
123
130
141
144 ZIVID_CORE_EXPORT std::string toString() const;
145 };
146
148 ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const DetectionResult &result);
149 } // namespace Calibration
150} // namespace Zivid
#define ZIVID_CORE_EXPORT
Definition: CoreExport.h:101
A result returned by the detectFeaturePoints(...) call
Definition: DetectionResult.h:106
ZIVID_CORE_EXPORT PointXYZ centroid() const
Get the centroid of the detected feature points in camera-space.
ZIVID_CORE_EXPORT Pose pose() const
Get position and orientation of the top left detected corner in camera coordinate system.
ZIVID_CORE_EXPORT std::string toString() const
Get string representation of DetectionResult
ZIVID_CORE_EXPORT bool valid() const
Test if DetectionResult is valid.
Describes a robot pose
Definition: Pose.h:103
ZIVID_CORE_EXPORT std::ostream & operator<<(std::ostream &stream, const DetectionResult &result)
Serialize the value to a stream
The main Zivid namespace. All Zivid code is found here
Definition: Application.h:99
Point with three coordinates as float
Definition: Point.h:105