ob::Filter Class Reference

The Filter class is the base class for all filters in the SDK. More...

#include <Filter.hpp>

Inheritance diagram for ob::Filter:

Public Member Functions
	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 ()

Protected Member Functions
	Filter ()=default
	Default constructor with nullptr impl, used for derived classes only.
virtual void	init (ob_filter *impl)

Protected Attributes
ob_filter *	impl_ = nullptr
std::string	name_
FilterCallback	callback_
std::vector< OBFilterConfigSchemaItem >	configSchemaVec_

Detailed Description

The Filter class is the base class for all filters in the SDK.

Definition at line 77 of file Filter.hpp.

Constructor & Destructor Documentation

Filter() [1/2]

ob::Filter::Filter ( )

protecteddefault

Default constructor with nullptr impl, used for derived classes only.

Filter() [2/2]

ob::Filter::Filter ( ob_filter * impl )

inlineexplicit

Definition at line 113 of file Filter.hpp.

~Filter()

virtual ob::Filter::~Filter ( )

inlinevirtualnoexcept

Definition at line 117 of file Filter.hpp.

Member Function Documentation

init()

virtual void ob::Filter::init ( ob_filter * impl )

inlineprotectedvirtual

Definition at line 90 of file Filter.hpp.

Referenced by ob::Align::Align(), ob::DecimationFilter::DecimationFilter(), ob::DisparityTransform::DisparityTransform(), ob::EdgeNoiseRemovalFilter::EdgeNoiseRemovalFilter(), ob::EnhancedDepthFilter::EnhancedDepthFilter(), ob::FalsePositiveFilter::FalsePositiveFilter(), Filter(), ob::FormatConvertFilter::FormatConvertFilter(), ob::HdrMerge::HdrMerge(), ob::HoleFillingFilter::HoleFillingFilter(), ob::LutNoiseRemovalFilter::LutNoiseRemovalFilter(), ob::MgcNoiseRemovalFilter::MgcNoiseRemovalFilter(), ob::NoiseRemovalFilter::NoiseRemovalFilter(), ob::PointCloudFilter::PointCloudFilter(), ob::SequenceIdFilter::SequenceIdFilter(), ob::SpatialAdvancedFilter::SpatialAdvancedFilter(), ob::SpatialFastFilter::SpatialFastFilter(), ob::SpatialModerateFilter::SpatialModerateFilter(), ob::TemporalFilter::TemporalFilter(), ob::ThresholdFilter::ThresholdFilter(), and ob::UnDistortionFilter::UnDistortionFilter().

getImpl()

ob_filter * ob::Filter::getImpl ( ) const

inline

Get the Impl object of the filter.

Returns

ob_filter* The Impl object of the filter.

Definition at line 130 of file Filter.hpp.

getName()

virtual const std::string & ob::Filter::getName ( ) const

inlinevirtual

Get the type of filter.

Returns

string The type of filte.

Definition at line 139 of file Filter.hpp.

Referenced by type().

reset()

virtual void ob::Filter::reset ( ) const

inlinevirtual

Reset the filter, freeing the internal cache, stopping the processing thread, and clearing the pending buffer frame when asynchronous processing is used.

Definition at line 147 of file Filter.hpp.

enable()

virtual void ob::Filter::enable ( bool enable ) const

inlinevirtual

enable the filter

Definition at line 156 of file Filter.hpp.

Referenced by enable(), and isEnabled().

isEnabled()

virtual bool ob::Filter::isEnabled ( ) const

inlinevirtual

Return Enable State.

Definition at line 165 of file Filter.hpp.

process()

virtual std::shared_ptr< Frame > ob::Filter::process ( std::shared_ptr< const Frame > frame ) const

inlinevirtual

Processes a frame synchronously.

Parameters

[in]

frame

The frame to be processed.

Returns

std::shared_ptr< Frame > The processed frame.

Definition at line 179 of file Filter.hpp.

pushFrame()

virtual void ob::Filter::pushFrame ( std::shared_ptr< Frame > frame ) const

inlinevirtual

Pushes the pending frame into the cache for asynchronous processing.

Parameters

[in]

frame

The pending frame. The processing result is returned by the callback function.

Definition at line 198 of file Filter.hpp.

setCallBack()

virtual void ob::Filter::setCallBack ( FilterCallback callback )

inlinevirtual

Set the callback function for asynchronous processing.

Parameters

[in]

callback

The processing result callback.

Definition at line 213 of file Filter.hpp.

getConfigSchema()

virtual std::string ob::Filter::getConfigSchema ( ) const

inlinevirtual

Get config schema of the filter.

The returned string is a csv format string representing the configuration schema of the filter. The format of the string is: <parameter_name>, <parameter_type: "int", "float", "bool">, <minimum_value>, <maximum_value>, <value_step>, <default_value>, <parameter_description>

