argus_nd.h

Go to the documentation of this file.

/*************************************************************************/
#ifndef ARGUS_ND_H
#define ARGUS_ND_H
#ifdef __cplusplus
extern "C" {
#endif
 
/*!***************************************************************************
 * @defgroup    argus_nd Noise Detectors
 * @ingroup     argus_api
 *
 * @brief       Noise Detectors parameter definitions and API functions.
 *
 * @details     The module contains algorithms for noise detection and is comprised
 *              of 2 sections: Saturation Detector and Optical Disturber Detector.
 *              The Saturation Detector is designed to mark as saturated the pixels
 *              that have a too high phase noise (UCNoise).
 *              The ODD is designed to exclude pixels with bad SNR values or with
 *              phase noise (UCNoise) from the final result.
 *
 * @addtogroup  argus_nd
 * @{
 *****************************************************************************/
 
#include "argus_def.h"
 
 
/*!***************************************************************************
 * @brief   Noise Detectors Parameters for Saturation Detector and for
 *          Optical Disturber Detector.
 * @details Config contains:
 *
 *            Saturation Detector:
 *             - Absolute Noise Threshold (when UCNoise is over this threshold
 *             and Amplitude is over the corresponding threshold, the
 *             pixel is marked as saturated)
 *             - Amplitude Threshold (when Amplitude is over this threshold
 *             and UCNoise is over the corresponding threshold, the
 *             pixel is marked as saturated)
 *             - UCNoise EMA Weight (for smoothing the UC Noise)
 *
 *            ODD:
 *             - Enable switch
 *             - Activation Threshold (over which Amplitude to apply the ODD)
 *             - Inclusion Threshold (over which the pixel is marked valid)
 *             - Exclusion Threshold (under which the pixel is marked invalid)
 *****************************************************************************/
typedef struct argus_cfg_noise_detectors_t
{
    struct
    {
        uq12_4_t AbsoluteNoiseThreshold;
 
        uq12_4_t AmplitudeThreshold;
 
        uq0_8_t UncorrelatedNoiseEMAWeight;
 
    } Saturation;
 
    struct
    {
        bool Enabled;
 
        uq12_4_t Activation;
 
        uq12_4_t Inclusion;
 
        uq12_4_t Exclusion;
    } ODD;
 
} argus_cfg_nd_t;
 
 
#ifdef __cplusplus
} // extern "C"
#endif
#endif /* ARGUS_ND_H */