composite.h

Go to the documentation of this file.

/* --------------------------------------------------------------------
Copyright (C) 2009 Swedish Meteorological and Hydrological Institute, SMHI,
 
This file is part of RAVE.
 
RAVE is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
 
RAVE is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.
 
You should have received a copy of the GNU Lesser General Public License
along with RAVE.  If not, see <http://www.gnu.org/licenses/>.
------------------------------------------------------------------------*/
#ifndef COMPOSITE_H
#define COMPOSITE_H
 
#include "rave_object.h"
#include "rave_types.h"
#include "cartesian.h"
#include "area.h"
#include "composite_algorithm.h"
#include "raveobject_hashtable.h"
#include "limits.h"
 
#define COMPOSITE_QUALITY_FIELDS_GAIN   (1.0/UCHAR_MAX)
#define COMPOSITE_QUALITY_FIELDS_OFFSET 0.0
 
typedef enum CompositeSelectionMethod_t {
  CompositeSelectionMethod_NEAREST = 0, 
  CompositeSelectionMethod_HEIGHT
} CompositeSelectionMethod_t;
 
typedef enum CompositeInterpolationMethod_t {
  CompositeInterpolationMethod_NEAREST = 0,
  CompositeInterpolationMethod_LINEAR_HEIGHT,
  CompositeInterpolationMethod_LINEAR_RANGE,
  CompositeInterpolationMethod_LINEAR_AZIMUTH,
  CompositeInterpolationMethod_LINEAR_RANGE_AND_AZIMUTH,
  CompositeInterpolationMethod_LINEAR_3D,
  CompositeInterpolationMethod_QUADRATIC_HEIGHT,
  CompositeInterpolationMethod_QUADRATIC_3D
} CompositeInterpolationMethod_t;
 
typedef struct _Composite_t Composite_t;
 
extern RaveCoreObjectType Composite_TYPE;
 
int Composite_add(Composite_t* composite, RaveCoreObject* object);
 
int Composite_getNumberOfObjects(Composite_t* composite);
 
RaveCoreObject* Composite_get(Composite_t* composite, int index);
 
int Composite_getRadarIndexValue(Composite_t* composite, int index);
 
void Composite_setProduct(Composite_t* composite, Rave_ProductType type);
 
Rave_ProductType Composite_getProduct(Composite_t* composite);
 
int Composite_setSelectionMethod(Composite_t* self, CompositeSelectionMethod_t method);
 
CompositeSelectionMethod_t Composite_getSelectionMethod(Composite_t* self);
 
int Composite_setInterpolationMethod(Composite_t* self, CompositeInterpolationMethod_t interpolationMethod);
 
CompositeInterpolationMethod_t Composite_getInterpolationMethod(Composite_t* self);
 
void Composite_setInterpolateUndetect(Composite_t* self, int interpolateUndetect);
 
int Composite_getInterpolateUndetect(Composite_t* self);
 
void Composite_setHeight(Composite_t* composite, double height);
 
double Composite_getHeight(Composite_t* composite);
 
void Composite_setElevationAngle(Composite_t* composite, double angle);
 
double Composite_getElevationAngle(Composite_t* composite);
 
void Composite_setRange(Composite_t* composite, double range);
 
double Composite_getRange(Composite_t* composite);
 
int Composite_setQualityIndicatorFieldName(Composite_t* self, const char* qiFieldName);
 
const char* Composite_getQualityIndicatorFieldName(Composite_t* self);
 
int Composite_addParameter(Composite_t* composite, const char* quantity, double gain, double offset, double minvalue);
 
int Composite_hasParameter(Composite_t* composite, const char* quantity);
 
int Composite_getParameterCount(Composite_t* composite);
 
const char* Composite_getParameter(Composite_t* composite, int index, double* gain, double* offset);
 
int Composite_setTime(Composite_t* composite, const char* value);
 
const char* Composite_getTime(Composite_t* composite);
 
int Composite_setDate(Composite_t* composite, const char* value);
 
const char* Composite_getDate(Composite_t* composite);
 
int Composite_applyRadarIndexMapping(Composite_t* composite, RaveObjectHashTable_t* mapping);
 
Cartesian_t* Composite_generate(Composite_t* composite, Area_t* area, RaveList_t* qualityflags);
 
void Composite_setAlgorithm(Composite_t* composite, CompositeAlgorithm_t* algorithm);
 
CompositeAlgorithm_t* Composite_getAlgorithm(Composite_t* composite);
#endif /* COMPOSITE_H */