Zivid C++ API  1.8.1+6967bc1b-1
Defining the Future of 3D Machine Vision
Detector.h
Go to the documentation of this file.
1 
2 /*******************************************************************************
3  * This file is part of the Zivid 3D Camera API
4  *
5  * Copyright 2015-2020 (C) Zivid AS
6  * All rights reserved.
7  *
8  * Zivid Software License, v1.0
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright notice,
14  * this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright notice,
17  * this list of conditions and the following disclaimer in the documentation
18  * and/or other materials provided with the distribution.
19  *
20  * 3. Neither the name of Zivid AS nor the names of its contributors may be used
21  * to endorse or promote products derived from this software without specific
22  * prior written permission.
23  *
24  * 4. This software, with or without modification, must not be used with any
25  * other 3D camera than from Zivid AS.
26  *
27  * 5. Any software provided in binary form under this license must not be
28  * reverse engineered, decompiled, modified and/or disassembled.
29  *
30  * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
31  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
32  * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
33  * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
34  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
35  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
36  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
37  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
39  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40  *
41  * Contact: Zivid Support <support@zivid.com>
42  * Info: http://www.zivid.com
43  ******************************************************************************/
44 
45 #pragma once
46 
47 #include "Zivid/APIExport.h"
48 #include "Zivid/Pimpl.h"
49 
50 #include <ostream>
51 
52 namespace Zivid
53 {
54  class PointCloud;
55 
56  namespace HandEye
57  {
61  class DetectionResult
62  {
63  ZIVID_PIMPL_VALUE_SEMANTICS(DetectionResult, ZIVID_API_EXPORT);
64 
65  public:
71  ZIVID_API_EXPORT bool valid() const;
72 
78  ZIVID_API_EXPORT explicit operator bool() const;
79 
82  ZIVID_API_EXPORT std::string toString() const;
83  };
84 
91  ZIVID_API_EXPORT DetectionResult detectFeaturePoints(const PointCloud &cloud);
92 
94  ZIVID_API_EXPORT std::ostream &operator<<(std::ostream &stream, const DetectionResult &result);
95  } // namespace HandEye
96 } // namespace Zivid
Zivid::HandEye::DetectionResult::valid
ZIVID_API_EXPORT bool valid() const
Test if DetectionResult is valid.
Zivid::HandEye::DetectionResult::toString
ZIVID_API_EXPORT std::string toString() const
Get string representation of DetectionResult
APIExport.h
Pimpl.h
Zivid
The main Zivid namespace. All Zivid code is found here
Definition: Application.h:52
ZIVID_API_EXPORT
#define ZIVID_API_EXPORT
Definition: APIExport.h:56
Zivid::HandEye::detectFeaturePoints
ZIVID_API_EXPORT DetectionResult detectFeaturePoints(const PointCloud &cloud)
Detects feature points from a calibration object in a point cloud.
Zivid::HandEye::operator<<
ZIVID_API_EXPORT std::ostream & operator<<(std::ostream &stream, const CalibrationResidual &calibrationResidual)
Serialize the value to a stream