radvol.h

Go to the documentation of this file.

/* --------------------------------------------------------------------
Copyright (C) 2012 Institute of Meteorology and Water Management -
National Research Institute, IMGW-PIB
 
This file is part of Radvol-QC package.
 
Radvol-QC is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
 
Radvol-QC is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.
 
You should have received a copy of the GNU Lesser General Public License
along with Radvol-QC.  If not, see <http://www.gnu.org/licenses/>.
------------------------------------------------------------------------*/
#ifndef RADVOL_H
#define RADVOL_H
#include "rave_object.h"
#include "rave_simplexml.h"
#include "polarvolume.h"
#include "polarscan.h"
#include <math.h>
 
#define QI_GOOD 1.0
#define QI_BAD 0.0
#define cNull 9999.0
#define cEer 8493
#define DEFAULT_EQUATOR_RADIUS 6378160.0
#define DEFAULT_POLE_RADIUS 6356780.0
 
typedef struct Elevation_t {
    int nbin;         
    int nray;         
    double rscale;    
    double elangle;   
    double gain;      
    double offset;    
    double nodata;    
    double undetect;  
    double* ReflElev; 
    double* QIElev;   
}Elevation_t;
 
struct _Radvol_t {
  RAVE_OBJECT_HEAD      
  Elevation_t *TabElev; 
  int nele;             
  double beamwidth;     
  double wavelength;    
  double pulselength;   
  double Eer;           
  int altitude;         
  char* name;           
  char* task_name;      
  char* task_args;      
  int QIOn;             
  int QCOn;             
  int DBZHtoTH;         
};
 
struct _Radvol_params_t {
  int    DBZHtoTH;
  int    BROAD_QIOn;
  int    BROAD_QCOn;
  double BROAD_LhQI1;
  double BROAD_LhQI0;
  double BROAD_LvQI1;
  double BROAD_LvQI0;
  double BROAD_Pulse;
  int    SPIKE_QIOn;
  int    SPIKE_QCOn;
  double SPIKE_QI;
  double SPIKE_QIUn;
  double SPIKE_ACovFrac;
  int    SPIKE_AAzim;
  int    SPIKE_AVarAzim;
  int    SPIKE_ABeam;
  int    SPIKE_AVarBeam;
  double SPIKE_AFrac;
  double SPIKE_BDiff;
  int    SPIKE_BAzim;
  double SPIKE_BFrac;
  int    NMET_QIOn;
  int    NMET_QCOn;
  double NMET_QI;
  double NMET_QIUn;
  double NMET_AReflMin;
  double NMET_AReflMax;
  double NMET_AAltMin;
  double NMET_AAltMax;
  double NMET_ADet;
  double NMET_BAlt;
  int    SPECK_QIOn;
  int    SPECK_QCOn;
  double SPECK_QI;
  double SPECK_QIUn;
  double SPECK_AGrid;
  double SPECK_ANum;
  double SPECK_AStep;
  double SPECK_BGrid;
  double SPECK_BNum;
  double SPECK_BStep;
  int    BLOCK_QIOn;
  int    BLOCK_QCOn;
  double BLOCK_MaxElev;
  double BLOCK_dBLim;
  double BLOCK_GCQI;
  double BLOCK_GCQIUn;
  double BLOCK_GCMinPbb;
  double BLOCK_PBBQIUn;
  double BLOCK_PBBMax;
  double ATT_a;
  double ATT_b;
  int    ATT_QIOn;
  int    ATT_QCOn;
  double ATT_ZRa;
  double ATT_ZRb;
  double ATT_QIUn;
  double ATT_QI1;
  double ATT_QI0;
  double ATT_Refl;
  double ATT_Last;
  double ATT_Sum;
};
 
typedef struct _Radvol_t Radvol_t;
typedef struct _Radvol_params_t Radvol_params_t;
 
extern RaveCoreObjectType Radvol_TYPE;
 
void Radvol_getName(Radvol_t* self, const char* source);
 
int Radvol_getAttrDouble_scan(PolarScan_t* scan, char* name, double* value);
 
int Radvol_getAttrDouble_pvol(PolarVolume_t* pvol, char* name, double* value);
 
int Radvol_setTaskName(Radvol_t* self, const char* task_name);
 
int Radvol_setTaskArgs(Radvol_t* self, const char* task_args);
 
int Radvol_load_scan(Radvol_t* self, PolarScan_t* scan);
 
int Radvol_load_pvol(Radvol_t* self, PolarVolume_t* pvol);
 
int Radvol_save_scan(Radvol_t* self, PolarScan_t* scan);
 
int Radvol_save_pvol(Radvol_t* self, PolarVolume_t* pvol);
 
SimpleXmlNode_t *Radvol_getFactorChild(Radvol_t* self, char* aFileName, char* aFactorName, int* IsDefault);
 
int Radvol_getParValueDouble(SimpleXmlNode_t* node, char* aParamName, double* value);
 
int Radvol_getParValueInt( SimpleXmlNode_t* node, char* aParamName, int* value); 
 
void Radvol_setEquivalentEarthRadius(Radvol_t* self, double lat);
 
double Radvol_getCurvature(Radvol_t* self, int ele, int aBin);
 
double Radvol_getLinearQuality(double x, double a, double b);
 
#endif
 
#ifndef SameValue
  #define SameValue( a, b)  ( (fabs(a - b) < 0.001) ? 1 : 0)
#endif