ob::PointCloudFilter Class Reference

The PointCloudFilter class is a subclass of Filter that generates point clouds. More...

#include <Filter.hpp>

Inheritance diagram for ob::PointCloudFilter:

Public Member Functions
	PointCloudFilter ()
virtual	~PointCloudFilter () noexcept=default
void	setCreatePointFormat (OBFormat format)
	Set the output pointcloud frame format.
void	setCoordinateDataScaled (float factor)
	Set the point cloud coordinate data zoom factor.
void	setColorDataNormalization (bool state)
	Set point cloud color data normalization.
void	setCoordinateSystem (OBCoordinateSystemType type)
	Set the point cloud coordinate system.
void	setPositionDataScaled (float scale)
void	setFrameAlignState (bool state)
void	setCameraParam (OBCameraParam param)
Public Member Functions inherited from ob::Filter
	Filter (ob_filter *impl)
virtual	~Filter () noexcept
ob_filter *	getImpl () const
	Get the Impl object of the filter.
virtual const std::string &	getName () const
	Get the type of filter.
virtual void	reset () const
	Reset the filter, freeing the internal cache, stopping the processing thread, and clearing the pending buffer frame when asynchronous processing is used.
virtual void	enable (bool enable) const
	enable the filter
virtual bool	isEnabled () const
	Return Enable State.
virtual std::shared_ptr< Frame >	process (std::shared_ptr< const Frame > frame) const
	Processes a frame synchronously.
virtual void	pushFrame (std::shared_ptr< Frame > frame) const
	Pushes the pending frame into the cache for asynchronous processing.
virtual void	setCallBack (FilterCallback callback)
	Set the callback function for asynchronous processing.
virtual std::string	getConfigSchema () const
	Get config schema of the filter.
virtual std::vector< OBFilterConfigSchemaItem >	getConfigSchemaVec () const
	Get the Config Schema Vec object.
virtual void	setConfigValue (const std::string &configName, double value) const
	Set the filter config value by name.
virtual double	getConfigValue (const std::string &configName) const
	Get the Config Value object by name.
virtual const char *	type ()
template<typename T >
bool	is ()
	Check if the runtime type of the filter object is compatible with a given type.
template<typename T >
std::shared_ptr< T >	as ()

Additional Inherited Members
Protected Member Functions inherited from ob::Filter
	Filter ()=default
	Default constructor with nullptr impl, used for derived classes only.
virtual void	init (ob_filter *impl)
Protected Attributes inherited from ob::Filter
ob_filter *	impl_ = nullptr
std::string	name_
FilterCallback	callback_
std::vector< OBFilterConfigSchemaItem >	configSchemaVec_

Detailed Description

The PointCloudFilter class is a subclass of Filter that generates point clouds.

Definition at line 341 of file Filter.hpp.

Constructor & Destructor Documentation

PointCloudFilter()

ob::PointCloudFilter::PointCloudFilter ( )

inline

Definition at line 343 of file Filter.hpp.

~PointCloudFilter()

virtual ob::PointCloudFilter::~PointCloudFilter ( )

virtualdefaultnoexcept

Member Function Documentation

setCreatePointFormat()

void ob::PointCloudFilter::setCreatePointFormat ( OBFormat format )

inline

Set the output pointcloud frame format.

Parameters

type	The point cloud frame format: OB_FORMAT_POINT or OB_FORMAT_RGB_POINT

Definition at line 357 of file Filter.hpp.

setCoordinateDataScaled()

void ob::PointCloudFilter::setCoordinateDataScaled ( float factor )

inline

Set the point cloud coordinate data zoom factor.

Calling this function to set the scale will change the point coordinate scaling factor of the output point cloud frame, The point coordinate scaling factor for the output point cloud frame can be obtained via PointsFrame::getCoordinateValueScale function.

Parameters

factor

The scale factor.

Definition at line 369 of file Filter.hpp.

Referenced by setPositionDataScaled().

setColorDataNormalization()

void ob::PointCloudFilter::setColorDataNormalization ( bool state )

inline

Set point cloud color data normalization.

If normalization is required, the output point cloud frame's color data will be normalized to the range [0, 1].

Attention

This function only works for when create point format is set to OB_FORMAT_RGB_POINT.

Parameters

state

Whether normalization is required.

Definition at line 381 of file Filter.hpp.

setCoordinateSystem()

void ob::PointCloudFilter::setCoordinateSystem ( OBCoordinateSystemType type )

inline

Set the point cloud coordinate system.

Parameters

type	The coordinate system type.

Definition at line 390 of file Filter.hpp.

setPositionDataScaled()

void ob::PointCloudFilter::setPositionDataScaled ( float scale )

inline

Definition at line 396 of file Filter.hpp.

setFrameAlignState()

void ob::PointCloudFilter::setFrameAlignState ( bool state )

inline

Definition at line 401 of file Filter.hpp.

setCameraParam()

void ob::PointCloudFilter::setCameraParam ( OBCameraParam param )

inline

Definition at line 405 of file Filter.hpp.

---

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

• C:/Users/hzcyf/Projects/openorbbecsdkgroup/OpenOrbbecSDK/include/libobsensor/hpp/Filter.hpp