argus_res.h

Go to the documentation of this file.

/*************************************************************************/
#ifndef ARGUS_RES_H
#define ARGUS_RES_H
#ifdef __cplusplus
extern "C" {
#endif
 
/*!***************************************************************************
 * @defgroup    argus_res Measurement Data
 * @ingroup     argus_api
 *
 * @brief       Measurement results data structures.
 *
 * @details     The interface defines all data structures that correspond to
 *              the AFBR-S50 measurement results, e.g.
 *                  - 1D distance and amplitude values,
 *                  - 3D distance and amplitude values (i.e. per pixel),
 *                  - Auxiliary channel measurement results (VDD, IAPD, temperature, ...)
 *                  - Device and result status
 *                  - ...
 *                  .
 *
 * @addtogroup  argus_res
 * @{
 *****************************************************************************/
 
#include "argus_px.h"
#include "argus_def.h"
#include "argus_meas.h"
#include "argus_xtalk.h"
 
/*!***************************************************************************
 * @brief   The 1d measurement results data structure.
 * @details The 1d measurement results obtained by the Pixel Binning Algorithm.
 *****************************************************************************/
typedef struct argus_results_bin_t
{
    q9_22_t Range;
 
    uq12_4_t Amplitude;
 
    uint8_t SignalQuality;
 
} argus_results_bin_t;
 
/*!***************************************************************************
 * @brief   The auxiliary measurement results data structure.
 * @details The auxiliary measurement results obtained by the auxiliary task.\n
 *          Special values, i.e. 0xFFFFU, indicate no readout value available.
 *****************************************************************************/
typedef struct argus_results_aux_t
{
    uq12_4_t VDD;
 
    q11_4_t TEMP;
 
    uq12_4_t VSUB;
 
    uq12_4_t VDDL;
 
    uq12_4_t IAPD;
 
    uq12_4_t BGL;
 
    uq12_4_t SNA;
 
} argus_results_aux_t;
 
/*!***************************************************************************
 * @brief   The debug data of measurement results data structure.
 * @details This data structure will be filled with API internal data for
 *          debugging purposes.
 *****************************************************************************/
typedef struct argus_results_debug_t
{
    uq12_4_t DCAAmplitude;
 
    uint32_t Data[ARGUS_RAW_DATA_VALUES];
 
    xtalk_t XtalkPredictor[ARGUS_PIXELS_Y / 2U];
 
    xtalk_t XtalkMonitor[ARGUS_PIXELS_Y];
 
} argus_results_debug_t;
 
/*!***************************************************************************
 * @brief   The measurement results data structure.
 * @details This structure contains all information obtained by a single
 *          distance measurement on the device:
 *           - The measurement status can be read from the #Status.
 *           - A timing information is given via the #TimeStamp.
 *           - Information about the frame state is in the #Frame structure.
 *           - The 1D distance results are gathered under #Bin.
 *           - The 3D distance results for each pixel is at #Pixels or #Pixel.
 *           - Auxiliary values such as temperature can be found at #Auxiliary.
 *           - Raw data and debug information from the device and API is stored
 *             in the optional #Debug data structure. Note that this points to
 *             an optional structure and can be null!
 *           .
 *
 *          The pixel x-y orientation is sketched in the following graph. Note that
 *          the laser source would be on the right side beyond the reference pixel.
 *          See also \link argus_map ADC Channel Mapping\endlink
 * @code
 *          // Pixel Field: Pixel[x][y]
 *          //
 *          // 0  -----------> x
 *          // |  O O O O O O O O
 *          // |   O O O O O O O O
 *          // |  O O O O O O O O          O (ref. Px)
 *          // y   O O O O O O O O
 * @endcode
 *****************************************************************************/
typedef struct argus_results_t
{
    status_t Status;
 
    ltc_t TimeStamp;
 
    argus_meas_frame_t Frame;
 
    union
    {
        argus_pixel_t Pixels[ARGUS_PIXELS + 1U];
 
        struct
        {
            argus_pixel_t Pixel[ARGUS_PIXELS_X][ARGUS_PIXELS_Y];
 
            argus_pixel_t PixelRef;
        };
    };
 
    argus_results_bin_t Bin;
 
    argus_results_aux_t Auxiliary;
 
    argus_results_debug_t * Debug;
 
} argus_results_t;
 
 
#ifdef __cplusplus
} // extern "C"
#endif
#endif /* ARGUS_RES_H */