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

This class describes the different data streams coming from the camera. More...

#include <stream.hpp>

+ Inheritance diagram for chronoptics::tof::Stream:

Public Member Functions

 Stream (tof_stream_t ptr=nullptr)
 Construct from pointer.
 
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.
 

Detailed Description

This class describes the different data streams coming from the camera.

Definition at line 40 of file stream.hpp.

Constructor & Destructor Documentation

◆ Stream()

chronoptics::tof::Stream::Stream ( tof_stream_t  ptr = nullptr)
inline

Construct from pointer.

Definition at line 43 of file stream.hpp.

Member Function Documentation

◆ frame_id()

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

Get the frame id.

Returns
The frame id

Definition at line 57 of file stream.hpp.

◆ frame_type()

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

Get the frame type.

Returns
The frame type

Definition at line 50 of file stream.hpp.

◆ integration_time()

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

Get the integration time of the frame.

Returns
The integration time

Definition at line 71 of file stream.hpp.

◆ modulation_frequency()

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

Get the modulation frequency of the frame.

Returns
The modulation frequency

Definition at line 64 of file stream.hpp.

◆ process()

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

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

Returns
A bit array

Definition at line 78 of file stream.hpp.