types.h

/* The MIT License (MIT)
 *
 * (c) Jürgen Simon 2014 (juergen.simon@uni-bonn.de)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef RADOLAN_TYPES_H
#define RADOLAN_TYPES_H

#include <stdlib.h>

/* Prefix for Radolan constants, data types and methods is 'RD' */

#define RD_HEADER_LENGTH 138
#define RD_DIM_LON 900
#define RD_DIM_LAT      900

#define RD_SECONDARY_VALUE_BIT  0x01    // 0b0000000000000001
#define RD_ERROR_BIT                    0x02    // 0b0000000000000010
#define RD_NEGATIVE_SIGN_BIT    0x04    // 0b0000000000000100
#define RD_CLUTTER_BIT                  0x08    // 0b0000000000001000

#define RD_CLUTTER_VALUE -2490.0f
#define RD_ERROR_VALUE -2500.0f

#define RX_CLUTTER_VALUE 0xF9
#define RX_ERROR_VALUE 0xFA

#define RD_DBZ_BASEVALUE -32.5
#define RD_DBZ_OUTSIDEVALUE 92.5

#ifdef __cplusplus
extern "C"
{
        namespace Radolan {
#endif

    typedef enum {
        RD_UNKNOWN,
        RD_RX,
        RD_RO,
        RD_RK,
        RD_RZ,
        RD_RY,
        RD_RH,
        RD_RJ,
        RD_RP,
        RD_RT,
        RD_RC,
        RD_RI,
        RD_RG,
        RD_RB,
        RD_RA,
        RD_RM,
        RD_RL,
        RD_RN,
        RD_RD,
        RD_RF,
        RD_RW,
        RD_RU,
        RD_RR,
        RD_SQ,
        RD_SH,
        RD_SF,
        RD_RV,
        RD_RS,
        RD_RQ,
        RD_RE,
        RD_TZ,
        RD_TH,
        RD_EX,
        RD_EZ,
        RD_EH,
        RD_EB,
        RD_EW
    } RDScanType;

    typedef enum {R100km=1,R128km=2} RDRadarFormat;

    typedef enum {RAVOQ_HV,RAVOQ_HV_ConfidenceEstimate,RAVOQ,Winterrath} RDQuantification;

    typedef struct {

      RDScanType scanType;                  

      // Date information
      unsigned short int day;               
      unsigned short int hour;
      unsigned short int minute;
      unsigned short int month;
      unsigned short int year;

      unsigned int radarLocation;           

      size_t headerSize;                      

      size_t payloadSize;                     

      RDRadarFormat radarFormat;            

      char softwareVersion[9];              

      float precision;                      

      unsigned short int intervalDuration;  

      char resolution[10];                  

      unsigned int predictionMinutes;       

      char binaryFormat[9];                 

      RDQuantification quantification;      

      int numberOfRadarStations;            

      char* radarStations;                  

    } RDRadolanHeader;

    /* Which data type to use in the reading process. If you change this,
     the reader code must reflect this change */
    typedef float RDDataType;

    typedef unsigned char RDByteType;
    
    typedef struct {

      char filename[1024];                    

      RDRadolanHeader header;                        

      RDDataType* data;                        

      int dimLon;                                                               

      int dimLat;                               

      RDDataType min_value;                    

      RDDataType max_value;                    
      
      double dbZPerUnit;

    } RDScan;

#ifdef __cplusplus
        }
}
#endif
                
#endif /* header guard */