RBRDynamicCorrection.h

Go to the documentation of this file.

 
#ifndef LIBRBR_DYNAMICCORRECTION_H
#define LIBRBR_DYNAMICCORRECTION_H
 
#include <stdint.h>
 
 
/* Define the maximum amount of lag permitted.
 * (this need to be increase for faster sampling rate).
 * DCORR_MAX_LAG_ARRAY/F_s > t_delay */
#define DCORR_MAX_LAG_ARRAY  20
 
 
/* default parameters
 * (applicable for 10cm/sec ascent/descent rate) */
 
#define DCORR_T_DELAY       0.35f
 
#define DCORR_ALPHA         0.041f
 
#define DCORR_ALPHA_A         0.00323f
 
#define DCORR_ALPHA_E         -1.03f
 
#define DCORR_TAU           8.11f
 
#define DCORR_TAU_A         4.93f
 
#define DCORR_TAU_E         -0.26f
 
#define DCORR_CT_COEFF      0.97e-2f
 
#define DCORR_CT_COEFF_A         0.00139f
 
#define DCORR_CT_COEFF_E         -1.00f
 
#define DCORR_VP_MIN      0.03f
 
#define DCORR_VP_MAX      0.45f
 
#define DCORR_VP_FC      0.04f
 
 
typedef enum
{
    RBR_DCORR_SUCCESS = 0,
    RBR_DCORR_INVALID_SAMPLING_RATE,
    RBR_DCORR_NOT_VALID_YET,
    DYN_CORR_CORRUPTED,
    DYN_CORR_BAD_PARAMS,
    DYN_CORR_UNKNOWN_ERROR
} RBRDynamicCorrectionError;
 
typedef struct
{
    float t_delay;    // time delay (sec), or C-T lag
    float Fs;         // sampling rate (Hz)
    float alpha;
    float tau;
    float CT_coeff;
    float alpha_a;    // alpha = alpha_a * powf(Vp * alpha_e)
    float alpha_e;
    float tau_a;      // tau = tau_a * powf(Vp * tau_e)
    float tau_e;
    float ctcoeff_a;  // ctcoeff = ctcoeff_a * powf(Vp * ctcoeff_e)
    float ctcoeff_e;
    float Vp_min;
    float Vp_max;
    float Vp_fc;
    // --- internal private data ---
    int32_t _firstCall;
    int32_t _isError;
    float _ascentRate;
    float _lastPressure;
    float _lastPressureTime;
    float _phi;
    float _cte_a;
    float _cte_b;
    int32_t _lagIndex;
    float _T_meas_lag;
    float _C_meas_lag;
    float _T_cond_lag;
    float _P_meas_lag;
    float _T_cor_lag;
    float _T_short_lag;
    int32_t _isValid_lagArray[DCORR_MAX_LAG_ARRAY];
    float _timestamp_lagArray[DCORR_MAX_LAG_ARRAY];
    float _C_meas_lagArray[DCORR_MAX_LAG_ARRAY];
    float _P_meas_lagArray[DCORR_MAX_LAG_ARRAY];
    float _T_cond_lagArray[DCORR_MAX_LAG_ARRAY];    
} RBRDynamicCorrectionParams;
 
typedef struct {
    float timestamp;            // Time in seconds
    float conductivity;         // Conductivity measurement (mS/cm)
    float marineTemperature;    // Marine temperature measurement (°C)
    float condTemperature;      // Temperature of conductivity cell measurement (°C)
    float pressure;             // Pressure measurement (dbar)
} RBRDynamicCorrectionMeasurement;
 
typedef struct {
    float timestamp;            // Time in seconds
    float conductivity;         // Conductivity measurement (mS/cm)
    float corrTemperature;      // Corrected temperature (°C)
    float pressure;             // Sea pressure measurement (dbar)
    float corrSalinity;         // Practical salinity after all corrections (unitless)
} RBRDynamicCorrectionResult;
 
RBRDynamicCorrectionError RBRDynamicCorrection_init(RBRDynamicCorrectionParams *params, float Fs,
                                            float t_delay, float alpha_a, float alpha_e, 
                                            float tau_a, float tau_e, float ctcoeff_a, float ctcoeff_e, 
                                            float Vp_min, float Vp_max, float Vp_fc);
 
RBRDynamicCorrectionError RBRDynamicCorrection_update_Fs(RBRDynamicCorrectionParams *params, float Fs);
 
RBRDynamicCorrectionError RBRDynamicCorrection_addMeasurement(RBRDynamicCorrectionParams *params, const RBRDynamicCorrectionMeasurement * measIn, RBRDynamicCorrectionResult * corrMeasOut);
 
 
#endif // LIBRBR_DYNAMICCORRECTION_H