uvgformat::API Namespace Reference

Functions
void	setParameter (const std::string &name, const std::string &value)
	Stage a parameter value. Must be called before initializeFormat().
void	initializeFormat ()
	Finalize the parameter map and apply all staged values. Must be called once before loadPly().
std::shared_ptr< uvgFrame >	loadPly (const std::string &filePath, size_t frameNumber)
	Load a point cloud frame from a PLY file.

Function Documentation

initializeFormat()

void uvgformat::API::initializeFormat

(

)

Finalize the parameter map and apply all staged values. Must be called once before loadPly().

Create the context of the uvgVPCCenc encoder. Parse the input parameters and verify if the given configuration is valid. Initialize static parameters and function pointers.

Here is the call graph for this function:

Here is the caller graph for this function:

loadPly()

std::shared_ptr< uvgFrame > uvgformat::API::loadPly	(	const std::string &	filePath,
		size_t	frameNumber
	)

Load a point cloud frame from a PLY file.

Reads the vertex geometry (x, y, z as uint16_t) and, if present, the RGB color attribute (r, g, b as uint8_t). Points whose coordinates exceed 2^geoPrecisionInput-1 are filtered out and a warning is logged.

Note

initializeFormat() must be called before loadPly().

Parameters

filePath	Absolute or relative path to the .ply file.
frameNumber	Sequence number stored in the returned uvgFrame.

Returns

Shared pointer to the populated uvgFrame.

Exceptions

std::runtime_error

if the file cannot be opened or is malformed.

Here is the call graph for this function:

setParameter()

void uvgformat::API::setParameter	(	const std::string &	parameterName,
		const std::string &	parameterValue
	)

Stage a parameter value. Must be called before initializeFormat().

The only way to modify the exposed uvgformat parameters is by calling this function.

Parameters

parameterName	Name of the parameter. All exposed parameters are listed in the object parameterMap defined in uvgformat/utils/parameters.cpp
parameterValue	The value of the parameter written as a string.

Here is the caller graph for this function: