BEAM BLOCKAGE
beamblockage.h
Go to the documentation of this file.
1/* --------------------------------------------------------------------
2Copyright (C) 2011 Swedish Meteorological and Hydrological Institute, SMHI,
3
4This file is part of beam blockage (beamb).
5
6beamb 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
11beamb 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 beamb. If not, see <http://www.gnu.org/licenses/>.
18------------------------------------------------------------------------*/
27#ifndef BEAMBLOCKAGE_H
28#define BEAMBLOCKAGE_H
29#include "rave_object.h"
30#include "rave_field.h"
31#include "polarscan.h"
32
37
41extern RaveCoreObjectType BeamBlockage_TYPE;
42
49int BeamBlockage_setTopo30Directory(BeamBlockage_t* self, const char* topodirectory);
50
57
66
75
81void BeamBlockage_setRewriteCache(BeamBlockage_t* self, int recreateCache);
82
89
98RaveField_t* BeamBlockage_getBlockage(BeamBlockage_t* self, PolarScan_t* scan, double dBlim);
99
108int BeamBlockage_restore(PolarScan_t* scan, RaveField_t* blockage, const char* quantity, double threshold);
109
110#endif /* BEAMBLOCKAGE_H */
int BeamBlockage_restore(PolarScan_t *scan, RaveField_t *blockage, const char *quantity, double threshold)
When you have retrieved the beam blockage field you can restore the specified parameter for the scan.
Definition beamblockage.c:604
void BeamBlockage_setRewriteCache(BeamBlockage_t *self, int recreateCache)
Sets if the cache should be recreated all the time.
Definition beamblockage.c:449
RaveField_t * BeamBlockage_getBlockage(BeamBlockage_t *self, PolarScan_t *scan, double dBlim)
Gets the blockage for the provided scan.
Definition beamblockage.c:460
const char * BeamBlockage_getTopo30Directory(BeamBlockage_t *self)
Returns the topo30 directory.
Definition beamblockage.c:415
const char * BeamBlockage_getCacheDirectory(BeamBlockage_t *self)
Returns the cache directory.
Definition beamblockage.c:443
RaveCoreObjectType BeamBlockage_TYPE
Type definition to use when creating a rave object.
Definition beamblockage.c:703
int BeamBlockage_setTopo30Directory(BeamBlockage_t *self, const char *topodirectory)
Sets the topo30 directory.
Definition beamblockage.c:409
int BeamBlockage_setCacheDirectory(BeamBlockage_t *self, const char *cachedir)
Sets the cache directory.
Definition beamblockage.c:421
int BeamBlockage_getRewriteCache(BeamBlockage_t *self)
Returns if the cache is recreated each time.
Definition beamblockage.c:455
Represents the beam blockage algorithm.
Definition beamblockage.c:43
char * cachedir
the cache directory
Definition beamblockage.c:46