ob::PointsFrame Class Reference

Define the PointsFrame class, which inherits from the Frame class. More...

#include <Frame.hpp>

Inheritance diagram for ob::PointsFrame:

Public Member Functions
	PointsFrame (const ob_frame *impl)
	Construct a new PointsFrame object with a given pointer to the internal frame object.
	~PointsFrame () noexcept override=default
float	getCoordinateValueScale () const
	Get the point coordinate value scale of the points frame. The point position value of the points frame is multiplied by the scale to give a position value in millimeters. For example, if scale=0.1, the x-coordinate value of a point is x = 10000, which means that the actual x-coordinate value = x*scale = 10000*0.1 = 1000mm.
uint32_t	getWidth () const
	Get the width of the frame.
uint32_t	getHeight () const
	Get the height of the frame.
Public Member Functions inherited from ob::Frame
	Frame (const ob_frame *impl)
	Construct a new Frame object with a given pointer to the internal frame object.
const ob_frame *	getImpl () const
	Get the internal (impl) frame object.
virtual	~Frame () noexcept
	Destroy the Frame object.
virtual OBFrameType	getType () const
	Get the type of frame.
virtual OBFormat	getFormat () const
	Get the format of the frame.
virtual uint64_t	getIndex () const
	Get the sequence number of the frame.
virtual uint8_t *	getData () const
	Get frame data.
virtual uint32_t	getDataSize () const
	Get the size of the frame data.
uint64_t	getTimeStampUs () const
	Get the hardware timestamp of the frame in microseconds.
uint64_t	getSystemTimeStampUs () const
	Get the system timestamp of the frame in microseconds.
uint64_t	getGlobalTimeStampUs () const
	Get the global timestamp of the frame in microseconds.
uint8_t *	getMetadata () const
	Get the metadata pointer of the frame.
uint32_t	getMetadataSize () const
	Get the size of the metadata of the frame.
bool	hasMetadata (OBFrameMetadataType type) const
	Check if the frame object has metadata of a given type.
int64_t	getMetadataValue (OBFrameMetadataType type) const
	Get the metadata value.
std::shared_ptr< StreamProfile >	getStreamProfile () const
	get StreamProfile of the frame
std::shared_ptr< Sensor >	getSensor () const
	get owner sensor of the frame
std::shared_ptr< Device >	getDevice () const
	get owner device of the frame
template<typename T>
bool	is () const
	Check if the runtime type of the frame object is compatible with a given type.
template<typename T>
std::shared_ptr< T >	as ()
	Convert the frame object to a target type.
template<typename T>
std::shared_ptr< const T >	as () const
	Convert the frame object to a target type.
void	copyFrameInfo (std::shared_ptr< const Frame > srcFrame)
	Copy the information of the source frame object to the destination frame object.
void	setSystemTimestampUs (uint64_t systemTimestampUs)
	Set the system timestamp of the frame in microseconds.
void	updateData (const uint8_t *data, uint32_t dataSize)
	Update the data of a frame.
void	updateMetadata (const uint8_t *metadata, uint32_t metadataSize)
	Update the metadata of the frame.
void	setStreamProfile (std::shared_ptr< const StreamProfile > profile)
	Set (override) the stream profile of the frame.
OBFrameType	type () const
virtual OBFormat	format () const
virtual uint64_t	index () const
virtual void *	data () const
virtual uint32_t	dataSize () const
uint64_t	timeStamp () const
uint64_t	timeStampUs () const
uint64_t	systemTimeStamp () const
uint64_t	systemTimeStampUs () const
uint64_t	globalTimeStampUs () const
uint8_t *	metadata () const
uint32_t	metadataSize () const

Additional Inherited Members
Protected Attributes inherited from ob::Frame
const ob_frame *	impl_ = nullptr
	The pointer to the internal (c api level) frame object.

Detailed Description

Define the PointsFrame class, which inherits from the Frame class.

The PointsFrame class is used to obtain pointcloud data and point cloud information.

Note

The pointcloud data format can be obtained from the Frame::getFormat() function. Witch can be one of the following formats:

• OB_FORMAT_POINT : 32-bit float format with 3D point coordinates (x, y, z), OBPoint
• OB_FORMAT_RGB_POINT : 32-bit float format with 3D point coordinates (x, y, z) and point colors (r, g, b) OBColorPoint

Definition at line 714 of file Frame.hpp.

Constructor & Destructor Documentation

PointsFrame()

ob::PointsFrame::PointsFrame ( const ob_frame * impl )

inlineexplicit

Construct a new PointsFrame object with a given pointer to the internal frame object.

Attention

After calling this constructor, the frame object will own the internal frame object, and the internal frame object will be deleted when the frame object is destroyed.

The internal frame object should not be deleted by the caller.

Please use the FrameFactory to create a Frame object.

Parameters

[in]

impl

The pointer to the internal frame object.

Definition at line 727 of file Frame.hpp.

~PointsFrame()

ob::PointsFrame::~PointsFrame ( )

overridedefaultnoexcept

Member Function Documentation

getCoordinateValueScale()

float ob::PointsFrame::getCoordinateValueScale ( ) const

inline

Get the point coordinate value scale of the points frame. The point position value of the points frame is multiplied by the scale to give a position value in millimeters. For example, if scale=0.1, the x-coordinate value of a point is x = 10000, which means that the actual x-coordinate value = x*scale = 10000*0.1 = 1000mm.

Returns

float The coordinate value scale.

Definition at line 738 of file Frame.hpp.

Referenced by getCoordinateValueScale().

getWidth()

uint32_t ob::PointsFrame::getWidth ( ) const

inline

Get the width of the frame.

Returns

uint32_t The width of the frame.

Definition at line 751 of file Frame.hpp.

getHeight()

uint32_t ob::PointsFrame::getHeight ( ) const

inline

Get the height of the frame.

Returns

uint32_t The height of the frame.

Definition at line 765 of file Frame.hpp.

---

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

• Frame.hpp