Zivid C++ API  2.3.1+1a22cbf1-1
Defining the Future of 3D Machine Vision
MultiCamera.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-2022 (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 Customer Success Team <customersuccess@zivid.com>
42  * Info: http://www.zivid.com
43  ******************************************************************************/
44 
45 #pragma once
46 
49 #include "Zivid/Matrix.h"
50 
51 #include <vector>
52 
53 namespace Zivid
54 {
55  namespace Calibration
56  {
61  {
62  public:
66 
70 
73  ZIVID_CORE_EXPORT std::string toString() const;
74 
75  private:
76  float m_translation;
77  };
78 
80  ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const MultiCameraResidual &residual);
81 
86  {
87  public:
91  ZIVID_CORE_EXPORT MultiCameraOutput(const std::vector<Matrix4x4> &transforms,
92  const std::vector<MultiCameraResidual> &residuals);
93 
96  ZIVID_CORE_EXPORT bool valid() const;
97 
100  ZIVID_CORE_EXPORT explicit operator bool() const;
101 
104  ZIVID_CORE_EXPORT const std::vector<Matrix4x4> &transforms() const;
105 
118  ZIVID_CORE_EXPORT const std::vector<MultiCameraResidual> &residuals() const;
119 
122  ZIVID_CORE_EXPORT std::string toString() const;
123 
124  private:
125  std::vector<Matrix4x4> m_transforms;
126  std::vector<MultiCameraResidual> m_residuals;
127  };
128 
130  ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const MultiCameraOutput &multiCameraOutput);
131 
150  ZIVID_CORE_EXPORT MultiCameraOutput calibrateMultiCamera(const std::vector<DetectionResult> &detectionResults);
151  } // namespace Calibration
152 } // namespace Zivid
#define ZIVID_CORE_EXPORT
Definition: CoreExport.h:57
The results from a multi-camera calibration process
Definition: MultiCamera.h:86
ZIVID_CORE_EXPORT bool valid() const
Test if MultiCameraOutput is valid.
ZIVID_CORE_EXPORT const std::vector< Matrix4x4 > & transforms() const
Multi-camera calibration transforms.
ZIVID_CORE_EXPORT std::string toString() const
Get string representation of the multi-camera calibration output
ZIVID_CORE_EXPORT const std::vector< MultiCameraResidual > & residuals() const
Multi-camera calibration residuals.
ZIVID_CORE_EXPORT MultiCameraOutput(const std::vector< Matrix4x4 > &transforms, const std::vector< MultiCameraResidual > &residuals)
Constructs a MultiCameraOutput instance.
Representation of the estimated errors of a multi-camera calibration
Definition: MultiCamera.h:61
ZIVID_CORE_EXPORT float translation() const
Get the average overlap error
ZIVID_CORE_EXPORT MultiCameraResidual(float translation)
Constructs a multi-camera residual instance.
ZIVID_CORE_EXPORT std::string toString() const
Get string representation of the multi-camera residual
ZIVID_CORE_EXPORT MultiCameraOutput calibrateMultiCamera(const std::vector< DetectionResult > &detectionResults)
Performs multi-camera calibration.
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:55