ob::NoiseRemovalFilter Class Reference

The noise removal filter,removing scattering depth pixels. More...

#include <Filter.hpp>

Inheritance diagram for ob::NoiseRemovalFilter:

Public Member Functions
	NoiseRemovalFilter (const std::string &activationKey="")
	~NoiseRemovalFilter () noexcept override=default
void	setFilterParams (OBNoiseRemovalFilterParams filterParams)
	Set the noise removal filter params.
OBNoiseRemovalFilterParams	getFilterParams ()
	Get the noise removal filter params.
OBUint16PropertyRange	getDispDiffRange ()
	Get the noise removal filter disp diff range.
OBUint16PropertyRange	getMaxSizeRange ()
	Get the noise removal filter max size 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

The noise removal filter,removing scattering depth pixels.

Definition at line 962 of file Filter.hpp.

Constructor & Destructor Documentation

NoiseRemovalFilter()

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

inline

Definition at line 964 of file Filter.hpp.

~NoiseRemovalFilter()

ob::NoiseRemovalFilter::~NoiseRemovalFilter ( )

overridedefaultnoexcept

Member Function Documentation

setFilterParams()

void ob::NoiseRemovalFilter::setFilterParams ( OBNoiseRemovalFilterParams filterParams )

inline

Set the noise removal filter params.

Parameters

[in]

filterParams

ob_noise_removal_filter_params.

Definition at line 978 of file Filter.hpp.

Referenced by setFilterParams().

getFilterParams()

OBNoiseRemovalFilterParams ob::NoiseRemovalFilter::getFilterParams ( )

inline

Get the noise removal filter params.

Returns

OBNoiseRemovalFilterParams.

Definition at line 989 of file Filter.hpp.

getDispDiffRange()

OBUint16PropertyRange ob::NoiseRemovalFilter::getDispDiffRange ( )

inline

Get the noise removal filter disp diff range.

Returns

OBUint16PropertyRange The disp diff of property range.

Definition at line 1001 of file Filter.hpp.

getMaxSizeRange()

OBUint16PropertyRange ob::NoiseRemovalFilter::getMaxSizeRange ( )

inline

Get the noise removal filter max size range.

Returns

OBUint16PropertyRange The max size of property range.

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