rave_types.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 RAVE_TYPES_H
#define RAVE_TYPES_H
 
#ifdef _MSC_VER
#ifndef _CRT_SECURE_NO_DEPRECATE
#define _CRT_SECURE_NO_DEPRECATE
#endif
#ifndef _CRT_NONSTDC_NO_DEPRECATE
#define _CRT_NONSTDC_NO_DEPRECATE
#endif
#ifndef _USE_MATH_DEFINES
#define _USE_MATH_DEFINES
#endif
#endif
 
typedef enum RaveIO_ODIM_Version {
  RaveIO_ODIM_Version_UNDEFINED = -1, 
  RaveIO_ODIM_Version_2_0 = 0,        
  RaveIO_ODIM_Version_2_1 = 1,        
  RaveIO_ODIM_Version_2_2 = 2,        
  RaveIO_ODIM_Version_2_3 = 3,        
  RaveIO_ODIM_Version_2_4 = 4,        
} RaveIO_ODIM_Version;
 
#ifndef RAVEIO_API_ODIM_VERSION
#define RAVEIO_API_ODIM_VERSION RaveIO_ODIM_Version_2_3
#endif
 
typedef enum RaveIO_ODIM_H5rad_Version {
  RaveIO_ODIM_H5rad_Version_UNDEFINED = -1, 
  RaveIO_ODIM_H5rad_Version_2_0 = 0,  
  RaveIO_ODIM_H5rad_Version_2_1 = 1,  
  RaveIO_ODIM_H5rad_Version_2_2 = 2,  
  RaveIO_ODIM_H5rad_Version_2_3 = 3,  
  RaveIO_ODIM_H5rad_Version_2_4 = 4,  
} RaveIO_ODIM_H5rad_Version;
 
typedef enum RaveValueType {
  RaveValueType_UNDEFINED = -1,     
  RaveValueType_UNDETECT = 0,       
  RaveValueType_NODATA = 1,         
  RaveValueType_DATA = 2            
} RaveValueType;
 
typedef enum Rave_ObjectType {
  Rave_ObjectType_UNDEFINED = -1,
  Rave_ObjectType_PVOL = 0,       
  Rave_ObjectType_CVOL = 1,       
  Rave_ObjectType_SCAN,           
  Rave_ObjectType_RAY,            
  Rave_ObjectType_AZIM,           
  Rave_ObjectType_ELEV,           
  Rave_ObjectType_IMAGE,          
  Rave_ObjectType_COMP,           
  Rave_ObjectType_XSEC,           
  Rave_ObjectType_VP,             
  Rave_ObjectType_PIC,            
  Rave_ObjectType_ENDOFTYPES      
} Rave_ObjectType;
 
typedef enum Rave_ProductType {
  Rave_ProductType_UNDEFINED = -1, 
  Rave_ProductType_SCAN = 0, 
  Rave_ProductType_PPI,      
  Rave_ProductType_CAPPI,    
  Rave_ProductType_PCAPPI,   
  Rave_ProductType_ETOP,     
  Rave_ProductType_MAX,      
  Rave_ProductType_RR,       
  Rave_ProductType_VIL,      
  Rave_ProductType_COMP,     
  Rave_ProductType_VP,       
  Rave_ProductType_RHI,      
  Rave_ProductType_XSEC,     
  Rave_ProductType_VSP,      
  Rave_ProductType_HSP,      
  Rave_ProductType_RAY,      
  Rave_ProductType_AZIM,     
  Rave_ProductType_QUAL,     
  Rave_ProductType_PMAX,     
  Rave_ProductType_SURF,     
  Rave_ProductType_EBASE,    
  Rave_ProductType_ENDOFTYPES 
} Rave_ProductType;
 
 
typedef enum RaveDataType {
  RaveDataType_UNDEFINED = -1, 
  RaveDataType_CHAR = 0, 
  RaveDataType_UCHAR,    
  RaveDataType_SHORT,    
  RaveDataType_USHORT,   
  RaveDataType_INT,      
  RaveDataType_UINT,     
  RaveDataType_LONG,     
  RaveDataType_ULONG,    
  RaveDataType_FLOAT,    
  RaveDataType_DOUBLE,   
  RaveDataType_LAST      
} RaveDataType;
 
typedef enum RaveTransformationMethod {
  NEAREST = 1,   
  BILINEAR,      
  CUBIC,         
  CRESSMAN,      
  UNIFORM,       
  INVERSE        
} RaveTransformationMethod;
 
typedef struct PolarNavigationInfo {
  double lon;    
  double lat;    
  double height; 
  double actual_height; 
  double distance; 
  double range;    
  double actual_range; 
  double azimuth; 
  double actual_azimuth; 
  double elevation; 
  double beamwH; 
  double beamwV; 
  Rave_ObjectType otype; 
  int ei;         
  int ri;         
  int ai;         
} PolarNavigationInfo;
 
typedef struct PolarObservation {
  RaveValueType vt; 
  double v; 
  double distance; 
  double height; 
  double range; 
  double elangle; 
} PolarObservation;
 
typedef struct PolarObservationLinkedList {
  PolarObservation obs;
  struct PolarObservationLinkedList* next; 
} PolarObservationLinkedList;
 
int get_ravetype_size(RaveDataType type);
 
Rave_ProductType RaveTypes_getProductTypeFromString(const char* name);
 
const char* RaveTypes_getStringFromProductType(Rave_ProductType type);
 
Rave_ObjectType RaveTypes_getObjectTypeFromString(const char* name);
 
const char* RaveTypes_getStringFromObjectType(Rave_ObjectType type);
 
void RaveTypes_FreePolarObservationLinkedList(PolarObservationLinkedList* obs);
 
PolarObservation* RaveTypes_PolarObservationLinkedListToArray(PolarObservationLinkedList* obs, int* nritems);
 
PolarObservation* RaveTypes_FilterPolarObservationDataValues(PolarObservation* observations, int nobservations, int* ndataobservations);
 
void RaveTypes_SortPolarObservations(PolarObservation* observations, int nobservations);
 
#endif /* RAVE_TYPES_H */