Returns

std::string The config schema of the filter.

Definition at line 228 of file Filter.hpp.

getConfigSchemaVec()

virtual std::vector< OBFilterConfigSchemaItem > ob::Filter::getConfigSchemaVec ( ) const

inlinevirtual

Get the Config Schema Vec object.

The returned vector contains the config schema items. Each item in the vector is an OBFilterConfigSchemaItem object.

Returns

std::vector<OBFilterConfigSchemaItem> The vector of the filter config schema.

Definition at line 241 of file Filter.hpp.

Referenced by ob::SpatialAdvancedFilter::getAlphaRange(), ob::EnhancedDepthFilter::getConfidenceThresholdRange(), ob::TemporalFilter::getDiffScaleRange(), ob::NoiseRemovalFilter::getDispDiffRange(), ob::SpatialAdvancedFilter::getDispDiffRange(), ob::SpatialModerateFilter::getDispDiffRange(), ob::FalsePositiveFilter::getfpebfMinBleedLengthRange(), ob::FalsePositiveFilter::getfpebfROIMaxXRatioRange(), ob::FalsePositiveFilter::getfpebfROIMaxYRatioRange(), ob::FalsePositiveFilter::getfpebfROIMinXRatioRange(), ob::FalsePositiveFilter::getfpebfROIMinYRatioRange(), ob::FalsePositiveFilter::getfpEdgeBleedFilterEnableRange(), ob::FalsePositiveFilter::getfppafMaxHeightRatioRange(), ob::FalsePositiveFilter::getfppafMaxNoiseLevelRange(), ob::FalsePositiveFilter::getfppafMaxSpeckleSizeRange(), ob::FalsePositiveFilter::getfppafMaxWidthRatioRange(), ob::FalsePositiveFilter::getfppafROIMaxXRatioRange(), ob::FalsePositiveFilter::getfppafROIMaxYRatioRange(), ob::FalsePositiveFilter::getfppafROIMinXRatioRange(), ob::FalsePositiveFilter::getfppafROIMinYRatioRange(), ob::FalsePositiveFilter::getfppafScoreRange(), ob::FalsePositiveFilter::getfppafToleranceRange(), ob::FalsePositiveFilter::getfpPatternAmbiguityFilterEnableRange(), ob::FalsePositiveFilter::getfpTextureSparsityFilterEnableRange(), ob::FalsePositiveFilter::getfptsfMaxNoiseLevelRange(), ob::FalsePositiveFilter::getfptsfMaxSpeckleSizeRange(), ob::FalsePositiveFilter::getfptsfROIMaxXRatioRange(), ob::FalsePositiveFilter::getfptsfROIMaxYRatioRange(), ob::FalsePositiveFilter::getfptsfROIMinXRatioRange(), ob::FalsePositiveFilter::getfptsfROIMinYRatioRange(), ob::EdgeNoiseRemovalFilter::getHeightRange(), ob::LutNoiseRemovalFilter::getHeightRange(), ob::MgcNoiseRemovalFilter::getHeightRange(), ob::EdgeNoiseRemovalFilter::getLimitXthRange(), ob::MgcNoiseRemovalFilter::getLimitXthRange(), ob::EdgeNoiseRemovalFilter::getLimitYthRange(), ob::MgcNoiseRemovalFilter::getLimitYthRange(), ob::SpatialAdvancedFilter::getMagnitudeRange(), ob::SpatialModerateFilter::getMagnitudeRange(), ob::EdgeNoiseRemovalFilter::getMarginXthRange(), ob::MgcNoiseRemovalFilter::getMarginXthRange(), ob::EdgeNoiseRemovalFilter::getMarginYthRange(), ob::MgcNoiseRemovalFilter::getMarginYthRange(), ob::LutNoiseRemovalFilter::getMaxLutRange(), ob::MgcNoiseRemovalFilter::getMaxRadiusRange(), ob::ThresholdFilter::getMaxRange(), ob::NoiseRemovalFilter::getMaxSizeRange(), ob::MgcNoiseRemovalFilter::getMaxWidthLeftRange(), ob::MgcNoiseRemovalFilter::getMaxWidthRightRange(), ob::LutNoiseRemovalFilter::getMinDiffRange(), ob::ThresholdFilter::getMinRange(), ob::SpatialAdvancedFilter::getRadiusRange(), ob::SpatialFastFilter::getRadiusRange(), ob::SpatialModerateFilter::getRadiusRange(), ob::EdgeNoiseRemovalFilter::getVerticalDirectionEnableRange(), ob::TemporalFilter::getWeightRange(), ob::EdgeNoiseRemovalFilter::getWidthRange(), ob::LutNoiseRemovalFilter::getWidthRange(), and ob::MgcNoiseRemovalFilter::getWidthRange().

