ob::SpatialModerateFilter Class Reference

The Spatial Moderate Filter utilizes an optimized average smoothing algorithm, to achieve a balance between processing speed and the quality of smoothing achieved. More...

#include <Filter.hpp>

Inheritance diagram for ob::SpatialModerateFilter:

Public Member Functions
	SpatialModerateFilter (const std::string &activationKey="")
virtual	~SpatialModerateFilter () noexcept override=default
OBIntPropertyRange	getMagnitudeRange ()
	Get the spatial moderate filter magnitude range.
OBIntPropertyRange	getRadiusRange ()
	Get the spatial moderate filter radius range.
OBIntPropertyRange	getDispDiffRange ()
	Get the spatial moderate filter disp diff range.
OBSpatialModerateFilterParams	getFilterParams ()
	Get the spatial moderate filter params.
void	setFilterParams (OBSpatialModerateFilterParams params)
	Set the spatial moderate 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 Moderate Filter utilizes an optimized average smoothing algorithm, to achieve a balance between processing speed and the quality of smoothing achieved.

Definition at line 839 of file Filter.hpp.

Constructor & Destructor Documentation

SpatialModerateFilter()

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

inline

Definition at line 841 of file Filter.hpp.

~SpatialModerateFilter()

virtual ob::SpatialModerateFilter::~SpatialModerateFilter ( )

overridevirtualdefaultnoexcept

Member Function Documentation

getMagnitudeRange()

OBIntPropertyRange ob::SpatialModerateFilter::getMagnitudeRange ( )

inline

Get the spatial moderate filter magnitude range.

Returns

OBIntPropertyRange the magnitude value of property range.

Definition at line 855 of file Filter.hpp.

Referenced by getMagnitudeRange().

getRadiusRange()

OBIntPropertyRange ob::SpatialModerateFilter::getRadiusRange ( )

inline

Get the spatial moderate filter radius range.

Returns

OBIntPropertyRange the radius value of property range.

Definition at line 872 of file Filter.hpp.

getDispDiffRange()

OBIntPropertyRange ob::SpatialModerateFilter::getDispDiffRange ( )

inline

Get the spatial moderate filter disp diff range.

Returns

OBIntPropertyRange the disp diff value of property range.

Definition at line 889 of file Filter.hpp.

getFilterParams()

OBSpatialModerateFilterParams ob::SpatialModerateFilter::getFilterParams ( )

inline

Get the spatial moderate filter params.

Returns

OBSpatialModerateFilterParams

Definition at line 906 of file Filter.hpp.

setFilterParams()

void ob::SpatialModerateFilter::setFilterParams ( OBSpatialModerateFilterParams params )

inline

Set the spatial moderate filter params.

Parameters

params

OBSpatialModerateFilterParams.

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