Time-of-Flight Library(ToF) 3.11.1
 
chronoptics::tof::Data Class Reference

This is the class that contains depth or image data. More...

#include <data.hpp>

+ Inheritance diagram for chronoptics::tof::Data:

Public Member Functions

 Data (tof_data_t ptr=nullptr)
 Construct from pointer.
 
void * data () const
 Get pointer to data.
 
size_t size () const
 Get size of the data.
 
uint64_t get_user_data () const
 Get user data that will get saved to csf file.
 
void set_user_data (uint64_t user_data)
 Set user data that will get saved to csf file.
 
MatType mat_type () const
 Get the matrix type.
 
int32_t rows () const
 Get the number of rows.
 
int32_t cols () const
 Get the number of columns.
 
uint16_t frame_count () const
 The frame counter.
 
FrameType frame_type () const
 Get the frame type.
 
uint32_t frame_id () const
 Get the frame id.
 
float modulation_frequency () const
 Get the modulation frequency of the frame.
 
uint32_t integration_time () const
 Get the integration time of the frame.
 
uint32_t process () const
 Get a bit array of the processing performed on the frame.
 
float scale () const
 Get the scale used for integer frames, to get the original value divide by scale.
 
float addition () const
 Get the addition used for integer frames, to get the original value substract the addition.
 
std::vector< float > temperatures () const
 Get the temperature of various parts of the camera.
 
uint8_t sync_count () const
 Get the synchronization count.
 
bool user_allocated () const
 Check whether the data uses a pointer supplied by the user.
 
void * user_pointer () const
 The user data that was given in the add_user_pointer function.
 
std::array< int16_t, 3 > acceleration () const
 The acceleration measured by the imu.
 
std::array< int16_t, 3 > angular_velocity () const
 The angular velocity measured by the imu.
 
template<typename T >
const T & at (size_t pos) const
 Get the data at location p, templated because the data type can differ.
 
template<typename T >
T & at (size_t pos)
 Get the data at location p, templated because the data type can differ.
 
template<typename T >
const T * begin () const
 Return iterator to beginning, templated because the data type can differ.
 
template<typename T >
T * begin ()
 Return iterator to beginning, templated because the data type can differ.
 
template<typename T >
const T * end () const
 Return iterator to end, templated because the data type can differ.
 
template<typename T >
T * end ()
 Return iterator to end, templated because the data type can differ.
 

Detailed Description

This is the class that contains depth or image data.

Definition at line 31 of file data.hpp.

Constructor & Destructor Documentation

◆ Data()

chronoptics::tof::Data::Data ( tof_data_t  ptr = nullptr)
inline

Construct from pointer.

Definition at line 34 of file data.hpp.

Member Function Documentation

◆ acceleration()

std::array< int16_t, 3 > chronoptics::tof::Data::acceleration ( ) const
inline

The acceleration measured by the imu.

Returns
Acceleration, x y z

Definition at line 179 of file data.hpp.

References data().

◆ addition()

float chronoptics::tof::Data::addition ( ) const
inline

Get the addition used for integer frames, to get the original value substract the addition.

Returns
The addition

Definition at line 141 of file data.hpp.

◆ angular_velocity()

std::array< int16_t, 3 > chronoptics::tof::Data::angular_velocity ( ) const
inline

The angular velocity measured by the imu.

Returns
Angular velocity, x y z

Definition at line 189 of file data.hpp.

References data().

◆ at() [1/2]

template<typename T >
T & chronoptics::tof::Data::at ( size_t  pos)
inline

Get the data at location p, templated because the data type can differ.

Parameters
posLocation of the data to get
Returns
Data of type T

Definition at line 213 of file data.hpp.

References data().

◆ at() [2/2]

template<typename T >
const T & chronoptics::tof::Data::at ( size_t  pos) const
inline

Get the data at location p, templated because the data type can differ.

Parameters
posLocation of the data to get
Returns
Data of type T

Definition at line 203 of file data.hpp.

◆ begin() [1/2]

template<typename T >
T * chronoptics::tof::Data::begin ( )
inline

Return iterator to beginning, templated because the data type can differ.

Returns
Begin iterator to T

Definition at line 230 of file data.hpp.

References data().

◆ begin() [2/2]

template<typename T >
const T * chronoptics::tof::Data::begin ( ) const
inline

