ob::ThresholdFilter Class Reference

Creates depth Thresholding filter By controlling min and max options on the block. More...

#include <Filter.hpp>

Inheritance diagram for ob::ThresholdFilter:

Public Member Functions
	ThresholdFilter ()
virtual	~ThresholdFilter () noexcept=default
OBIntPropertyRange	getMinRange ()
	Get the threshold filter min range.
OBIntPropertyRange	getMaxRange ()
	Get the threshold filter max range.
bool	setValueRange (uint16_t min, uint16_t max)
	Set the threshold filter max and min range.
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

Creates depth Thresholding filter By controlling min and max options on the block.

Definition at line 587 of file Filter.hpp.

Constructor & Destructor Documentation

ThresholdFilter()

ob::ThresholdFilter::ThresholdFilter ( )

inline

Definition at line 589 of file Filter.hpp.

~ThresholdFilter()

virtual ob::ThresholdFilter::~ThresholdFilter ( )

virtualdefaultnoexcept

Member Function Documentation

getMinRange()

OBIntPropertyRange ob::ThresholdFilter::getMinRange ( )

inline

Get the threshold filter min range.

Returns

OBIntPropertyRange The range of the threshold filter min.

Definition at line 603 of file Filter.hpp.

getMaxRange()

OBIntPropertyRange ob::ThresholdFilter::getMaxRange ( )

inline

Get the threshold filter max range.

Returns

OBIntPropertyRange The range of the threshold filter max.

Definition at line 620 of file Filter.hpp.

setValueRange()

bool ob::ThresholdFilter::setValueRange ( uint16_t min, uint16_t max )

inline

Set the threshold filter max and min range.

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