ppc_radar_options.h

Go to the documentation of this file.

/* --------------------------------------------------------------------
Copyright (C) 2019 Swedish Meteorological and Hydrological Institute, SMHI,
 
This file is part of baltrad-ppc.
 
baltrad-ppc 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.
 
baltrad-ppc 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 baltrad-ppc.  If not, see <http://www.gnu.org/licenses/>.
------------------------------------------------------------------------*/
#ifndef PPC_RADAR_OPTIONS_H
#define PPC_RADAR_OPTIONS_H
 
#include "polarvolume.h"
#include "rave_data2d.h"
typedef struct _PpcRadarOptions_t PpcRadarOptions_t;
 
extern RaveCoreObjectType PpcRadarOptions_TYPE;
 
 
#define PpcRadarOptions_TH_CORR        (1)       
#define PpcRadarOptions_ATT_TH_CORR    (1 << 1)  
#define PpcRadarOptions_DBZH_CORR      (1 << 2)  
#define PpcRadarOptions_ATT_DBZH_CORR  (1 << 3)  
#define PpcRadarOptions_KDP_CORR       (1 << 4)  
#define PpcRadarOptions_RHOHV_CORR     (1 << 5)  
#define PpcRadarOptions_PHIDP_CORR     (1 << 6)  
#define PpcRadarOptions_ZDR_CORR       (1 << 7)  
#define PpcRadarOptions_ZPHI_CORR      (1 << 8)  
#define PpcRadarOptions_QUALITY_RESIDUAL_CLUTTER_MASK (1 << 9) 
#define PpcRadarOptions_QUALITY_ATTENUATION_MASK (1 << 10) 
#define PpcRadarOptions_QUALITY_ATTENUATION (1 << 11) 
#define PpcRadarOptions_ATT_ZDR_CORR   (1 << 12) 
int PpcRadarOptions_setName(PpcRadarOptions_t* self, const char* name);
 
const char* PpcRadarOptions_getName(PpcRadarOptions_t* self);
 
int PpcRadarOptions_setDefaultName(PpcRadarOptions_t* self, const char* name);
 
