argus_px.h

Go to the documentation of this file.

/*************************************************************************/
#ifndef ARGUS_PX_H
#define ARGUS_PX_H
#ifdef __cplusplus
extern "C" {
#endif
 
/*!***************************************************************************
 * @addtogroup  argus_res
 * @{
 *****************************************************************************/
 
#include "argus_def.h"
 
 
#define ARGUS_AMPLITUDE_MAX     (0xFFF0U)
 
#define ARGUS_RANGE_MAX (Q9_22_MAX)
 
#define ARGUS_RANGE_MIN (Q9_22_MIN)
 
/*!***************************************************************************
 * @brief   Status flags for the evaluated pixel structure.
 *
 * @details Determines the pixel status. 0 means OK (#PIXEL_OK).
 *          - [0]: #PIXEL_OFF: Pixel was disabled and not read from the device.
 *          - [1]: #PIXEL_SAT: The pixel was saturated.
 *          - [2]: #PIXEL_BIN_EXCL: The pixel was excluded from the 1D result.
 *          - [3]: #PIXEL_INVALID: The pixel data is invalid.
 *          - [4]: #PIXEL_PREFILTERED: The was pre-filtered by static mask.
 *          - [5]: #PIXEL_NO_SIGNAL: The pixel has no valid signal.
 *          - [6]: #PIXEL_OUT_OF_SYNC: The pixel has lost signal trace.
 *          - [7]: #PIXEL_STALLED: The pixel value is stalled due to errors.
 *          .
 *****************************************************************************/
typedef 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
 
} argus_px_status_t;
 
/*!***************************************************************************
 * @brief   The evaluated measurement results per pixel.
 * @details This structure contains the evaluated data for a single pixel.\n
 *          If the amplitude is 0, the pixel is turned off or has invalid data.
 *****************************************************************************/
typedef struct argus_pixel_t
{
    q9_22_t Range;
 
    uq1_15_t Phase;
 
    uq12_4_t Amplitude;
 
    argus_px_status_t Status;
 
    int8_t RangeWindow;
 
    uq12_4_t AmplitudeRaw;
 
    uq12_4_t UncorrelatedNoise;
 
    uq12_4_t SNR;
 
} argus_pixel_t;
 
/*!***************************************************************************
 * @brief Representation of a correlation vector containing sine/cosine components.
 *****************************************************************************/
typedef struct argus_vector_t
{
    union
    {
        q15_16_t SC[2];
 
        struct
        {
            q15_16_t S;
 
            q15_16_t C;
        };
    };
} argus_vector_t;
 
#ifdef __cplusplus
} // extern "C"
#endif
#endif /* ARGUS_PX_H */