Zivid C++ API 2.16.0+46cdaba6-1
PointCloud.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
46#include "Zivid/Array2D.h"
48#include "Zivid/Image.h"
49#include "Zivid/Matrix.h"
50#include "Zivid/Normal.h"
51#include "Zivid/Point.h"
53#include "Zivid/SNR.h"
55
56#include <iosfwd>
57#include <memory>
58#include <string>
59
60namespace Zivid
61{
62 class Frame;
63
82 {
83 public:
90 enum class Downsampling
91 {
92 by2x2,
93 by3x3,
94 by4x4,
95 };
96
99
101 ZIVID_CORE_EXPORT size_t width() const;
102
104 ZIVID_CORE_EXPORT size_t height() const;
105
108 ZIVID_CORE_EXPORT size_t size() const;
109
112
128
148
160
177
194
215
233
251
268
281
303
322
340
347
361
375
390
404
418
430 template<typename DataFormat>
432 {
433 static_assert(
434 HasCopyDataImplReturnArray2DTag<DataFormat>::value,
435 "The provided DataFormat is unsupported. Please refer to the documentation for "
436 "this method for the supported DataFormats.");
437 return copyDataImpl(ReturnArray2DTag<DataFormat>{});
438 }
439
526 template<typename DataFormat>
527 void copyData(DataFormat *destination) const
528 {
529 static_assert(
530 HasCopyDataImpl<DataFormat *>::value,
531 "The provided DataFormat is unsupported. Please refer to the documentation for "
532 "this method for the supported data formats.");
533 return copyDataImpl(destination);
534 }
535
538 ZIVID_CORE_EXPORT std::string toString() const;
539
545
553
565
596
605
617
634
635#ifndef NO_DOC
636 ZIVID_CORE_EXPORT class PointCloudImpl &getImpl();
637 ZIVID_CORE_EXPORT const class PointCloudImpl &getImpl() const;
638 ZIVID_CORE_EXPORT explicit PointCloud(std::shared_ptr<class PointCloudImpl> other);
639#endif
640
641 private:
642 template<class T>
643 struct ReturnArray2DTag
644 {};
645
646 template<typename... Args>
647 class HasCopyDataImplReturnArray2DTag
648 {
649 template<
650 typename C,
651 typename = decltype(std::declval<C>().copyDataImpl(std::declval<ReturnArray2DTag<Args>>()...))>
652 static std::true_type test(int);
653 template<typename C>
654 static std::false_type test(...);
655
656 public:
657 static constexpr bool value = decltype(test<PointCloud>(0))::value;
658 };
659
660 template<typename... Args>
661 class HasCopyDataImpl
662 {
663 template<typename C, typename = decltype(std::declval<C>().copyDataImpl(std::declval<Args>()...))>
664 static std::true_type test(int);
665 template<typename C>
666 static std::false_type test(...);
667
668 public:
669 static constexpr bool value = decltype(test<PointCloud>(0))::value;
670 };
671
672 ZIVID_CORE_EXPORT Array2D<PointXYZ> copyDataImpl(ReturnArray2DTag<PointXYZ> /*tag*/) const;
673 ZIVID_CORE_EXPORT Array2D<PointXYZW> copyDataImpl(ReturnArray2DTag<PointXYZW> /*tag*/) const;
674 ZIVID_CORE_EXPORT Array2D<PointZ> copyDataImpl(ReturnArray2DTag<PointZ> /*tag*/) const;
675 ZIVID_CORE_EXPORT Array2D<ColorRGBA> copyDataImpl(ReturnArray2DTag<ColorRGBA> /*tag*/) const;
676 ZIVID_CORE_EXPORT Array2D<ColorBGRA> copyDataImpl(ReturnArray2DTag<ColorBGRA> /*tag*/) const;
677 ZIVID_CORE_EXPORT Array2D<ColorRGBA_SRGB> copyDataImpl(ReturnArray2DTag<ColorRGBA_SRGB> /*tag*/) const;
678 ZIVID_CORE_EXPORT Array2D<ColorBGRA_SRGB> copyDataImpl(ReturnArray2DTag<ColorBGRA_SRGB> /*tag*/) const;
679 ZIVID_CORE_EXPORT Array2D<PointXYZColorRGBA> copyDataImpl(ReturnArray2DTag<PointXYZColorRGBA> /*tag*/) const;
680 ZIVID_CORE_EXPORT Array2D<PointXYZColorRGBA_SRGB> copyDataImpl(
681 ReturnArray2DTag<PointXYZColorRGBA_SRGB> /*tag*/) const;
682 ZIVID_CORE_EXPORT Array2D<PointXYZColorBGRA> copyDataImpl(ReturnArray2DTag<PointXYZColorBGRA> /*tag*/) const;
683 ZIVID_CORE_EXPORT Array2D<PointXYZColorBGRA_SRGB> copyDataImpl(
684 ReturnArray2DTag<PointXYZColorBGRA_SRGB> /*tag*/) const;
685 ZIVID_CORE_EXPORT Array2D<SNR> copyDataImpl(ReturnArray2DTag<SNR> /*tag*/) const;
686 ZIVID_CORE_EXPORT Array2D<NormalXYZ> copyDataImpl(ReturnArray2DTag<NormalXYZ> /*tag*/) const;
687 ZIVID_CORE_EXPORT void copyDataImpl(PointXYZ *destination) const;
688 ZIVID_CORE_EXPORT void copyDataImpl(PointXYZW *destination) const;
689 ZIVID_CORE_EXPORT void copyDataImpl(PointZ *destination) const;
690 ZIVID_CORE_EXPORT void copyDataImpl(ColorRGBA *destination) const;
691 ZIVID_CORE_EXPORT void copyDataImpl(struct ColorRGBAf *destination) const;
692 ZIVID_CORE_EXPORT void copyDataImpl(ColorBGRA *destination) const;
693 ZIVID_CORE_EXPORT void copyDataImpl(ColorRGBA_SRGB *destination) const;
694 ZIVID_CORE_EXPORT void copyDataImpl(ColorBGRA_SRGB *destination) const;
695 ZIVID_CORE_EXPORT void copyDataImpl(PointXYZColorRGBA *destination) const;
696 ZIVID_CORE_EXPORT void copyDataImpl(PointXYZColorRGBA_SRGB *destination) const;
697 ZIVID_CORE_EXPORT void copyDataImpl(PointXYZColorBGRA *destination) const;
698 ZIVID_CORE_EXPORT void copyDataImpl(PointXYZColorBGRA_SRGB *destination) const;
699 ZIVID_CORE_EXPORT void copyDataImpl(SNR *destination) const;
700 ZIVID_CORE_EXPORT void copyDataImpl(NormalXYZ *destination) const;
701
702 std::shared_ptr<class PointCloudImpl> m_impl;
703 };
704
706 ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const PointCloud &pointCloud);
707
708#ifndef NO_DOC
710 namespace Detail
711 {
712 ZIVID_CORE_EXPORT void waitUntilProcessingIsComplete(const PointCloud &pointCloud);
713 } // namespace Detail
714#endif
715
716} // namespace Zivid
#define ZIVID_CORE_EXPORT
Definition CoreExport.h:56
Two-dimensional container of data.
Definition Array2D.h:83
A 2-dimensional image.
Definition Image.h:89
Point cloud with x, y, z, RGB color and SNR laid out on a 2D grid.
Definition PointCloud.h:82
ZIVID_CORE_EXPORT Image< ColorBGRA_SRGB > copyImageBGRA_SRGB() const
Get point cloud colors as 8-bit BGRA image in the sRGB color space.
ZIVID_CORE_EXPORT Array2D< PointXYZW > copyPointsXYZW() const
Array2D of point coordinates in 4D.
ZIVID_CORE_EXPORT Array2D< PointXYZColorRGBA_SRGB > copyPointsXYZColorsRGBA_SRGB() const
Array2D of PointXYZColorRGBA_SRGB.
ZIVID_CORE_EXPORT PointCloud clone() const
Returns a clone of the point cloud. The clone will include a copy of all of the point cloud data on t...
ZIVID_CORE_EXPORT PointCloud & downsample(Downsampling downsampling)
Downsample the point cloud in-place.
ZIVID_CORE_EXPORT PointCloud transformed(const Zivid::Matrix4x4 &matrix) const
Transform the point cloud by the given 4x4 transformation matrix.
ZIVID_CORE_EXPORT Image< ColorRGBA > copyImageRGBA() const
Get point cloud colors as 8-bit RGBA image.
void copyData(DataFormat *destination) const
Copy data in the specified DataFormat to a destination buffer.
Definition PointCloud.h:527
ZIVID_CORE_EXPORT Array2D< SNR > copySNRs() const
Array2D of SNR values.
ZIVID_CORE_EXPORT PointCloud & transform(const Zivid::Matrix4x4 &matrix)
Transform the point cloud in-place by the given 4x4 transformation matrix.
Downsampling
Option for downsampling.
Definition PointCloud.h:91
ZIVID_CORE_EXPORT Array2D< ColorRGBA > copyColorsRGBA() const
Array2D of point colors in 8-bit RGBA format.
ZIVID_CORE_EXPORT size_t size() const
Get the size of the point cloud (total number of points)
ZIVID_CORE_EXPORT Array2D< ColorBGRA_SRGB > copyColorsBGRA_SRGB() const
Array2D of point colors in 8-bit BGRA format in the sRGB color space.
ZIVID_CORE_EXPORT Array2D< PointXYZColorRGBA > copyPointsXYZColorsRGBA() const
Array2D of PointXYZColorRGBA.
ZIVID_CORE_EXPORT Array2D< ColorRGBA_SRGB > copyColorsSRGB() const
Array2D of point colors in 8-bit RGBA format in the sRGB color space.
ZIVID_CORE_EXPORT Image< ColorRGBA_SRGB > copyImageRGBA_SRGB() const
Get point cloud colors as 8-bit RGBA image in the sRGB color space.
ZIVID_CORE_EXPORT std::string toString() const
Get string representation of the point cloud.
Array2D< DataFormat > copyData() const
Array2D with point cloud data using specified DataFormat.
Definition PointCloud.h:431
ZIVID_CORE_EXPORT PointCloud()
Create an empty point cloud.
ZIVID_CORE_EXPORT Array2D< NormalXYZ > copyNormalsXYZ() const
Array2D of NormalXYZ.
ZIVID_CORE_EXPORT Array2D< ColorRGBA_SRGB > copyColorsRGBA_SRGB() const
Array2D of point colors in 8-bit RGBA format in the sRGB color space.
ZIVID_CORE_EXPORT size_t width() const
Get the width of the point cloud (number of columns)
ZIVID_CORE_EXPORT Array2D< PointXYZ > copyPointsXYZ() const
Array2D of point coordinates.
ZIVID_CORE_EXPORT Array2D< PointXYZColorBGRA > copyPointsXYZColorsBGRA() const
Array2D of PointXYZColorBGRA.
ZIVID_CORE_EXPORT Image< ColorRGBA_SRGB > copyImageSRGB() const
Get point cloud colors as 8-bit RGBA image in the sRGB color space.
ZIVID_CORE_EXPORT Array2D< PointZ > copyPointsZ() const
Array2D of Z coordinates.
ZIVID_CORE_EXPORT UnorganizedPointCloud toUnorganizedPointCloud() const
Convert to an UnorganizedPointCloud.
ZIVID_CORE_EXPORT PointCloud downsampled(Downsampling downsampling) const
Get a downsampled point cloud.
ZIVID_CORE_EXPORT bool isEmpty() const
Check if the point cloud is empty (contains zero points)
ZIVID_CORE_EXPORT Array2D< PointXYZColorBGRA_SRGB > copyPointsXYZColorsBGRA_SRGB() const
Array2D of PointXYZColorBGRA_SRGB.
ZIVID_CORE_EXPORT Image< ColorBGRA > copyImageBGRA() const
Get point cloud colors as 8-bit BGRA image.
ZIVID_CORE_EXPORT Zivid::Matrix4x4 transformationMatrix() const
Return the current transformation matrix of this point cloud.
ZIVID_CORE_EXPORT size_t height() const
Get the height of the point cloud (number of rows)
ZIVID_CORE_EXPORT Array2D< ColorBGRA > copyColorsBGRA() const
Array2D of point colors in 8-bit BGRA format.
Point cloud with x, y, z, RGB color and SNR laid out as a linear list of only valid points.
Definition UnorganizedPointCloud.h:72
The main Zivid namespace. All Zivid code is found here.
Definition Application.h:84
ColorSRGB ColorRGBA_SRGB
Color with 8-bit red, green, blue and alpha channels in the sRGB color space.
Definition Color.h:79
std::ostream & operator<<(std::ostream &stream, const Array1D< T > &array)
Serialize array information to a stream.
Definition Array1D.h:183