Public Member Functions | Protected Member Functions | Private Member Functions | Friends | List of all members
rs2::align Class Reference

#include <rs_processing.hpp>

Inheritance diagram for rs2::align:
Inheritance graph

Public Member Functions

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

Protected Member Functions

 align (std::shared_ptr< rs2_processing_block > block)
- 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
template<class T >
optionsoperator= (const T &dev)
 options (rs2_options *o=nullptr)

Private Member Functions

std::shared_ptr< rs2_processing_blockinit (rs2_stream align_to)


class context

Additional Inherited Members

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

Detailed Description

Auxiliary processing block that performs image alignment using depth data and camera calibration

Definition at line 664 of file rs_processing.hpp.

Constructor & Destructor Documentation

rs2::align::align ( rs2_stream  align_to)

Create align filter Alignment is performed between a depth image and another image. To perform alignment of a depth image to the other, set the align_to parameter with the other stream type. To perform alignment of a non depth image to a depth image, set the align_to parameter to RS2_STREAM_DEPTH. Camera calibration and frame's stream type are determined on the fly, according to the first valid frameset passed to process().

[in]align_toThe stream type to which alignment should be made.

Definition at line 676 of file rs_processing.hpp.

rs2::align::align ( std::shared_ptr< rs2_processing_block block)

Definition at line 692 of file rs_processing.hpp.

Member Function Documentation

std::shared_ptr<rs2_processing_block> rs2::align::init ( rs2_stream  align_to)

Definition at line 696 of file rs_processing.hpp.

frameset rs2::align::process ( frameset  frames)

Run the alignment process on the given frames to get an aligned set of frames

[in]framesA set of frames, where at least one of which is a depth frame
Input frames aligned to one another

Definition at line 686 of file rs_processing.hpp.

Friends And Related Function Documentation

friend class context

Definition at line 695 of file rs_processing.hpp.

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

Author(s): Sergey Dorodnicov , Doron Hirshberg , Mark Horn , Reagan Lopez , Itay Carpis
autogenerated on Mon May 3 2021 02:50:40