AFBR-S50 API Reference Manual v1.5.6
AFBR-S50 Time-of-Flight Sensor SDK for Embedded Software
Loading...
Searching...
No Matches
Measurement Data

Measurement results data structures. More...

Collaboration diagram for Measurement Data:

Data Structures

struct  argus_pixel_t
 The evaluated measurement results per pixel. More...
 
struct  argus_vector_t
 Representation of a correlation vector containing sine/cosine components. More...
 
struct  argus_results_bin_t
 The 1d measurement results data structure. More...
 
struct  argus_results_aux_t
 The auxiliary measurement results data structure. More...
 
struct  argus_results_debug_t
 The debug data of measurement results data structure. More...
 
struct  argus_results_t
 The measurement results data structure. More...
 

Macros

#define ARGUS_AMPLITUDE_MAX   (0xFFF0U)
 
#define ARGUS_RANGE_MAX   (Q9_22_MAX)
 
#define ARGUS_RANGE_MIN   (Q9_22_MIN)
 

Enumerations

enum  argus_px_status_t {
  PIXEL_OK = 0 ,
  PIXEL_OFF = 1U << 0U ,
  PIXEL_SAT = 1U << 1U ,
  PIXEL_BIN_EXCL = 1U << 2U ,
  PIXEL_INVALID = 1U << 3U ,
  PIXEL_PREFILTERED = 1U << 4U ,
  PIXEL_NO_SIGNAL = 1U << 5U ,
  PIXEL_OUT_OF_SYNC = 1U << 6U ,
  PIXEL_STALLED = 1U << 7U
}
 Status flags for the evaluated pixel structure. More...
 

Detailed Description

Measurement results data structures.



The interface defines all data structures that correspond to the AFBR-S50 measurement results, e.g.

Macro Definition Documentation

◆ ARGUS_AMPLITUDE_MAX

#define ARGUS_AMPLITUDE_MAX   (0xFFF0U)

Maximum amplitude value in UQ12.4 format.

◆ ARGUS_RANGE_MAX

#define ARGUS_RANGE_MAX   (Q9_22_MAX)

Maximum range value in Q9.22 format. Also used as a special value to determine no object detected or infinity range.

◆ ARGUS_RANGE_MIN

#define ARGUS_RANGE_MIN   (Q9_22_MIN)

Minimum range value in Q9.22 format.

Enumeration Type Documentation

◆ argus_px_status_t

Status flags for the evaluated pixel structure.


Determines the pixel status. 0 means OK (PIXEL_OK).

Enumerator
PIXEL_OK 

0x00: Pixel status OK.

PIXEL_OFF 

0x01: Pixel is disabled (in hardware) and no data has been read from the device.

PIXEL_SAT 

0x02: Pixel is saturated (i.e. at least one saturation bit for any sample is set or the sample is in the invalidity area).

PIXEL_BIN_EXCL 

0x04: Pixel is excluded from the pixel binning (1d) result.

PIXEL_INVALID 

0x08: Pixel has invalid data due to miscellaneous reasons, e.g.

  • Amplitude calculates to 0 (i.e. division by 0)
  • Golden Pixel is invalid due to other saturated pixel.
  • Range/distance is negative.
PIXEL_PREFILTERED 

0x10: Pixel is pre-filtered by the static pixel binning pre-filter mask, i.e. the pixel is disabled by software.

PIXEL_NO_SIGNAL 

0x20: Pixel amplitude is below its threshold value. The received signal strength is too low to evaluate a valid signal. The range value is set to the maximum possible value (approx. 512 m).

PIXEL_OUT_OF_SYNC 

0x40: Pixel is not in sync with respect to the dual frequency algorithm. I.e. the pixel may have a correct value but is estimated into the wrong unambiguous window.

PIXEL_STALLED 

0x80: Pixel is stalled due to one of the following reasons:

A stalled pixel does not update its measurement data and keeps the previous values. If the issue is resolved, the stall disappears and the pixel is updating again.