ob::TemporalFilter Class Reference

Temporal filter. More...

#include <Filter.hpp>

Inheritance diagram for ob::TemporalFilter:

Public Member Functions
	TemporalFilter (const std::string &activationKey="")
	~TemporalFilter () noexcept=default
OBFloatPropertyRange	getDiffScaleRange ()
	Get the TemporalFilter diffscale range.
void	setDiffScale (float value)
	Set the TemporalFilter diffscale value.
OBFloatPropertyRange	getWeightRange ()
	Get the TemporalFilter weight range.
void	setWeight (float value)
	Set the TemporalFilter weight 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

Temporal filter.

Definition at line 890 of file Filter.hpp.

Constructor & Destructor Documentation

TemporalFilter()

ob::TemporalFilter::TemporalFilter ( const std::string & activationKey = "" )

inline

Definition at line 892 of file Filter.hpp.

~TemporalFilter()

ob::TemporalFilter::~TemporalFilter ( )

defaultnoexcept

Member Function Documentation

getDiffScaleRange()

OBFloatPropertyRange ob::TemporalFilter::getDiffScaleRange ( )

inline

Get the TemporalFilter diffscale range.

Returns

OBFloatPropertyRange the diffscale value of property range.

Definition at line 906 of file Filter.hpp.

setDiffScale()

void ob::TemporalFilter::setDiffScale ( float value )

inline

Set the TemporalFilter diffscale value.

Parameters

value

diffscale value.

Definition at line 923 of file Filter.hpp.

getWeightRange()

OBFloatPropertyRange ob::TemporalFilter::getWeightRange ( )

inline

Get the TemporalFilter weight range.

Returns

OBFloatPropertyRange the weight value of property range.

Definition at line 932 of file Filter.hpp.

setWeight()

void ob::TemporalFilter::setWeight ( float value )

inline

Set the TemporalFilter weight value.

Parameters

value

weight value.

Definition at line 949 of file Filter.hpp.

---

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

• D:/program/gitlab_repository/package/openorbbecsdkgroup/OpenOrbbecSDK/include/libobsensor/hpp/Filter.hpp