ob::MgcNoiseRemovalFilter Class Reference

MgcNoiseRemoval filter. More...

#include <Filter.hpp>

Inheritance diagram for ob::MgcNoiseRemovalFilter:

Public Member Functions
	MgcNoiseRemovalFilter (const std::string &activationKey="")
	~MgcNoiseRemovalFilter () noexcept override=default
void	setFilterParams (OBMgcNoiseRemovalFilterParams filterParams)
	Set the mgc noise removal filter params.
OBMgcNoiseRemovalFilterParams	getFilterParams ()
	Get the mgc noise removal filter params.
OBUint16PropertyRange	getMaxWidthLeftRange ()
	Get the mgc noise removal filter max_width_left range.
OBUint16PropertyRange	getMaxWidthRightRange ()
	Get the mgc noise removal filter max_width_right range.
OBUint16PropertyRange	getMaxRadiusRange ()
	Get the mgc noise removal filter max_radius range.
OBUint16PropertyRange	getMarginXthRange ()
	Get the mgc noise removal filter margin_x_th range.
OBUint16PropertyRange	getMarginYthRange ()
	Get the mgc noise removal filter margin_y_th range.
OBUint16PropertyRange	getLimitXthRange ()
	Get the mgc noise removal filter limit_x_th range.
OBUint16PropertyRange	getLimitYthRange ()
	Get the mgc noise removal filter limit_y_th range.
OBUint16PropertyRange	getWidthRange ()
	Get the mgc noise removal filter width range.
OBUint16PropertyRange	getHeightRange ()
	Get the mgc noise removal filter height 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

MgcNoiseRemoval filter.

Definition at line 1776 of file Filter.hpp.

Constructor & Destructor Documentation

MgcNoiseRemovalFilter()

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

inline

Definition at line 1778 of file Filter.hpp.

~MgcNoiseRemovalFilter()

ob::MgcNoiseRemovalFilter::~MgcNoiseRemovalFilter ( )

overridedefaultnoexcept

Member Function Documentation

setFilterParams()

void ob::MgcNoiseRemovalFilter::setFilterParams ( OBMgcNoiseRemovalFilterParams filterParams )

inline

Set the mgc noise removal filter params.

Parameters

[in]

filterParams

OBMgcNoiseRemovalFilterParams.

Definition at line 1791 of file Filter.hpp.

Referenced by setFilterParams().

getFilterParams()

OBMgcNoiseRemovalFilterParams ob::MgcNoiseRemovalFilter::getFilterParams ( )

inline

Get the mgc noise removal filter params.

Returns

OBMgcNoiseRemovalFilterParams.

Definition at line 1807 of file Filter.hpp.

getMaxWidthLeftRange()

OBUint16PropertyRange ob::MgcNoiseRemovalFilter::getMaxWidthLeftRange ( )

inline

Get the mgc noise removal filter max_width_left range.

Returns

OBUint16PropertyRange The max_width_left of property range.

Definition at line 1825 of file Filter.hpp.

getMaxWidthRightRange()

OBUint16PropertyRange ob::MgcNoiseRemovalFilter::getMaxWidthRightRange ( )

inline

Get the mgc noise removal filter max_width_right range.

Returns

OBUint16PropertyRange The max_width_right of property range.

Definition at line 1841 of file Filter.hpp.

getMaxRadiusRange()

OBUint16PropertyRange ob::MgcNoiseRemovalFilter::getMaxRadiusRange ( )

inline

Get the mgc noise removal filter max_radius range.

Returns

OBUint16PropertyRange The max_radius of property range.

Definition at line 1857 of file Filter.hpp.

getMarginXthRange()

OBUint16PropertyRange ob::MgcNoiseRemovalFilter::getMarginXthRange ( )

inline

Get the mgc noise removal filter margin_x_th range.

Returns

OBUint16PropertyRange The margin_x_th of property range.

Definition at line 1873 of file Filter.hpp.

getMarginYthRange()

OBUint16PropertyRange ob::MgcNoiseRemovalFilter::getMarginYthRange ( )

inline

Get the mgc noise removal filter margin_y_th range.

Returns

OBUint16PropertyRange The margin_y_th of property range.

Definition at line 1889 of file Filter.hpp.

getLimitXthRange()

OBUint16PropertyRange ob::MgcNoiseRemovalFilter::getLimitXthRange ( )

inline

Get the mgc noise removal filter limit_x_th range.

Returns

OBUint16PropertyRange The limit_x_th of property range.

Definition at line 1905 of file Filter.hpp.

getLimitYthRange()

OBUint16PropertyRange ob::MgcNoiseRemovalFilter::getLimitYthRange ( )

inline

Get the mgc noise removal filter limit_y_th range.

Returns

OBUint16PropertyRange The limit_y_th of property range.

Definition at line 1921 of file Filter.hpp.

getWidthRange()

OBUint16PropertyRange ob::MgcNoiseRemovalFilter::getWidthRange ( )

inline

Get the mgc noise removal filter width range.

Returns

OBUint16PropertyRange The width of property range.

Definition at line 1937 of file Filter.hpp.

getHeightRange()

OBUint16PropertyRange ob::MgcNoiseRemovalFilter::getHeightRange ( )

inline

Get the mgc noise removal filter height range.

Returns

OBUint16PropertyRange The height of property range.

Definition at line 1953 of file Filter.hpp.

---

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

• Filter.hpp