const char* PpcRadarOptions_getDefaultName(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setRequestedFields(PpcRadarOptions_t* self, int fieldmask);
 
int PpcRadarOptions_getRequestedFields(PpcRadarOptions_t* self);
 
int PpcRadarOptions_setBand(PpcRadarOptions_t* self, char band);
 
void PpcRadarOptions_setKdpUp(PpcRadarOptions_t* self, double v);
 
double PpcRadarOptions_getKdpUp(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setKdpDown(PpcRadarOptions_t* self, double v);
 
double PpcRadarOptions_getKdpDown(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setKdpStdThreshold(PpcRadarOptions_t* self, double v);
 
double PpcRadarOptions_getKdpStdThreshold(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setBB(PpcRadarOptions_t* self, double v);
 
double PpcRadarOptions_getBB(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setThresholdPhidp(PpcRadarOptions_t* self, double v);
 
double PpcRadarOptions_getThresholdPhidp(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setMinWindow(PpcRadarOptions_t* self, long window);
 
long PpcRadarOptions_getMinWindow(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setPdpRWin1(PpcRadarOptions_t* self, double v);
 
double PpcRadarOptions_getPdpRWin1(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setPdpRWin2(PpcRadarOptions_t* self, double v);
 
double PpcRadarOptions_getPdpRWin2(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setPdpNrIterations(PpcRadarOptions_t* self, long v);
 
long PpcRadarOptions_getPdpNrIterations(PpcRadarOptions_t* self);
 
int PpcRadarOptions_setBand(PpcRadarOptions_t* self, char band);
 
void PpcRadarOptions_getParametersUZ(PpcRadarOptions_t* self, double* weight, double* X2, double* X3, double* delta1, double* delta2);
 
void PpcRadarOptions_setParametersUZ(PpcRadarOptions_t* self, double weight, double X2, double X3, double delta1, double delta2);
 
void PpcRadarOptions_getParametersVEL(PpcRadarOptions_t* self, double* weight, double* X2, double* X3, double* delta1, double* delta2);
 
void PpcRadarOptions_setParametersVEL(PpcRadarOptions_t* self, double weight, double X2, double X3, double delta1, double delta2);
 
void PpcRadarOptions_getParametersTEXT_PHIDP(PpcRadarOptions_t* self, double* weight, double* X2, double* X3, double* delta1, double* delta2);
 
void PpcRadarOptions_setParametersTEXT_PHIDP(PpcRadarOptions_t* self, double weight, double X2, double X3, double delta1, double delta2);
 
void PpcRadarOptions_getParametersRHV(PpcRadarOptions_t* self, double* weight, double* X2, double* X3, double* delta1, double* delta2);
 
void PpcRadarOptions_setParametersRHV(PpcRadarOptions_t* self, double weight, double X2, double X3, double delta1, double delta2);
 
void PpcRadarOptions_getParametersTEXT_UZ(PpcRadarOptions_t* self, double* weight, double* X2, double* X3, double* delta1, double* delta2);
 
void PpcRadarOptions_setParametersTEXT_UZ(PpcRadarOptions_t* self, double weight, double X2, double X3, double delta1, double delta2);
 
void PpcRadarOptions_getParametersCLUTTER_MAP(PpcRadarOptions_t* self, double* weight, double* X2, double* X3, double* delta1, double* delta2);
 
void PpcRadarOptions_setParametersCLUTTER_MAP(PpcRadarOptions_t* self, double weight, double X2, double X3, double delta1, double delta2);
 
void PpcRadarOptions_setMeltingLayerBottomHeight(PpcRadarOptions_t* self, double height);
 
double PpcRadarOptions_getMeltingLayerBottomHeight(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setMeltingLayerHourThreshold(PpcRadarOptions_t* self, long hours);
 
long PpcRadarOptions_getMeltingLayerHourThreshold(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setNodata(PpcRadarOptions_t* self, double nodata);
 
double PpcRadarOptions_getNodata(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setMinDBZ(PpcRadarOptions_t* self, double minv);
 
double PpcRadarOptions_getMinDBZ(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setQualityThreshold(PpcRadarOptions_t* self, double minv);
 
double PpcRadarOptions_getQualityThreshold(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setPreprocessZThreshold(PpcRadarOptions_t* self, double minv);
 
double PpcRadarOptions_getPreprocessZThreshold(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setResidualMinZClutterThreshold(PpcRadarOptions_t* self, double minv);
 
double PpcRadarOptions_getResidualMinZClutterThreshold(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setResidualThresholdZ(PpcRadarOptions_t* self, double minv);
 
double PpcRadarOptions_getResidualThresholdZ(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setResidualThresholdTexture(PpcRadarOptions_t* self, double minv);
 
double PpcRadarOptions_getResidualThresholdTexture(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setResidualClutterNodata(PpcRadarOptions_t* self, double v);
 
double PpcRadarOptions_getResidualClutterNodata(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setResidualClutterMaskNodata(PpcRadarOptions_t* self, double v);
 
double PpcRadarOptions_getResidualClutterMaskNodata(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setResidualClutterTextureFilteringMaxZ(PpcRadarOptions_t* self, double v);
 
double PpcRadarOptions_getResidualClutterTextureFilteringMaxZ(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setResidualFilterBinSize(PpcRadarOptions_t* self, long v);
 
long PpcRadarOptions_getResidualFilterBinSize(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setResidualFilterRaySize(PpcRadarOptions_t* self, long v);
 
long PpcRadarOptions_getResidualFilterRaySize(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setMinZMedfilterThreshold(PpcRadarOptions_t* self, double v);
 
double PpcRadarOptions_getMinZMedfilterThreshold(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setProcessingTextureThreshold(PpcRadarOptions_t* self, double v);
 
double PpcRadarOptions_getProcessingTextureThreshold(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setMinAttenuationMaskRHOHV(PpcRadarOptions_t* self, double v);
 
double PpcRadarOptions_getMinAttenuationMaskRHOHV(PpcRadarOptions_t* self);
void PpcRadarOptions_setMinAttenuationMaskKDP(PpcRadarOptions_t* self, double v);
 
double PpcRadarOptions_getMinAttenuationMaskKDP(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setMinAttenuationMaskTH(PpcRadarOptions_t* self, double v);
 
double PpcRadarOptions_getMinAttenuationMaskTH(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setAttenuationGammaH(PpcRadarOptions_t* self, double v);
 
double PpcRadarOptions_getAttenuationGammaH(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setAttenuationAlpha(PpcRadarOptions_t* self, double v);
 
double PpcRadarOptions_getAttenuationAlpha(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setAttenuationPIAminZ(PpcRadarOptions_t* self, double v);
 
double PpcRadarOptions_getAttenuationPIAminZ(PpcRadarOptions_t* self);
 
void PpcRadarOptions_setInvertPHIDP(PpcRadarOptions_t* self, int v);
 
int PpcRadarOptions_getInvertPHIDP(PpcRadarOptions_t* self);
 
#endif /* PPC_RADAR_OPTIONS_H_ */