ob::DecimationFilter Class Reference

Decimation filter, reducing complexity by subsampling depth maps and losing depth details. More...

#include <Filter.hpp>

Inheritance diagram for ob::DecimationFilter:

Public Member Functions
	DecimationFilter ()
virtual	~DecimationFilter () noexcept=default
void	setScaleValue (uint8_t value)
	Set the decimation filter scale value.
uint8_t	getScaleValue ()
	Get the decimation filter scale value.
OBUint8PropertyRange	getScaleRange ()
	Get the property range of the decimation filter scale value.
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

Decimation filter, reducing complexity by subsampling depth maps and losing depth details.

Definition at line 543 of file Filter.hpp.

Constructor & Destructor Documentation

DecimationFilter()

ob::DecimationFilter::DecimationFilter ( )

inline

Definition at line 545 of file Filter.hpp.

~DecimationFilter()

virtual ob::DecimationFilter::~DecimationFilter ( )

virtualdefaultnoexcept

Member Function Documentation

setScaleValue()

void ob::DecimationFilter::setScaleValue ( uint8_t value )

inline

Set the decimation filter scale value.

Parameters

type	The decimation filter scale value.

Definition at line 559 of file Filter.hpp.

getScaleValue()

uint8_t ob::DecimationFilter::getScaleValue ( )

inline

Get the decimation filter scale value.

Definition at line 566 of file Filter.hpp.

getScaleRange()

OBUint8PropertyRange ob::DecimationFilter::getScaleRange ( )

inline

Get the property range of the decimation filter scale value.

Definition at line 573 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