RAVE
cartesiancomposite.h
Go to the documentation of this file.
1/* --------------------------------------------------------------------
2Copyright (C) 2013 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------------------------------------------------------------------------*/
27#ifndef CARTESIANCOMPOSITE_H
28#define CARTESIANCOMPOSITE_H
29#include "rave_proj.h"
30#include "projection.h"
31#include "area.h"
32#include "rave_object.h"
33#include "rave_types.h"
34#include "rave_list.h"
35#include "raveobject_list.h"
36#include "rave_attribute.h"
37#include "rave_field.h"
38#include "cartesianparam.h"
39#include "cartesian.h"
40#include "composite.h"
41
52
57
62
70
77
85
93
100
107int CartesianComposite_setDistanceField(CartesianComposite_t* self, const char* fieldname);
108
116
123int CartesianComposite_setTime(CartesianComposite_t* self, const char* value);
124
131
138int CartesianComposite_setDate(CartesianComposite_t* self, const char* value);
139
146
154
161
168
175
182
189
196
203
210
217
225
226#endif /* CARTESIANCOMPOSITE_H */
Defines an area, the extent, projection, etc.
Defines the functions available when working with cartesian products.
const char * CartesianComposite_getDistanceField(CartesianComposite_t *self)
Returns the quality field name (how/task) for the distance field to use when executing the DISTANCE s...
Definition cartesiancomposite.c:274
int CartesianComposite_add(CartesianComposite_t *self, Cartesian_t *object)
Adds a cartesian product to the cartesian composite generator.
Definition cartesiancomposite.c:221
CartesianCompositeSelectionMethod_t CartesianComposite_getMethod(CartesianComposite_t *self)
Returns the currently selection method.
Definition cartesiancomposite.c:251
void CartesianComposite_setNodata(CartesianComposite_t *self, double nodata)
Sets the nodata.
Definition cartesiancomposite.c:353
int CartesianComposite_setTime(CartesianComposite_t *self, const char *value)
Sets the nominal time.
Definition cartesiancomposite.c:280
int CartesianComposite_setQuantity(CartesianComposite_t *self, const char *quantity)
Sets the quantity.
Definition cartesiancomposite.c:304
RaveCoreObjectType CartesianComposite_TYPE
Type definition to use when creating a rave object.
Definition cartesiancomposite.c:531
const char * CartesianComposite_getTime(CartesianComposite_t *self)
Returns the nominal time.
Definition cartesiancomposite.c:286
void CartesianComposite_setUndetect(CartesianComposite_t *self, double undetect)
Sets the undetect.
Definition cartesiancomposite.c:365
double CartesianComposite_getNodata(CartesianComposite_t *self)
Returns the nodata.
Definition cartesiancomposite.c:359
int CartesianComposite_setMethod(CartesianComposite_t *self, CartesianCompositeSelectionMethod_t method)
Sets the selection method to use.
Definition cartesiancomposite.c:240
double CartesianComposite_getGain(CartesianComposite_t *self)
Returns the gain.
Definition cartesiancomposite.c:335
int CartesianComposite_setDate(CartesianComposite_t *self, const char *value)
Sets the nominal date.
Definition cartesiancomposite.c:292
void CartesianComposite_setGain(CartesianComposite_t *self, double gain)
Sets the gain.
Definition cartesiancomposite.c:327
Cartesian_t * CartesianComposite_get(CartesianComposite_t *self, int index)
Return the object at position index.
Definition cartesiancomposite.c:234
int CartesianComposite_getNumberOfObjects(CartesianComposite_t *self)
Returns the number of objects this composite will process.
Definition cartesiancomposite.c:228
double CartesianComposite_getOffset(CartesianComposite_t *self)
Returns the offset.
Definition cartesiancomposite.c:347
Cartesian_t * CartesianComposite_nearest(CartesianComposite_t *self, Area_t *area)
Generates a composite according to the nearest radar principle.
Definition cartesiancomposite.c:378
void CartesianComposite_setOffset(CartesianComposite_t *self, double offset)
Sets the offset.
Definition cartesiancomposite.c:341
double CartesianComposite_getUndetect(CartesianComposite_t *self)
Returns the undetect.
Definition cartesiancomposite.c:371
int CartesianComposite_setDistanceField(CartesianComposite_t *self, const char *fieldname)
Sets the distance field to use when executing the DISTANCE selection method.
Definition cartesiancomposite.c:257
const char * CartesianComposite_getQuantity(CartesianComposite_t *self)
Returns the quantity (default DBZH)
Definition cartesiancomposite.c:321
const char * CartesianComposite_getDate(CartesianComposite_t *self)
Returns the nominal date.
Definition cartesiancomposite.c:298
CartesianCompositeSelectionMethod_t
What type of selection variant to use.
Definition cartesiancomposite.h:45
@ CartesianCompositeSelectionMethod_MINVALUE
Minimum value of all overlapping radars.
Definition cartesiancomposite.h:47
@ CartesianCompositeSelectionMethod_AVGVALUE
Average value for all overlapping radars.
Definition cartesiancomposite.h:49
@ CartesianCompositeSelectionMethod_DISTANCE
Min value according to the distance field.
Definition cartesiancomposite.h:50
@ CartesianCompositeSelectionMethod_MAXVALUE
Maximum value of all overlapping radars.
Definition cartesiancomposite.h:48
@ CartesianCompositeSelectionMethod_FIRST
First found value for all overlapping radars.
Definition cartesiancomposite.h:46
Defines the functions available when working with a cartesian field.
Provides functionality for creating composites.
Wrapper around PROJ.4.
Used for keeping track on attributes.
Generic field that only provides a 2-dim data field and a number of dynamic attributes.
Implementation of a simple list.
Generic implementation of an object that is used within rave.
Handles compatibility issues related to PROJ versions and the definitions.
Type definitions for RAVE.
Implementation of a rave object list that ensures that the objects contained within the list are rele...
Represents the area.
Definition area.c:34
Represents the cartesian composite generator.
Definition cartesiancomposite.c:40
double offset
the offset for the data
Definition cartesiancomposite.c:47
RAVE_OBJECT_HEAD CartesianCompositeSelectionMethod_t method
Always on top.
Definition cartesiancomposite.c:42
double undetect
the undetect value for the composite
Definition cartesiancomposite.c:50
double gain
the gain for the data
Definition cartesiancomposite.c:48
char * quantity
the quantity to make a composite of
Definition cartesiancomposite.c:46
double nodata
the nodata value for the composite
Definition cartesiancomposite.c:49
Represents the cartesian product.
Definition cartesian.c:41
The rave object type definition.
Definition rave_object.h:52