acc_detector_distance_definitions.h
Go to the documentation of this file.
1 // Copyright (c) Acconeer AB, 2022-2024
2 // All rights reserved
3
4 #ifndef ACC_DETECTOR_DISTANCE_DEFINITIONS_H_
5 #define ACC_DETECTOR_DISTANCE_DEFINITIONS_H_
6
7 #include <stdint.h>
8
9 /**
10 * @ingroup Distance
11 *
12 * @{
13 */
14
15 /**
16 * @brief The size of the result from a completed calibration update
17 */
18 #define ACC_DETECTOR_CAL_RESULT_DYNAMIC_DATA_SIZE (8U)
19
20 /**
21 * @brief The result from a completed calibration update
22 */
23 typedef struct
24 {
25 uint32_t data[ACC_DETECTOR_CAL_RESULT_DYNAMIC_DATA_SIZE / 4];
26 } acc_detector_cal_result_dynamic_t;
27
28 /**
29 * @brief Enum for peak sorting algorithms
30 */
31 typedef enum
32 {
33 /*! Return peaks with the closest detection first. */
34 ACC_DETECTOR_DISTANCE_PEAK_SORTING_CLOSEST,
35 /*! Return peaks with the peak with the highest RCS first. */
36 ACC_DETECTOR_DISTANCE_PEAK_SORTING_STRONGEST,
37 } acc_detector_distance_peak_sorting_t;
38
39 /**
40 * @brief Enum for threshold methods
41 */
42 typedef enum
43 {
44 /*! Compares processed data against a fixed amplitude value */
45 ACC_DETECTOR_DISTANCE_THRESHOLD_METHOD_FIXED_AMPLITUDE,
46 /*! Compares processed data against a fixed strength value */
47 ACC_DETECTOR_DISTANCE_THRESHOLD_METHOD_FIXED_STRENGTH,
48 /*! Compares processed data against a recorded threshold */
49 ACC_DETECTOR_DISTANCE_THRESHOLD_METHOD_RECORDED,
50 /*! Uses the CFAR algorithm as a threshold */
51 ACC_DETECTOR_DISTANCE_THRESHOLD_METHOD_CFAR
52 } acc_detector_distance_threshold_method_t;
53
54 /**
55 * @brief Enum for reflector shapes
56 */
57 typedef enum
58 {
59 /*! Use a generic reflector shape for RCS calculation */
60 ACC_DETECTOR_DISTANCE_REFLECTOR_SHAPE_GENERIC,
61 /*! Use a planar reflector shape for RCS calculation */
62 ACC_DETECTOR_DISTANCE_REFLECTOR_SHAPE_PLANAR,
63 } acc_detector_distance_reflector_shape_t;
64
65 /**
66 * @}
67 */
68
69 #endif
acc_detector_distance_threshold_method_t
acc_detector_distance_threshold_method_t
Enum for threshold methods.
Definition: acc_detector_distance_definitions.h:42
ACC_DETECTOR_DISTANCE_THRESHOLD_METHOD_FIXED_AMPLITUDE
@ ACC_DETECTOR_DISTANCE_THRESHOLD_METHOD_FIXED_AMPLITUDE
Definition: acc_detector_distance_definitions.h:45
ACC_DETECTOR_DISTANCE_PEAK_SORTING_STRONGEST
@ ACC_DETECTOR_DISTANCE_PEAK_SORTING_STRONGEST
Definition: acc_detector_distance_definitions.h:36
ACC_DETECTOR_CAL_RESULT_DYNAMIC_DATA_SIZE
#define ACC_DETECTOR_CAL_RESULT_DYNAMIC_DATA_SIZE
The size of the result from a completed calibration update.
Definition: acc_detector_distance_definitions.h:18
acc_detector_distance_reflector_shape_t
acc_detector_distance_reflector_shape_t
Enum for reflector shapes.
Definition: acc_detector_distance_definitions.h:57
acc_detector_cal_result_dynamic_t
The result from a completed calibration update.
Definition: acc_detector_distance_definitions.h:23
ACC_DETECTOR_DISTANCE_REFLECTOR_SHAPE_PLANAR
@ ACC_DETECTOR_DISTANCE_REFLECTOR_SHAPE_PLANAR
Definition: acc_detector_distance_definitions.h:62
ACC_DETECTOR_DISTANCE_THRESHOLD_METHOD_FIXED_STRENGTH
@ ACC_DETECTOR_DISTANCE_THRESHOLD_METHOD_FIXED_STRENGTH
Definition: acc_detector_distance_definitions.h:47
ACC_DETECTOR_DISTANCE_THRESHOLD_METHOD_CFAR
@ ACC_DETECTOR_DISTANCE_THRESHOLD_METHOD_CFAR
Definition: acc_detector_distance_definitions.h:51
acc_detector_distance_peak_sorting_t
acc_detector_distance_peak_sorting_t
Enum for peak sorting algorithms.
Definition: acc_detector_distance_definitions.h:31
ACC_DETECTOR_DISTANCE_THRESHOLD_METHOD_RECORDED
@ ACC_DETECTOR_DISTANCE_THRESHOLD_METHOD_RECORDED
Definition: acc_detector_distance_definitions.h:49
ACC_DETECTOR_DISTANCE_PEAK_SORTING_CLOSEST
@ ACC_DETECTOR_DISTANCE_PEAK_SORTING_CLOSEST
Definition: acc_detector_distance_definitions.h:34
ACC_DETECTOR_DISTANCE_REFLECTOR_SHAPE_GENERIC
@ ACC_DETECTOR_DISTANCE_REFLECTOR_SHAPE_GENERIC
Definition: acc_detector_distance_definitions.h:60