RAVE
rave_qitotal.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------------------------------------------------------------------------*/
25#ifndef RAVE_QITOTAL_H
26#define RAVE_QITOTAL_H
27#include "rave_object.h"
28#include "raveobject_list.h"
29#include "rave_field.h"
30
35
40
47
53
59int RaveQITotal_setGain(RaveQITotal_t* self, double gain);
60
66
73
79
87int RaveQITotal_setWeight(RaveQITotal_t* self, const char* howtask, double w);
88
96int RaveQITotal_getWeight(RaveQITotal_t* self, const char* howtask, double* w);
97
103void RaveQITotal_removeWeight(RaveQITotal_t* self, const char* howtask);
104
111
122
129
130#endif /* RAVE_QITOTAL_H */
Generic field that only provides a 2-dim data field and a number of dynamic attributes.
Generic implementation of an object that is used within rave.
RaveDataType RaveQITotal_getDatatype(RaveQITotal_t *self)
Definition rave_qitotal.c:277
int RaveQITotal_setWeight(RaveQITotal_t *self, const char *howtask, double w)
Sets the weight for the specified how/task.
Definition rave_qitotal.c:312
RaveCoreObjectType RaveQITotal_TYPE
Type definition to use when creating a rave object.
Definition rave_qitotal.c:640
RaveField_t * RaveQITotal_minimum(RaveQITotal_t *self, RaveObjectList_t *fields)
Performs the minimum QI total algorithm.
Definition rave_qitotal.c:527
void RaveQITotal_setOffset(RaveQITotal_t *self, double offset)
The offset to use for the resulting field.
Definition rave_qitotal.c:300
RaveField_t * RaveQITotal_multiplicative(RaveQITotal_t *self, RaveObjectList_t *fields)
Performs the multiplicative QI total algorithm.
Definition rave_qitotal.c:351
void RaveQITotal_removeWeight(RaveQITotal_t *self, const char *howtask)
Removes the weight for the specified how/task.
Definition rave_qitotal.c:343
int RaveQITotal_setGain(RaveQITotal_t *self, double gain)
The gain to use for the resulting field.
Definition rave_qitotal.c:283
RaveField_t * RaveQITotal_additive(RaveQITotal_t *self, RaveObjectList_t *fields)
Performs the additive QI total algorithm.
Definition rave_qitotal.c:433
void RaveQITotal_setDatatype(RaveQITotal_t *self, RaveDataType dtype)
The data type to use for the resulting field.
Definition rave_qitotal.c:271
double RaveQITotal_getGain(RaveQITotal_t *self)
Definition rave_qitotal.c:294
double RaveQITotal_getOffset(RaveQITotal_t *self)
Definition rave_qitotal.c:306
int RaveQITotal_getWeight(RaveQITotal_t *self, const char *howtask, double *w)
Returns the weight for the specified how/task.
Definition rave_qitotal.c:330
RaveDataType
Different data types that are supported during transformation.
Definition rave_types.h:130
Implementation of a rave object list that ensures that the objects contained within the list are rele...
Represents the cartesian volume.
Definition rave_field.c:36
Represents a list.
Definition raveobject_list.c:35
Represents the QI total generator.
Definition rave_qitotal.c:35
double offset
offset to use for the result
Definition rave_qitotal.c:38
double gain
gain to use for the result
Definition rave_qitotal.c:39
RAVE_OBJECT_HEAD RaveDataType dtype
Always on top.
Definition rave_qitotal.c:37
The rave object type definition.
Definition rave_object.h:52