Intel® RealSense™ Cross Platform API
Intel Realsense Cross-platform API
Public Member Functions | Friends | List of all members
rs2::temporal_filter Class Reference

#include <rs_processing.hpp>

Inheritance diagram for rs2::temporal_filter:
rs2::filter rs2::processing_block rs2::filter_interface rs2::options

Public Member Functions

 temporal_filter ()
 
 temporal_filter (float smooth_alpha, float smooth_delta, int persistence_control)
 
 temporal_filter (filter f)
 
- Public Member Functions inherited from rs2::filter
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
 

Friends

class context
 

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)
 
- Protected Attributes inherited from rs2::filter
frame_queue _queue
 
- Protected Attributes inherited from rs2::processing_block
std::shared_ptr< rs2_processing_block_block
 

Constructor & Destructor Documentation

◆ temporal_filter() [1/3]

rs2::temporal_filter::temporal_filter ( )
inline

Create temporal filter with default settings Temporal filter smooths the image by calculating multiple frames with alpha and delta settings alpha defines the weight of current frame, and delta defines the threshold for edge classification and preserving. For more information, check the temporal-filter.cpp

◆ temporal_filter() [2/3]

rs2::temporal_filter::temporal_filter ( float  smooth_alpha,
float  smooth_delta,
int  persistence_control 
)
inline

Create temporal filter with user settings Temporal filter smooths the image by calculating multiple frames with alpha and delta settings

Parameters
[in]smooth_alpha- defines the weight of current frame.
[in]smooth_delta- delta defines the threshold for edge classification and preserving.
[in]persistence_control- A set of predefined rules (masks) that govern when missing pixels will be replaced with the last valid value so that the data will remain persistent over time: 0 - Disabled - Persistency filter is not activated and no hole filling occurs. 1 - Valid in 8/8 - Persistency activated if the pixel was valid in 8 out of the last 8 frames 2 - Valid in 2/last 3 - Activated if the pixel was valid in two out of the last 3 frames 3 - Valid in 2/last 4 - Activated if the pixel was valid in two out of the last 4 frames 4 - Valid in 2/8 - Activated if the pixel was valid in two out of the last 8 frames 5 - Valid in 1/last 2 - Activated if the pixel was valid in one of the last two frames 6 - Valid in 1/last 5 - Activated if the pixel was valid in one out of the last 5 frames 7 - Valid in 1/last 8 - Activated if the pixel was valid in one out of the last 8 frames 8 - Persist Indefinitely - Persistency will be imposed regardless of the stored history(most aggressive filtering) For more information, check temporal-filter.cpp

◆ temporal_filter() [3/3]

rs2::temporal_filter::temporal_filter ( filter  f)
inline

Friends And Related Function Documentation

◆ context

friend class context
friend

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