Header associated to each raw image or profile received from the camera. More...

Public Attributes
uint64_t	enabled_fields
	Bitmask telling, which optional fields of this struct are set. To check if an optional field is set, you can use BIT_IS_SET and bit defines such as FS_HEADER_PULSE_WIDTH_BIT. More...

uint32_t	reception_queue_size
	Number of point clouds in a queue inside API. If this value starts to accumulate, it is usually a sign of too slow application point cloud callback handler. Always set. More...

union {
double reception_frequency
	Frequency (in Hz) at which the API receives data. Set only if frequency calculation is enabled (default). More...

unsigned long long time_stamp
	Time stamp (in 0.1 us) at which the API receives data. Set only if frequency calculation is disabled. More...

};

uint32_t	index
	Zero-based point cloud reception index. Always set. More...

uint8_t	input_state
	HW input pin state bitmask: \| b0 \| b1 \| b2 \| b3 \| b4 \| b5 \| b6 \| b7 \|. Optional. More...

float	pulse_width
	us pulse width of the frame. Optional. More...

int32_t	location
	Generic location. Optional. More...

Detailed Description

Header associated to each raw image or profile received from the camera.

Member Data Documentation

◆ @3

union { ... }

◆ enabled_fields

uint64_t HEADER::enabled_fields

Bitmask telling, which optional fields of this struct are set. To check if an optional field is set, you can use BIT_IS_SET and bit defines such as FS_HEADER_PULSE_WIDTH_BIT.

◆ index

uint32_t HEADER::index

Zero-based point cloud reception index. Always set.

◆ input_state

uint8_t HEADER::input_state

HW input pin state bitmask: | b0 | b1 | b2 | b3 | b4 | b5 | b6 | b7 |. Optional.

◆ location

int32_t HEADER::location

Generic location. Optional.

◆ pulse_width

float HEADER::pulse_width

us pulse width of the frame. Optional.

◆ reception_frequency

double HEADER::reception_frequency

Frequency (in Hz) at which the API receives data. Set only if frequency calculation is enabled (default).

◆ reception_queue_size

uint32_t HEADER::reception_queue_size

Number of point clouds in a queue inside API. If this value starts to accumulate, it is usually a sign of too slow application point cloud callback handler. Always set.

◆ time_stamp

unsigned long long HEADER::time_stamp

Time stamp (in 0.1 us) at which the API receives data. Set only if frequency calculation is disabled.

Public Attributes