RVC::PointMap Struct Reference

RVC X PointMap. More...

#include <RVC.h>

Public Member Functions
bool	Save (const char *fileName, const PointMapUnit::Enum unit, const bool isBinary, const Image &rawImage=Image())
	export PointMap's data to local file. Only support the *.ply* format. More...
bool	IsValid () const
	Check PointMap is Valid or not. More...
Size	GetSize () const
	Get the PointMap Size object. More...
double *	GetPointDataPtr ()
	Get the Point Data Ptr of PointMap object. More...
double *	GetNormalDataPtr ()
	Get the Normal Data Ptr of PointMap object. More...
const double *	GetPointDataConstPtr () const
	Get the Point Data Const Ptr of PointMap object. More...
const double *	GetNormalDataConstPtr () const
	Get the Normal Const Data Ptr of PointMap object. More...
bool	GetPointMapSeperated (double *x, double *y, double *z, const double scale=1.0)
	Get the Point Data Seperated. More...
PointMap	Clone () const
uint64_t	GetTimestamp () const
	Retrieves the timestamp of the PointMap. More...
bool	SetTimestamp (const uint64_t timestamp)
	Sets the timestamp for the PointMap. More...

Static Public Member Functions
static PointMap	Create (PointMapType::Enum pmt, const Size size, double *data=nullptr, bool owndata=true)
	Create PointMap object. More...
static PointMap	CreateFromFile (const char *fileName, const Size sz, const PointMapUnit::Enum unit)
	Create PointMap object from file. Only support the *.ply* format. If actual number of points in the point cloud is not equal to sz.width * sz.height, the function will return an invalid pointmap. If point cloud unit in the file is millimeter, the point cloud data will be divided by 1000. More...
static void	Destroy (PointMap pm, bool no_reuse=true)
	Destroy a PointMap object. More...

Public Attributes
Handle	m_handle
	RVC Handle.

Detailed Description

RVC X PointMap.

Member Function Documentation

Create()

static PointMap RVC::PointMap::Create ( PointMapType::Enum  pmt, const Size  size, double *  data = nullptr, bool  owndata = true  )

static

Create PointMap object.

Parameters

pmt	PointMapType
size	PointMap Size
data	PointMap data (m)
owndata	True for malloc a new space for PointMap

Returns

PointMap A PointMap object

CreateFromFile()

static PointMap RVC::PointMap::CreateFromFile ( const char *  fileName, const Size  sz, const PointMapUnit::Enum  unit  )

static

Create PointMap object from file. Only support the *.ply* format. If actual number of points in the point cloud is not equal to sz.width * sz.height, the function will return an invalid pointmap. If point cloud unit in the file is millimeter, the point cloud data will be divided by 1000.

Parameters

fileName	Name of file to be loaded.
sz	Size of the point cloud.
unit	The unit of the point cloud data in the file.

Destroy()

static void RVC::PointMap::Destroy ( PointMap  pm, bool  no_reuse = true  )

static

Destroy a PointMap object.

Parameters

pm	PointMap object will be destroyed
no_reuse	True for reuse current space of PointMap

GetNormalDataConstPtr()

const double* RVC::PointMap::GetNormalDataConstPtr

(

)

const

Get the Normal Const Data Ptr of PointMap object.

Returns

const double* Normal Data Ptr

GetNormalDataPtr()

double* RVC::PointMap::GetNormalDataPtr

(

)

Get the Normal Data Ptr of PointMap object.

Returns

double* Normal Data Ptr

GetPointDataConstPtr()

const double* RVC::PointMap::GetPointDataConstPtr

(

)

const

Get the Point Data Const Ptr of PointMap object.

Returns

const double* Point Data Ptr (m)

GetPointDataPtr()

double* RVC::PointMap::GetPointDataPtr

(

)

Get the Point Data Ptr of PointMap object.

Returns

double* Point Data Ptr (m)

GetPointMapSeperated()

bool RVC::PointMap::GetPointMapSeperated	(	double *	x,
		double *	y,
		double *	z,
		const double	scale = 1.0
	)

Get the Point Data Seperated.

Parameters

x
y
z
scale	default set to 1

Returns

true

false

GetSize()

Size RVC::PointMap::GetSize

(

)

const

Get the PointMap Size object.

Returns

Size PointMap Size

GetTimestamp()

uint64_t RVC::PointMap::GetTimestamp

(

)

const

Retrieves the timestamp of the PointMap.

Returns the timestamp value representing the acquisition time of the point cloud data. The timestamp is measured in microseconds (us).

Returns

uint64_t Timestamp value in microseconds (us)

IsValid()

bool RVC::PointMap::IsValid

(

)

const

Check PointMap is Valid or not.

Returns

true Valid

false Not valid

Save()

bool RVC::PointMap::Save	(	const char *	fileName,
		const PointMapUnit::Enum	unit,
		const bool	isBinary,
		const Image &	rawImage = Image()
	)

export PointMap's data to local file. Only support the *.ply* format.

Parameters

fileName	Name of file to be created.
unit	The unit of exported data. If save unit is millimeter, the point cloud data will be multiplied by 1000.
isBinary	Whether to export to binary format.

Returns

bool.

SetTimestamp()

bool RVC::PointMap::SetTimestamp

(

const uint64_t

timestamp

)

Sets the timestamp for the PointMap.

Updates the timestamp value associated with the PointMap data. The timestamp should represent the acquisition time of the point cloud data and must be provided in microseconds (us).

Parameters

timestamp

Timestamp value in microseconds (us) to be set

Returns

bool True if the timestamp was successfully set, false otherwise

---

The documentation for this struct was generated from the following file:

• RVC.h