Intel® RealSense™ Cross Platform API
Intel Realsense Cross-platform API
Loading...
Searching...
No Matches
rs2::filter Class Reference

#include <rs_processing.hpp>

Inheritance diagram for rs2::filter:
rs2::processing_block rs2::filter_interface rs2::options rs2::align rs2::colorizer rs2::decimation_filter rs2::depth_huffman_decoder rs2::disparity_transform rs2::gl::camera_renderer rs2::gl::pointcloud_renderer rs2::gl::uploader rs2::hdr_merge rs2::hole_filling_filter rs2::pointcloud rs2::rates_printer rs2::rotation_filter rs2::save_single_frameset rs2::save_to_ply rs2::sequence_id_filter rs2::spatial_filter rs2::temporal_filter rs2::threshold_filter rs2::units_transform rs2::y411_decoder rs2::yuy_decoder

Public Member Functions

rs2::frame process (rs2::frame frame) const override
 filter (std::shared_ptr< rs2_processing_block > block, int queue_size=1)
template<class S>
 filter (S processing_function, int queue_size=1)
frame_queue get_queue ()
rs2_processing_blockget () const
template<class T>
bool is () const
template<class T>
as () const
 operator bool () const
Public Member Functions inherited from rs2::processing_block
template<class S>
void start (S on_frame)
template<class S>
S & operator>> (S &on_frame)
void invoke (frame f) const
 processing_block (std::shared_ptr< rs2_processing_block > block)
template<class S>
 processing_block (S processing_function)
 operator rs2_options * () const
rs2_processing_blockget () const
bool supports (rs2_camera_info info) const
const char * get_info (rs2_camera_info info) const
bool supports (rs2_option option) const
Public Member Functions inherited from rs2::options
bool supports (rs2_option option) const
const char * get_option_description (rs2_option option) const
const char * get_option_name (rs2_option option) const
const char * get_option_value_description (rs2_option option, float val) const
float get_option (rs2_option option) const
option_value get_option_value (rs2_option option_id) const
option_range get_option_range (rs2_option option) const
void set_option (rs2_option option, float value) const
void set_option_value (option_value const &value) const
bool is_option_read_only (rs2_option option) const
void on_options_changed (std::function< void(const options_list &) > callback) const
std::vector< rs2_optionget_supported_options ()
options_list get_supported_option_values ()
optionsoperator= (const options &other)
 options (const options &other)
virtual ~options ()=default
Public Member Functions inherited from rs2::filter_interface
virtual ~filter_interface ()=default

Protected Attributes

frame_queue _queue
Protected Attributes inherited from rs2::processing_block
std::shared_ptr< rs2_processing_block_block

Additional Inherited Members

Protected Member Functions inherited from rs2::processing_block
void register_simple_option (rs2_option option_id, option_range range)
Protected Member Functions inherited from rs2::options
 options (rs2_options *o=nullptr)
template<class T>
optionsoperator= (const T &dev)

Detailed Description

Define the filter workflow, inherit this class to generate your own filter. Refer to the viewer class in examples.hpp for a more detailed example.

Constructor & Destructor Documentation

◆ filter() [1/2]

rs2::filter::filter ( std::shared_ptr< rs2_processing_block > block,
int queue_size = 1 )
inline

constructor with already created low level processing block assigned.

Parameters
[in]block- low level rs2_processing_block created before.

◆ filter() [2/2]

template<class S>
rs2::filter::filter ( S processing_function,
int queue_size = 1 )
inline

constructor with callback function on_frame in rs2_frame_processor_callback structure assigned.

Parameters
[in]processing_function- function pointer of on_frame function in rs2_frame_processor_callback structure, which will be called back by invoke function .

Member Function Documentation

◆ as()

template<class T>
T rs2::filter::as ( ) const
inline

◆ get()

rs2_processing_block * rs2::filter::get ( ) const
inline

◆ get_queue()

frame_queue rs2::filter::get_queue ( )
inline

◆ is()

template<class T>
bool rs2::filter::is ( ) const
inline

◆ operator bool()

rs2::filter::operator bool ( ) const
inline

◆ process()

rs2::frame rs2::filter::process ( rs2::frame frame) const
inlineoverridevirtual

Ask processing block to process the frame and poll the processed frame from internal queue

Parameters
[in]on_frameframe to be processed. return processed frame

Implements rs2::filter_interface.

Member Data Documentation

◆ _queue

frame_queue rs2::filter::_queue
protected

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