ob::EdgeNoiseRemovalFilter Class Reference

EdgeNoiseRemoval filter. More...

#include <Filter.hpp>

Inheritance diagram for ob::EdgeNoiseRemovalFilter:

Public Member Functions
	EdgeNoiseRemovalFilter (const std::string &activationKey="")
	~EdgeNoiseRemovalFilter () noexcept override=default
OBUint16PropertyRange	getMarginXthRange ()
	Get the edge noise removal filter margin x th range.
OBUint16PropertyRange	getMarginYthRange ()
	Get the edge noise removal filter margin y th range.
OBUint16PropertyRange	getLimitXthRange ()
	Get the edge noise removal filter limit x th range.
OBUint16PropertyRange	getLimitYthRange ()
	Get the edge noise removal filter limit y th range.
OBUint16PropertyRange	getVerticalDirectionEnableRange ()
	Get the edge noise removal filter vertical direction enable range.
OBUint16PropertyRange	getWidthRange ()
	Get the edge noise removal filter width range.
OBUint16PropertyRange	getHeightRange ()
	Get the edge noise removal filter height range.
void	setFilterParams (OBEdgeNoiseRemovalFilterParams filterParams)
	Set the edge noise removal filter params.
OBEdgeNoiseRemovalFilterParams	getFilterParams ()
	Get the edge noise removal 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

EdgeNoiseRemoval filter.

Definition at line 1127 of file Filter.hpp.

Constructor & Destructor Documentation

EdgeNoiseRemovalFilter()

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

inline

Definition at line 1129 of file Filter.hpp.

~EdgeNoiseRemovalFilter()

ob::EdgeNoiseRemovalFilter::~EdgeNoiseRemovalFilter ( )

overridedefaultnoexcept

Member Function Documentation

getMarginXthRange()

OBUint16PropertyRange ob::EdgeNoiseRemovalFilter::getMarginXthRange ( )

inline

Get the edge noise removal filter margin x th range.

Returns

OBUint16PropertyRange The margin x th of property range.

Definition at line 1142 of file Filter.hpp.

Referenced by getMarginXthRange().

getMarginYthRange()

OBUint16PropertyRange ob::EdgeNoiseRemovalFilter::getMarginYthRange ( )

inline

Get the edge noise removal filter margin y th range.

Returns

OBUint16PropertyRange The margin y th of property range.

Definition at line 1158 of file Filter.hpp.

getLimitXthRange()

OBUint16PropertyRange ob::EdgeNoiseRemovalFilter::getLimitXthRange ( )

inline

Get the edge noise removal filter limit x th range.

Returns

OBUint16PropertyRange The limit x th of property range.

Definition at line 1174 of file Filter.hpp.

getLimitYthRange()

OBUint16PropertyRange ob::EdgeNoiseRemovalFilter::getLimitYthRange ( )

inline

Get the edge noise removal filter limit y th range.

Returns

OBUint16PropertyRange The limit y th of property range.

Definition at line 1190 of file Filter.hpp.

getVerticalDirectionEnableRange()

OBUint16PropertyRange ob::EdgeNoiseRemovalFilter::getVerticalDirectionEnableRange ( )

inline

Get the edge noise removal filter vertical direction enable range.

Returns

OBUint16PropertyRange The vertical direction enable of property range.

Definition at line 1206 of file Filter.hpp.

getWidthRange()

OBUint16PropertyRange ob::EdgeNoiseRemovalFilter::getWidthRange ( )

inline

Get the edge noise removal filter width range.

Returns

OBUint16PropertyRange The width of property range.

Definition at line 1222 of file Filter.hpp.

getHeightRange()

OBUint16PropertyRange ob::EdgeNoiseRemovalFilter::getHeightRange ( )

inline

Get the edge noise removal filter height range.

Returns

OBUint16PropertyRange The height of property range.

Definition at line 1238 of file Filter.hpp.

setFilterParams()

void ob::EdgeNoiseRemovalFilter::setFilterParams ( OBEdgeNoiseRemovalFilterParams filterParams )

inline

Set the edge noise removal filter params.

Parameters

[in]

filterParams

OBEdgeNoiseRemovalFilterParams.

Definition at line 1255 of file Filter.hpp.

getFilterParams()

OBEdgeNoiseRemovalFilterParams ob::EdgeNoiseRemovalFilter::getFilterParams ( )

inline

Get the edge noise removal filter params.

Returns

OBEdgeNoiseRemovalFilterParams.

Definition at line 1270 of file Filter.hpp.

---

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

• Filter.hpp