RAVE
rave_gra.h
Go to the documentation of this file.
1/* --------------------------------------------------------------------
2Copyright (C) 2014 Swedish Meteorological and Hydrological Institute, SMHI,
3
4This file is part of RAVE.
5
6RAVE is free software: you can redistribute it and/or modify
7it under the terms of the GNU Lesser General Public License as published by
8the Free Software Foundation, either version 3 of the License, or
9(at your option) any later version.
10
11RAVE is distributed in the hope that it will be useful,
12but WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU Lesser General Public License for more details.
15
16You should have received a copy of the GNU Lesser General Public License
17along with RAVE. If not, see <http://www.gnu.org/licenses/>.
18------------------------------------------------------------------------*/
42#ifndef RAVE_GRA_H
43#define RAVE_GRA_H
44#include "rave_object.h"
45#include "rave_field.h"
46#include "cartesianparam.h"
47
51typedef struct _RaveGra_t RaveGra_t;
52
57
63void RaveGra_setA(RaveGra_t* self, double A);
64
70double RaveGra_getA(RaveGra_t* self);
71
77void RaveGra_setB(RaveGra_t* self, double B);
78
84double RaveGra_getB(RaveGra_t* self);
85
91void RaveGra_setC(RaveGra_t* self, double C);
92
98double RaveGra_getC(RaveGra_t* self);
99
105void RaveGra_setUpperThreshold(RaveGra_t* self, double threshold);
106
113
119void RaveGra_setLowerThreshold(RaveGra_t* self, double threshold);
120
127
133void RaveGra_setZRA(RaveGra_t* self, double zrA);
134
140double RaveGra_getZRA(RaveGra_t* self);
141
147void RaveGra_setZRB(RaveGra_t* self, double zrb);
148
154double RaveGra_getZRB(RaveGra_t* self);
155
166
167#endif /* RAVE_GRA_H */
Defines the functions available when working with a cartesian field.
Generic field that only provides a 2-dim data field and a number of dynamic attributes.
void RaveGra_setA(RaveGra_t *self, double A)
Sets the A coefficient in the formula A + B*DIST + C*pow(DIST, 2.0);.
Definition rave_gra.c:121
void RaveGra_setZRB(RaveGra_t *self, double zrb)
Sets the ZR B coefficient when converting from reflectivity to MM/H.
Definition rave_gra.c:193
double RaveGra_getZRA(RaveGra_t *self)
Returns the ZR A coefficient.
Definition rave_gra.c:187
void RaveGra_setB(RaveGra_t *self, double B)
Sets the B coefficient in the formula A + B*DIST + C*pow(DIST, 2.0);.
Definition rave_gra.c:133
void RaveGra_setC(RaveGra_t *self, double C)
Sets the C coefficient in the formula A + B*DIST + C*pow(DIST, 2.0);.
Definition rave_gra.c:145
double RaveGra_getUpperThreshold(RaveGra_t *self)
Returns the upper threshold.
Definition rave_gra.c:163
double RaveGra_getC(RaveGra_t *self)
Returns the C coefficient.
Definition rave_gra.c:151
void RaveGra_setZRA(RaveGra_t *self, double zrA)
Sets the ZR A coefficient when converting from reflectivity to MM/H;.
Definition rave_gra.c:181
RaveCoreObjectType RaveGra_TYPE
Type definition to use when creating a rave object.
Definition rave_gra.c:314
double RaveGra_getB(RaveGra_t *self)
Returns the B coefficient.
Definition rave_gra.c:139
double RaveGra_getA(RaveGra_t *self)
Returns the A coefficient.
Definition rave_gra.c:127
CartesianParam_t * RaveGra_apply(RaveGra_t *self, RaveField_t *distance, CartesianParam_t *parameter)
Applies the coefficients on the parameter field.
Definition rave_gra.c:254
double RaveGra_getZRB(RaveGra_t *self)
Returns the ZR b coefficient.
Definition rave_gra.c:199
void RaveGra_setUpperThreshold(RaveGra_t *self, double threshold)
Sets the upper threshold in 10ths of dBR.
Definition rave_gra.c:157
double RaveGra_getLowerThreshold(RaveGra_t *self)
Returns the lower threshold.
Definition rave_gra.c:175
void RaveGra_setLowerThreshold(RaveGra_t *self, double threshold)
Sets the lower threshold in 10ths of dBR.
Definition rave_gra.c:169
Generic implementation of an object that is used within rave.
Represents the cartesian field product.
Definition cartesianparam.c:40
Represents the cartesian volume.
Definition rave_field.c:36
Represents the gra applier.
Definition rave_gra.c:53
double zrA
the ZR A coefficient when converting from reflectivity to MM/H
Definition rave_gra.c:60
double zrb
the ZR b coefficient when converting from reflectivity to MM/H
Definition rave_gra.c:61
double B
B - Coefficient.
Definition rave_gra.c:56
RAVE_OBJECT_HEAD double A
Always on top.
Definition rave_gra.c:55
double C
C - Coefficient.
Definition rave_gra.c:57
The rave object type definition.
Definition rave_object.h:52