ob::SpatialAdvancedFilter Class Reference

Spatial advanced filte smooths the image by calculating frame with alpha and delta settings alpha defines the weight of the current pixel for smoothing, delta defines the depth gradient below which the smoothing will occur as number of depth levels. More...

#include <Filter.hpp>

Inheritance diagram for ob::SpatialAdvancedFilter:

Public Member Functions
	SpatialAdvancedFilter (const std::string &activationKey="")
virtual	~SpatialAdvancedFilter () noexcept=default
OBFloatPropertyRange	getAlphaRange ()
	Get the spatial advanced filter alpha range.
OBUint16PropertyRange	getDispDiffRange ()
	Get the spatial advanced filter dispdiff range.
OBUint16PropertyRange	getRadiusRange ()
	Get the spatial advanced filter radius range.
OBIntPropertyRange	getMagnitudeRange ()
	Get the spatial advanced filter magnitude range.
OBSpatialAdvancedFilterParams	getFilterParams ()
	Get the spatial advanced filter params.
void	setFilterParams (OBSpatialAdvancedFilterParams params)
	Set the spatial advanced 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

Spatial advanced filte smooths the image by calculating frame with alpha and delta settings alpha defines the weight of the current pixel for smoothing, delta defines the depth gradient below which the smoothing will occur as number of depth levels.

Definition at line 650 of file Filter.hpp.

Constructor & Destructor Documentation

SpatialAdvancedFilter()

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

inline

Definition at line 652 of file Filter.hpp.

~SpatialAdvancedFilter()

virtual ob::SpatialAdvancedFilter::~SpatialAdvancedFilter ( )

virtualdefaultnoexcept

Member Function Documentation

getAlphaRange()

OBFloatPropertyRange ob::SpatialAdvancedFilter::getAlphaRange ( )

inline

Get the spatial advanced filter alpha range.

Returns

OBFloatPropertyRange the alpha value of property range.

Definition at line 666 of file Filter.hpp.

getDispDiffRange()

OBUint16PropertyRange ob::SpatialAdvancedFilter::getDispDiffRange ( )

inline

Get the spatial advanced filter dispdiff range.

Returns

OBFloatPropertyRange the dispdiff value of property range.

Definition at line 683 of file Filter.hpp.

getRadiusRange()

OBUint16PropertyRange ob::SpatialAdvancedFilter::getRadiusRange ( )

inline

Get the spatial advanced filter radius range.

Returns

OBFloatPropertyRange the radius value of property range.

Definition at line 700 of file Filter.hpp.

getMagnitudeRange()

OBIntPropertyRange ob::SpatialAdvancedFilter::getMagnitudeRange ( )

inline

Get the spatial advanced filter magnitude range.

Returns

OBFloatPropertyRange the magnitude value of property range.

Definition at line 717 of file Filter.hpp.

getFilterParams()

OBSpatialAdvancedFilterParams ob::SpatialAdvancedFilter::getFilterParams ( )

inline

Get the spatial advanced filter params.

Returns

OBSpatialAdvancedFilterParams

Definition at line 734 of file Filter.hpp.

setFilterParams()

void ob::SpatialAdvancedFilter::setFilterParams ( OBSpatialAdvancedFilterParams params )

inline

Set the spatial advanced filter params.

Parameters

params

OBSpatialAdvancedFilterParams.

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