Zivid::Experimental::PointCloudExport Namespace Reference

Namespaces
namespace	FileFormat

Enumerations
enum class	ColorSpace { sRGB , linearRGB }
	Color space to use when saving frame. More...
enum class	IncludeNormals { no , yes }
	Include normals in the exported file. More...

Functions
ZIVID_CORE_EXPORT void	exportFrame (const Zivid::Frame &frame, const FileFormat::ZDF &specification)
	Save frame to ZDF file.
ZIVID_CORE_EXPORT void	exportFrame (const Zivid::Frame &frame, const FileFormat::PLY &specification)
	Save frame to PLY file.
ZIVID_CORE_EXPORT void	exportFrame (const Zivid::Frame &frame, const FileFormat::XYZ &specification)
	Save frame to XYZ file.
ZIVID_CORE_EXPORT void	exportFrame (const Zivid::Frame &frame, const FileFormat::PCD &specification)
	Save frame to PCD file.
ZIVID_CORE_EXPORT void	exportUnorganizedPointCloud (const Zivid::UnorganizedPointCloud &pointCloud, const FileFormat::PLY &specification)
	Save unorganized pointcloud to PLY file.
ZIVID_CORE_EXPORT void	exportUnorganizedPointCloud (const Zivid::UnorganizedPointCloud &pointCloud, const FileFormat::XYZ &specification)
	Save unorganized pointcloud to XYZ file.
ZIVID_CORE_EXPORT void	exportUnorganizedPointCloud (const Zivid::UnorganizedPointCloud &pointCloud, const FileFormat::PCD &specification)
	Save unorganized pointcloud to PCD file.

Enumeration Type Documentation

ColorSpace

enum class Zivid::Experimental::PointCloudExport::ColorSpace

strong

Color space to use when saving frame.

Enum used to specify the color space of the point cloud when saving a frame to a file.

Enumerator
sRGB
linearRGB

IncludeNormals

enum class Zivid::Experimental::PointCloudExport::IncludeNormals

strong

Include normals in the exported file.

Enum used to specify if normals should be included when saving a frame to a file.

Enumerator
no
yes

Function Documentation

exportFrame() [1/4]

ZIVID_CORE_EXPORT void Zivid::Experimental::PointCloudExport::exportFrame	(	const Zivid::Frame &	frame,
		const FileFormat::PCD &	specification )

Save frame to PCD file.

Saves frame object to a PCD file. Specify the layout, color space and whether to include normal data of the point cloud data in specification parameter. When Layout option is not set, exported data is organized but with incorrect header. The correct header can be set in the exported PCD file by setting Configuration/APIBreakingBugFixes/FileFormats/PCD/UseOrganizedFormat in the Config.yml file.

Parameters

frame	Frame object to save
specification	Specification for saving frame in PCD format

exportFrame() [2/4]

ZIVID_CORE_EXPORT void Zivid::Experimental::PointCloudExport::exportFrame	(	const Zivid::Frame &	frame,
		const FileFormat::PLY &	specification )

Save frame to PLY file.

Saves frame object to a PLY file. Specify the layout, color space and whether to include normal data of the point cloud data in specification parameter.

Parameters

frame	Frame object to save
specification	Specification for saving frame in PLY format

exportFrame() [3/4]

ZIVID_CORE_EXPORT void Zivid::Experimental::PointCloudExport::exportFrame	(	const Zivid::Frame &	frame,
		const FileFormat::XYZ &	specification )

Save frame to XYZ file.

Saves frame object to a XYZ file. XYZ (position) and RGB (color) values are separated with white space. Each new point is separated by the newline character. Specify the color space of the point cloud data in specification parameter.

Parameters

frame	Frame object to save
specification	Specification for saving frame in XYZ format

exportFrame() [4/4]

ZIVID_CORE_EXPORT void Zivid::Experimental::PointCloudExport::exportFrame	(	const Zivid::Frame &	frame,
		const FileFormat::ZDF &	specification )

Save frame to ZDF file.

Saves frame object to a ZDF file.

Parameters

frame	Frame object to save
specification	Specification for saving frame in ZDF format

exportUnorganizedPointCloud() [1/3]

ZIVID_CORE_EXPORT void Zivid::Experimental::PointCloudExport::exportUnorganizedPointCloud	(	const Zivid::UnorganizedPointCloud &	pointCloud,
		const FileFormat::PCD &	specification )

Save unorganized pointcloud to PCD file.

Saves unorganized point cloud to a PCD file. Specify the color space for RGB data in the specification. The layout in the specification object must be unorganized. Cannot include normal data in the exported PCD file from an unorganized point cloud.

Parameters

pointCloud	Unorganized point cloud to save
specification	Specification for saving unorganized point cloud in PCD format

exportUnorganizedPointCloud() [2/3]

ZIVID_CORE_EXPORT void Zivid::Experimental::PointCloudExport::exportUnorganizedPointCloud	(	const Zivid::UnorganizedPointCloud &	pointCloud,
		const FileFormat::PLY &	specification )

Save unorganized pointcloud to PLY file.

Saves unorganized point cloud to a PLY file. Specify the color space for RGB data in the specification. The layout in the specification object must be unordered. Cannot include normal data in the exported PLY file from an unorganized point cloud.

Parameters

pointCloud	Unorganized point cloud to save
specification	Specification for saving unorganized point cloud in PLY format

exportUnorganizedPointCloud() [3/3]

ZIVID_CORE_EXPORT void Zivid::Experimental::PointCloudExport::exportUnorganizedPointCloud	(	const Zivid::UnorganizedPointCloud &	pointCloud,
		const FileFormat::XYZ &	specification )

Save unorganized pointcloud to XYZ file.

Saves unorganized point cloud to a XYZ file. XYZ (position) and RGB (color) values are separated with white space. Each new point is separated by the newline character. Specify the color space of the point cloud data in specification parameter.

Parameters

pointCloud	Unorganized point cloud to save
specification	Specification for saving unorganized point cloud in XYZ format