ob::Align Class Reference

Align for depth to other or other to depth. More...

#include <Filter.hpp>

Inheritance diagram for ob::Align:

Public Member Functions
	Align (OBStreamType alignToStreamType)
virtual	~Align () noexcept=default
OBStreamType	getAlignToStreamType ()
void	setMatchTargetResolution (bool state)
	Sets whether the output frame resolution should match the target resolution. When enabled, the output frame resolution will be adjusted to match (same as) the target resolution. When disabled, the output frame resolution will match the original resolution while maintaining the aspect ratio of the target resolution.
void	setAlignToStreamProfile (std::shared_ptr< const StreamProfile > profile)
	Set the Align To Stream Profile.
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

Align for depth to other or other to depth.

Definition at line 413 of file Filter.hpp.

Constructor & Destructor Documentation

Align()

ob::Align::Align ( OBStreamType alignToStreamType )

inline

Definition at line 415 of file Filter.hpp.

~Align()

virtual ob::Align::~Align ( )

virtualdefaultnoexcept

Member Function Documentation

getAlignToStreamType()

OBStreamType ob::Align::getAlignToStreamType ( )

inline

Definition at line 426 of file Filter.hpp.

setMatchTargetResolution()

void ob::Align::setMatchTargetResolution ( bool state )

inline

Sets whether the output frame resolution should match the target resolution. When enabled, the output frame resolution will be adjusted to match (same as) the target resolution. When disabled, the output frame resolution will match the original resolution while maintaining the aspect ratio of the target resolution.

Parameters

state

If true, output frame resolution will match the target resolution; otherwise, it will maintain the original resolution with the target's aspect ratio.

Definition at line 440 of file Filter.hpp.

setAlignToStreamProfile()

void ob::Align::setAlignToStreamProfile ( std::shared_ptr< const StreamProfile > profile )

inline

Set the Align To Stream Profile.

It is useful when the align target stream dose not started (without any frame to get intrinsics and extrinsics).

Parameters

profile

The Align To Stream Profile.

Definition at line 450 of file Filter.hpp.

---

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

• D:/program/gitlab_repository/package/openorbbecsdkgroup/OpenOrbbecSDK/include/libobsensor/hpp/Filter.hpp