ob::SpatialFastFilter Class Reference

The Spatial Fast Filter utilizes an enhanced median smoothing algorithm, designed to significantly reduce CPU usage and optimize processing efficiency. More...

#include <Filter.hpp>

Inheritance diagram for ob::SpatialFastFilter:

Public Member Functions
	SpatialFastFilter (const std::string &activationKey="")
virtual	~SpatialFastFilter () noexcept override=default
OBIntPropertyRange	getRadiusRange ()
	Get the spatial fast filter radius range.
OBSpatialFastFilterParams	getFilterParams ()
	Get the spatial fast filter params.
void	setFilterParams (OBSpatialFastFilterParams params)
	Set the spatial fast filter params.
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 Spatial Fast Filter utilizes an enhanced median smoothing algorithm, designed to significantly reduce CPU usage and optimize processing efficiency.

Definition at line 786 of file Filter.hpp.

Constructor & Destructor Documentation

SpatialFastFilter()

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

inline

Definition at line 788 of file Filter.hpp.

~SpatialFastFilter()

virtual ob::SpatialFastFilter::~SpatialFastFilter ( )

overridevirtualdefaultnoexcept

Member Function Documentation

getRadiusRange()

OBIntPropertyRange ob::SpatialFastFilter::getRadiusRange ( )

inline

Get the spatial fast filter radius range.

Returns

OBIntPropertyRange the radius value of property range.

Definition at line 802 of file Filter.hpp.

Referenced by getRadiusRange().

getFilterParams()

OBSpatialFastFilterParams ob::SpatialFastFilter::getFilterParams ( )

inline

Get the spatial fast filter params.

Returns

OBSpatialFastFilterParams

Definition at line 819 of file Filter.hpp.

setFilterParams()

void ob::SpatialFastFilter::setFilterParams ( OBSpatialFastFilterParams params )

inline

Set the spatial fast filter params.

Parameters

params

OBSpatialFastFilterParams.

Definition at line 830 of file Filter.hpp.

---

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

• E:/jenkins/workspace/OrbbecSDK/build_sdk/OpenOrbbecSDK/include/libobsensor/hpp/Filter.hpp