ob::LutNoiseRemovalFilter Class Reference

LutNoiseRemoval filter. More...

#include <Filter.hpp>

Inheritance diagram for ob::LutNoiseRemovalFilter:

Public Member Functions
	LutNoiseRemovalFilter (const std::string &activationKey="")
	~LutNoiseRemovalFilter () noexcept override=default
void	setFilterParams (OBLutNoiseRemovalFilterParams filterParams)
	Set the lut noise removal filter params.
OBLutNoiseRemovalFilterParams	getFilterParams ()
	Get the lut noise removal filter params.
OBUint16PropertyRange	getMaxLutRange (int index)
	Get the lut noise removal filter max_lut range for a given index (0-15).
OBUint16PropertyRange	getMinDiffRange ()
	Get the lut noise removal filter min_diff range.
OBUint16PropertyRange	getWidthRange ()
	Get the lut noise removal filter width range.
OBUint16PropertyRange	getHeightRange ()
	Get the lut 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

LutNoiseRemoval filter.

Definition at line 1818 of file Filter.hpp.

Constructor & Destructor Documentation

LutNoiseRemovalFilter()

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

inline

Definition at line 1820 of file Filter.hpp.

~LutNoiseRemovalFilter()

ob::LutNoiseRemovalFilter::~LutNoiseRemovalFilter ( )

overridedefaultnoexcept

Member Function Documentation

setFilterParams()

void ob::LutNoiseRemovalFilter::setFilterParams ( OBLutNoiseRemovalFilterParams filterParams )

inline

Set the lut noise removal filter params.

Parameters

[in]

filterParams

OBLutNoiseRemovalFilterParams.

Definition at line 1833 of file Filter.hpp.

Referenced by setFilterParams().

getFilterParams()

OBLutNoiseRemovalFilterParams ob::LutNoiseRemovalFilter::getFilterParams ( )

inline

Get the lut noise removal filter params.

Returns

OBLutNoiseRemovalFilterParams.

Definition at line 1846 of file Filter.hpp.

getMaxLutRange()

OBUint16PropertyRange ob::LutNoiseRemovalFilter::getMaxLutRange ( int index )

inline

Get the lut noise removal filter max_lut range for a given index (0-15).

Parameters

[in]

index

LUT entry index in range [0, 15].

Returns

OBUint16PropertyRange The max_lut of property range.

Definition at line 1862 of file Filter.hpp.

getMinDiffRange()

OBUint16PropertyRange ob::LutNoiseRemovalFilter::getMinDiffRange ( )

inline

Get the lut noise removal filter min_diff range.

Returns

OBUint16PropertyRange The min_diff of property range.

Definition at line 1882 of file Filter.hpp.

getWidthRange()

OBUint16PropertyRange ob::LutNoiseRemovalFilter::getWidthRange ( )

inline

Get the lut noise removal filter width range.

Returns

OBUint16PropertyRange The width of property range.

Definition at line 1898 of file Filter.hpp.

getHeightRange()

OBUint16PropertyRange ob::LutNoiseRemovalFilter::getHeightRange ( )

inline

Get the lut noise removal filter height range.

Returns

OBUint16PropertyRange The height of property range.

Definition at line 1914 of file Filter.hpp.

---

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

• Filter.hpp