setConfigValue()

virtual void ob::Filter::setConfigValue ( const std::string & configName, double value ) const

inlinevirtual

Set the filter config value by name.

Attention

The pass into value type is double, witch will be cast to the actual type inside the filter. The actual type can be queried by the filter config schema returned by getConfigSchemaVec.

Parameters

[in]	configName	The name of the config.
[in]	value	The value of the config.

Definition at line 254 of file Filter.hpp.

Referenced by ob::Align::Align(), ob::UnDistortionFilter::clearNewCameraMatrix(), ob::SequenceIdFilter::selectSequenceId(), ob::PointCloudFilter::setColorDataNormalization(), ob::EnhancedDepthFilter::setConfidenceThreshold(), ob::PointCloudFilter::setCoordinateDataScaled(), ob::PointCloudFilter::setCoordinateSystem(), ob::PointCloudFilter::setCreatePointFormat(), ob::PointCloudFilter::setDecimationFactor(), ob::TemporalFilter::setDiffScale(), ob::HoleFillingFilter::setFilterMode(), ob::EdgeNoiseRemovalFilter::setFilterParams(), ob::LutNoiseRemovalFilter::setFilterParams(), ob::MgcNoiseRemovalFilter::setFilterParams(), ob::NoiseRemovalFilter::setFilterParams(), ob::SpatialAdvancedFilter::setFilterParams(), ob::SpatialFastFilter::setFilterParams(), ob::SpatialModerateFilter::setFilterParams(), ob::FormatConvertFilter::setFormatConvertType(), ob::Align::setMatchTargetResolution(), ob::UnDistortionFilter::setNewCameraMatrix(), ob::EnhancedDepthFilter::setResolution(), ob::DecimationFilter::setScaleValue(), ob::UnDistortionFilter::setStreamType(), ob::ThresholdFilter::setValueRange(), ob::TemporalFilter::setWeight(), and ob::UnDistortionFilter::UnDistortionFilter().

getConfigValue()

virtual double ob::Filter::getConfigValue ( const std::string & configName ) const

inlinevirtual

Get the Config Value object by name.

Attention

The returned value type has been casted to double inside the filter. The actual type can be queried by the filter config schema returned by getConfigSchemaVec.

Parameters

[in]

configName

The name of the config.

Returns

double The value of the config.

Definition at line 270 of file Filter.hpp.

