Time-of-Flight Library(ToF) 3.4.0
chronoptics::tof::Roi Class Reference

Region of interest. More...

#include <camera_config.hpp>

+ Inheritance diagram for chronoptics::tof::Roi:

Public Member Functions

 Roi (tof_roi_t ptr=nullptr)
 Construct from pointer. More...
 
int32_t sensor_rows () const
 Get the number of rows in the image sensor. More...
 
int32_t sensor_cols () const
 Get the number of columns in the image sensor. More...
 
int32_t get_row_offset () const
 Get the row offset in pixels. More...
 
void set_row_offset (int32_t row_offset)
 Set the row offset in pixels. More...
 
int32_t get_col_offset () const
 Get the column offset in pixels. More...
 
void set_col_offset (int32_t col_offset)
 Set the column offset in pixels. More...
 
int32_t get_img_rows () const
 Get the number of rows in the output image. More...
 
void set_img_rows (int32_t img_rows)
 Set the number of rows in the output image. More...
 
int32_t get_img_cols () const
 Get the number of columns in the output image. More...
 
void set_img_cols (int32_t img_cols)
 Set the number of columns in the output image. More...
 

Detailed Description

Region of interest.

Definition at line 41 of file camera_config.hpp.

Constructor & Destructor Documentation

◆ Roi()

chronoptics::tof::Roi::Roi ( tof_roi_t  ptr = nullptr)
inline

Construct from pointer.

Definition at line 44 of file camera_config.hpp.

Member Function Documentation

◆ get_col_offset()

int32_t chronoptics::tof::Roi::get_col_offset ( ) const
inline

Get the column offset in pixels.

Returns
Column offset

Definition at line 79 of file camera_config.hpp.

◆ get_img_cols()

int32_t chronoptics::tof::Roi::get_img_cols ( ) const
inline

Get the number of columns in the output image.

Returns
Image columns

Definition at line 107 of file camera_config.hpp.

◆ get_img_rows()

int32_t chronoptics::tof::Roi::get_img_rows ( ) const
inline

Get the number of rows in the output image.

Returns
Image rows

Definition at line 93 of file camera_config.hpp.

◆ get_row_offset()

int32_t chronoptics::tof::Roi::get_row_offset ( ) const
inline

Get the row offset in pixels.

Returns
Row offset

Definition at line 65 of file camera_config.hpp.

◆ sensor_cols()

int32_t chronoptics::tof::Roi::sensor_cols ( ) const
inline

Get the number of columns in the image sensor.

Returns
Number of columsn

Definition at line 58 of file camera_config.hpp.

◆ sensor_rows()

int32_t chronoptics::tof::Roi::sensor_rows ( ) const
inline

Get the number of rows in the image sensor.

Returns
Number of rows

Definition at line 51 of file camera_config.hpp.

◆ set_col_offset()

void chronoptics::tof::Roi::set_col_offset ( int32_t  col_offset)
inline

Set the column offset in pixels.

Parameters
col_offsetColumn offset

Definition at line 86 of file camera_config.hpp.

◆ set_img_cols()

void chronoptics::tof::Roi::set_img_cols ( int32_t  img_cols)
inline

Set the number of columns in the output image.

Parameters
img_colsImage columns

Definition at line 114 of file camera_config.hpp.

◆ set_img_rows()

void chronoptics::tof::Roi::set_img_rows ( int32_t  img_rows)
inline

Set the number of rows in the output image.

Parameters
img_rowsImage rows

Definition at line 100 of file camera_config.hpp.

◆ set_row_offset()

void chronoptics::tof::Roi::set_row_offset ( int32_t  row_offset)
inline

Set the row offset in pixels.

Parameters
row_offsetRow offset

Definition at line 72 of file camera_config.hpp.