RAVE
rave_acrr.h
Go to the documentation of this file.
1/* --------------------------------------------------------------------
2Copyright (C) 2012 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------------------------------------------------------------------------*/
25#ifndef RAVE_ACRR_H
26#define RAVE_ACRR_H
27#include "rave_object.h"
28#include "cartesianparam.h"
29
33typedef struct _RaveAcrr_t RaveAcrr_t;
34
39
45int RaveAcrr_sum(RaveAcrr_t* self, CartesianParam_t* param, double zr_a, double zr_b);
46
55CartesianParam_t* RaveAcrr_accumulate(RaveAcrr_t* self, double acpt, long N, double hours);
56
63
69void RaveAcrr_setNodata(RaveAcrr_t* self, double nodata);
70
76double RaveAcrr_getNodata(RaveAcrr_t* self);
77
83void RaveAcrr_setUndetect(RaveAcrr_t* self, double undetect);
84
91
97const char* RaveAcrr_getQuantity(RaveAcrr_t* self);
98
107int RaveAcrr_setQualityFieldName(RaveAcrr_t* self, const char* fieldname);
108
116
117#endif /* RAVE_ACRR_H */
Defines the functions available when working with a cartesian field.
void RaveAcrr_setUndetect(RaveAcrr_t *self, double undetect)
Sets the undetect to be used for the accumulation.
Definition rave_acrr.c:499
void RaveAcrr_setNodata(RaveAcrr_t *self, double nodata)
Sets the nodata to be used for the accumulation.
Definition rave_acrr.c:487
RaveCoreObjectType RaveAcrr_TYPE
Type definition to use when creating a rave object.
Definition rave_acrr.c:544
const char * RaveAcrr_getQualityFieldName(RaveAcrr_t *self)
Returns the name of the quality field (how/task value) to be used as distance field when performing t...
Definition rave_acrr.c:536
double RaveAcrr_getNodata(RaveAcrr_t *self)
Returns the nodata that will be used in the accumulation.
Definition rave_acrr.c:493
CartesianParam_t * RaveAcrr_accumulate(RaveAcrr_t *self, double acpt, long N, double hours)
Generates the result.
Definition rave_acrr.c:385
double RaveAcrr_getUndetect(RaveAcrr_t *self)
Returns the undetect that will be used in the accumulation.
Definition rave_acrr.c:505
int RaveAcrr_isInitialized(RaveAcrr_t *self)
Returns if this instance has been initialized or not.
Definition rave_acrr.c:481
int RaveAcrr_sum(RaveAcrr_t *self, CartesianParam_t *param, double zr_a, double zr_b)
Sums a parameter with the previously calculated values.
Definition rave_acrr.c:306
int RaveAcrr_setQualityFieldName(RaveAcrr_t *self, const char *fieldname)
Sets the name of the quality field (how/task value) to be used as distance field when performing the ...
Definition rave_acrr.c:517
const char * RaveAcrr_getQuantity(RaveAcrr_t *self)
Returns the quantity for this generator instance.
Definition rave_acrr.c:511
Generic implementation of an object that is used within rave.
Represents the cartesian field product.
Definition cartesianparam.c:40
Represents the acrr generator.
Definition rave_acrr.c:40
double zr_a
the zr a coefficent
Definition rave_acrr.c:52
double zr_b
the zr b coefficient
Definition rave_acrr.c:53
double undetect
the undetect value that will be used in the accumulation
Definition rave_acrr.c:44
double nodata
the nodata value that will be used in the accumulation
Definition rave_acrr.c:43
The rave object type definition.
Definition rave_object.h:52