Referenced by ob::Align::getAlignToStreamType(), ob::SpatialAdvancedFilter::getAlphaRange(), ob::EnhancedDepthFilter::getConfidenceThresholdRange(), ob::EnhancedDepthFilter::getCurrentHeight(), ob::EnhancedDepthFilter::getCurrentWidth(), ob::PointCloudFilter::getDecimationFactorRange(), ob::TemporalFilter::getDiffScaleRange(), ob::NoiseRemovalFilter::getDispDiffRange(), ob::SpatialAdvancedFilter::getDispDiffRange(), ob::SpatialModerateFilter::getDispDiffRange(), ob::HoleFillingFilter::getFilterMode(), ob::EdgeNoiseRemovalFilter::getFilterParams(), ob::LutNoiseRemovalFilter::getFilterParams(), ob::MgcNoiseRemovalFilter::getFilterParams(), ob::NoiseRemovalFilter::getFilterParams(), ob::SpatialAdvancedFilter::getFilterParams(), ob::SpatialFastFilter::getFilterParams(), ob::SpatialModerateFilter::getFilterParams(), ob::FalsePositiveFilter::getfpebfMinBleedLengthRange(), ob::FalsePositiveFilter::getfpebfROIMaxXRatioRange(), ob::FalsePositiveFilter::getfpebfROIMaxYRatioRange(), ob::FalsePositiveFilter::getfpebfROIMinXRatioRange(), ob::FalsePositiveFilter::getfpebfROIMinYRatioRange(), ob::FalsePositiveFilter::getfpEdgeBleedFilterEnableRange(), ob::FalsePositiveFilter::getfppafMaxHeightRatioRange(), ob::FalsePositiveFilter::getfppafMaxNoiseLevelRange(), ob::FalsePositiveFilter::getfppafMaxSpeckleSizeRange(), ob::FalsePositiveFilter::getfppafMaxWidthRatioRange(), ob::FalsePositiveFilter::getfppafROIMaxXRatioRange(), ob::FalsePositiveFilter::getfppafROIMaxYRatioRange(), ob::FalsePositiveFilter::getfppafROIMinXRatioRange(), ob::FalsePositiveFilter::getfppafROIMinYRatioRange(), ob::FalsePositiveFilter::getfppafScoreRange(), ob::FalsePositiveFilter::getfppafToleranceRange(), ob::FalsePositiveFilter::getfpPatternAmbiguityFilterEnableRange(), ob::FalsePositiveFilter::getfpTextureSparsityFilterEnableRange(), ob::FalsePositiveFilter::getfptsfMaxNoiseLevelRange(), ob::FalsePositiveFilter::getfptsfMaxSpeckleSizeRange(), ob::FalsePositiveFilter::getfptsfROIMaxXRatioRange(), ob::FalsePositiveFilter::getfptsfROIMaxYRatioRange(), ob::FalsePositiveFilter::getfptsfROIMinXRatioRange(), ob::FalsePositiveFilter::getfptsfROIMinYRatioRange(), ob::EdgeNoiseRemovalFilter::getHeightRange(), ob::LutNoiseRemovalFilter::getHeightRange(), ob::MgcNoiseRemovalFilter::getHeightRange(), ob::EdgeNoiseRemovalFilter::getLimitXthRange(), ob::MgcNoiseRemovalFilter::getLimitXthRange(), ob::EdgeNoiseRemovalFilter::getLimitYthRange(), ob::MgcNoiseRemovalFilter::getLimitYthRange(), ob::SpatialAdvancedFilter::getMagnitudeRange(), ob::SpatialModerateFilter::getMagnitudeRange(), ob::EdgeNoiseRemovalFilter::getMarginXthRange(), ob::MgcNoiseRemovalFilter::getMarginXthRange(), ob::EdgeNoiseRemovalFilter::getMarginYthRange(), ob::MgcNoiseRemovalFilter::getMarginYthRange(), ob::LutNoiseRemovalFilter::getMaxLutRange(), ob::MgcNoiseRemovalFilter::getMaxRadiusRange(), ob::ThresholdFilter::getMaxRange(), ob::NoiseRemovalFilter::getMaxSizeRange(), ob::MgcNoiseRemovalFilter::getMaxWidthLeftRange(), ob::MgcNoiseRemovalFilter::getMaxWidthRightRange(), ob::LutNoiseRemovalFilter::getMinDiffRange(), ob::ThresholdFilter::getMinRange(), ob::SpatialAdvancedFilter::getRadiusRange(), ob::SpatialFastFilter::getRadiusRange(), ob::SpatialModerateFilter::getRadiusRange(), ob::DecimationFilter::getScaleRange(), ob::DecimationFilter::getScaleValue(), ob::SequenceIdFilter::getSelectSequenceId(), ob::UnDistortionFilter::getStreamType(), ob::EdgeNoiseRemovalFilter::getVerticalDirectionEnableRange(), ob::TemporalFilter::getWeightRange(), ob::EdgeNoiseRemovalFilter::getWidthRange(), ob::LutNoiseRemovalFilter::getWidthRange(), and ob::MgcNoiseRemovalFilter::getWidthRange().

type()

virtual const char * ob::Filter::type ( )

inlinevirtual

Definition at line 285 of file Filter.hpp.

Referenced by is(), ob::PointCloudFilter::setCoordinateSystem(), and ob::FormatConvertFilter::setFormatConvertType().

is()

template<typename T>

bool ob::Filter::is

(

)

Check if the runtime type of the filter object is compatible with a given type.

Define the is() template function for the Filter class.

Template Parameters

T	The given type.

Returns

bool The result.

Note

When adding a new filter class, ensure the filter type map (see getFilterTypeMap()) is updated accordingly to maintain correct type matching.

Definition at line 2343 of file Filter.hpp.

Referenced by as(), and is().

as()

template<typename T>

std::shared_ptr< T > ob::Filter::as ( )

inline

Definition at line 298 of file Filter.hpp.

Member Data Documentation

impl_

ob_filter* ob::Filter::impl_ = nullptr

protected

Definition at line 79 of file Filter.hpp.

Referenced by enable(), getConfigSchema(), getConfigValue(), getImpl(), init(), isEnabled(), process(), pushFrame(), reset(), ob::Align::setAlignToStreamProfile(), setCallBack(), setConfigValue(), and ~Filter().

name_

std::string ob::Filter::name_

protected

Definition at line 80 of file Filter.hpp.

Referenced by getName(), and init().

callback_

FilterCallback ob::Filter::callback_

protected

Definition at line 81 of file Filter.hpp.

Referenced by setCallBack().

configSchemaVec_

std::vector<OBFilterConfigSchemaItem> ob::Filter::configSchemaVec_

protected

Definition at line 82 of file Filter.hpp.

Referenced by getConfigSchemaVec(), ob::PointCloudFilter::getDecimationFactorRange(), ob::DecimationFilter::getScaleRange(), and init().

---

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

• Filter.hpp