Zivid C++ API 2.16.0+46cdaba6-1
PointCloudRegistration.h
Go to the documentation of this file.
1/*******************************************************************************
2 * This file is part of the Zivid API
3 *
4 * Copyright 2015-2025 (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
48#include <Zivid/Detail/Pimpl.h>
50#include <Zivid/Matrix.h>
52
53#include <iosfwd>
54#include <string>
55
56namespace Zivid
57{
58 namespace Experimental
59 {
60 namespace Toolbox
61 {
63
68 {
70
71 public:
74
77
80
83
85 ZIVID_CORE_EXPORT std::string toString() const;
86 };
87
90 std::ostream &stream,
92
122 const UnorganizedPointCloud &target,
123 const UnorganizedPointCloud &source,
125 const Pose &initialTransform = Pose{ Matrix4x4::identity() });
126 } // namespace Toolbox
127 } // namespace Experimental
128} // namespace Zivid
#define ZIVID_CORE_EXPORT
Definition CoreExport.h:56
#define ZIVID_PIMPL_VALUE_SEMANTICS(ClassName, Attributes)
Definition Pimpl.h:53
Describes a rigid transform (rotation+translation), such as a robot pose.
Definition Pose.h:57
Input parameters for controlling the local point cloud registration process.
Definition LocalPointCloudRegistrationParameters.h:81
The result of a call to localPointCloudRegistration()
Definition PointCloudRegistration.h:68
ZIVID_CORE_EXPORT float rootMeanSquareError() const
The root mean squared distance between corresponding points in the source and target point cloud afte...
ZIVID_CORE_EXPORT bool converged() const
A boolean indicating whether the convergence criteria were satisfied before reaching the iteration li...
ZIVID_CORE_EXPORT std::string toString() const
Get string representation of the result.
ZIVID_CORE_EXPORT Pose transform() const
The transform that must be applied to the source point cloud for it to align with the target point cl...
ZIVID_CORE_EXPORT float sourceCoverage() const
The fraction of points in the source point cloud that has a correspondence in the target point cloud ...
static Matrix identity()
Definition Matrix.h:165
Point cloud with x, y, z, RGB color and SNR laid out as a linear list of only valid points.
Definition UnorganizedPointCloud.h:72
ZIVID_CORE_EXPORT std::ostream & operator<<(std::ostream &stream, const LocalPointCloudRegistrationResult &result)
Serialize the value to a stream.
ZIVID_CORE_EXPORT LocalPointCloudRegistrationResult localPointCloudRegistration(const UnorganizedPointCloud &target, const UnorganizedPointCloud &source, const LocalPointCloudRegistrationParameters &params, const Pose &initialTransform=Pose{ Matrix4x4::identity() })
Compute alignment transform between two point clouds.
The main Zivid namespace. All Zivid code is found here.
Definition Application.h:84