Return iterator to beginning, templated because the data type can differ.

Returns
Begin iterator to T

Definition at line 221 of file data.hpp.

◆ cols()

int32_t chronoptics::tof::Data::cols ( ) const
inline

Get the number of columns.

Returns
Number of columns

Definition at line 83 of file data.hpp.

Referenced by end().

◆ data()

void * chronoptics::tof::Data::data ( ) const
inline

Get pointer to data.

Returns

Definition at line 41 of file data.hpp.

Referenced by acceleration(), angular_velocity(), at(), begin(), and end().

◆ end() [1/2]

template<typename T >
T * chronoptics::tof::Data::end ( )
inline

Return iterator to end, templated because the data type can differ.

Returns
End iterator to T

Definition at line 247 of file data.hpp.

References cols(), data(), and rows().

◆ end() [2/2]

template<typename T >
const T * chronoptics::tof::Data::end ( ) const
inline

Return iterator to end, templated because the data type can differ.

Returns
End iterator to T

Definition at line 238 of file data.hpp.

References cols(), and rows().

◆ frame_count()

uint16_t chronoptics::tof::Data::frame_count ( ) const
inline

The frame counter.

Returns
Frame count

Definition at line 90 of file data.hpp.

◆ frame_id()

uint32_t chronoptics::tof::Data::frame_id ( ) const
inline

Get the frame id.

Returns
The frame id

Definition at line 104 of file data.hpp.

◆ frame_type()

FrameType chronoptics::tof::Data::frame_type ( ) const
inline

Get the frame type.

Returns
The frame type

Definition at line 97 of file data.hpp.

◆ get_user_data()

uint64_t chronoptics::tof::Data::get_user_data ( ) const
inline

Get user data that will get saved to csf file.

Returns
Set user data

Definition at line 55 of file data.hpp.

◆ integration_time()

uint32_t chronoptics::tof::Data::integration_time ( ) const
inline

Get the integration time of the frame.

Returns
The integration time

Definition at line 118 of file data.hpp.

◆ mat_type()

MatType chronoptics::tof::Data::mat_type ( ) const
inline

Get the matrix type.

Returns
The matrix type

Definition at line 69 of file data.hpp.

◆ modulation_frequency()

float chronoptics::tof::Data::modulation_frequency ( ) const
inline

Get the modulation frequency of the frame.

Returns
The modulation frequency

Definition at line 111 of file data.hpp.

◆ process()

uint32_t chronoptics::tof::Data::process ( ) const
inline

Get a bit array of the processing performed on the frame.

Returns
A bit array

Definition at line 125 of file data.hpp.

◆ rows()

int32_t chronoptics::tof::Data::rows ( ) const
inline

Get the number of rows.

Returns
Number of rows

Definition at line 76 of file data.hpp.

Referenced by end().

◆ scale()

float chronoptics::tof::Data::scale ( ) const
inline

Get the scale used for integer frames, to get the original value divide by scale.

Returns
The scale

Definition at line 133 of file data.hpp.

◆ set_user_data()

void chronoptics::tof::Data::set_user_data ( uint64_t  user_data)
inline

Set user data that will get saved to csf file.

Parameters
user_dataSet user data

Definition at line 62 of file data.hpp.

◆ size()

size_t chronoptics::tof::Data::size ( ) const
inline

Get size of the data.

Returns
The size

Definition at line 48 of file data.hpp.

Referenced by temperatures().

◆ sync_count()

uint8_t chronoptics::tof::Data::sync_count ( ) const
inline

Get the synchronization count.

Returns
Sync count

Definition at line 158 of file data.hpp.

◆ temperatures()

std::vector< float > chronoptics::tof::Data::temperatures ( ) const
inline

Get the temperature of various parts of the camera.

Returns
Temperatures

Definition at line 148 of file data.hpp.

References size().

◆ user_allocated()

bool chronoptics::tof::Data::user_allocated ( ) const
inline

Check whether the data uses a pointer supplied by the user.

Returns
Data allocated by user

Definition at line 165 of file data.hpp.

◆ user_pointer()

void * chronoptics::tof::Data::user_pointer ( ) const
inline

The user data that was given in the add_user_pointer function.

Returns
User pointer

Definition at line 172 of file data.hpp.