DCReaderGRIB.h

Go to the documentation of this file.

//************************************************************************
//                                                                       *
//           Copyright (C)  2004                                         *
//     University Corporation for Atmospheric Research                   *
//           All Rights Reserved                                         *
//                                                                       *
//************************************************************************/
//
//  File:        DCReaderGRIB.h
//
//  Author:      Scott Pearse
//               National Center for Atmospheric Research
//               PO 3000, Boulder, Colorado
//
//  Date:        June 2014
//
//  Description: TBD 
//               
//

#ifndef DCREADERGRIB_H
#define DCREADERGRIB_H
#include "grib_api.h"
#include <vapor/DCReader.h>
#include <iostream>
#include <string>
#include <vector>
#include <map>

#include <vapor/UDUnitsClass.h>
#ifdef _WINDOWS
#include "vapor/udunits2.h"
#else
#include <udunits2.h>
#endif

namespace VAPoR {

class UDUnits;

class VDF_API DCReaderGRIB : public DCReader {
    public:
        DCReaderGRIB();
        DCReaderGRIB(const vector<string> files);
        ~DCReaderGRIB();

        int HydrostaticPressureEqn();
        int LoadHydroData(float* T, float* Q, float* Sp);
        int CalcVirtualTemperature(float* T, float* Q, float* Sum, float* Tv);
        int DoHydroVarsExist();
        void Print2dVars();
        void _generateWeightTable();
        string GetGridType() const;
        virtual std::vector<double> GetTSZCoords(size_t ) const {
            return(_vertCoordinates);};
        // DCReader Virtual Functions
        virtual int OpenVariableRead(size_t timestep, string varname, 
                                      int reflevel=0, int lod=0);
        virtual int CloseVariable() {//grib_handle_delete(h);
                                  fclose(_inFile); return 0;}
        virtual int Read(float *values);
        virtual int ReadSlice(float *slice);
        virtual bool VariableExists(size_t ts, string varname,
                                 int reflevel=0, int lod=0) const;     // not pure
        virtual void GetLatLonExtents(size_t ts, double lon_exts[2],
                                   double lat_exts[2]) const;
        virtual std::vector<std::string> GetVariables2DExcluded() const;
        virtual std::vector<std::string> GetVariables3DExcluded() const;

        virtual long GetNumTimeSteps() const;                                 // from Metadata.h
        virtual void GetGridDim(size_t dim[3]) const;                         // from Metadata.h
        virtual std::vector<string> GetVariables3D() const;                   // from Metadata.h
        virtual std::vector<string> GetVariables2DXY() const;                 // from Metadata.h
        virtual double GetTSUserTime(size_t ts) const {return _gribTimes[ts];}   // from Metadata.h
        virtual std::vector<string> GetVariables2DXZ() const {                // from Metadata.h
        std::vector<string> empty; return(empty);};
        virtual std::vector<string> GetVariables2DYZ() const {                // from Metadata.h
        std::vector<string> empty; return(empty);};
        // END DCReader Functions

    
        // Metadata Pure Virtual Functions
        virtual void GetBlockSize(size_t bs[3], int reflevel) const { GetGridDim(bs); }
        virtual std::vector<double> GetExtents(size_t ts = 0) const {return _cartographicExtents;}//_cartesianExtents;}
        virtual std::vector<long> GetPeriodicBoundary() const;              // Needs implementation!
        virtual std::vector<long> GetGridPermutation() const;               // Needs implementation!
        virtual void GetTSUserTimeStamp(size_t ts, std::string &s) const;
        virtual std::string GetMapProjection() const;
        // END Metadata Virtual Functions

        vector <double> GetZCoordsInMeters() const {return _vertCoordinates;}
        void _LinearInterpolation(float* values);
    
    private:
        // Convenience functions
        //int _Initialize(std::vector<std::map<std::string, std::string> > records);
        int _Initialize(vector<string> files);
        int _SetGribEnv();
        int PrintVar(string var);
        float GetLevel(int index) const {return _pressureLevels[index];}
        void PrintLevels();
        void Print3dVars();
        void Print1dVars();
        double BarometricFormula(const double pressure) const;
        int _InitCartographicExtents(string mapProj);

        struct MessageLocation {
            string fileName;
            int offset;
        };

        class Variable {
            public:
                Variable();
                ~Variable();
                void _AddTime(double t) {_unitTimes.push_back(t);}
                void  _AddMessage(int msg) {_messages.push_back(msg);} 
                void _AddLevel(float lvl) {_pressureLevels.push_back(lvl);}
                void _AddIndex(double time, float level, string file, int offset);

                int GetOffset(double time, float level) const;
                string GetFileName(double time, float level) const;
                std::vector<int> GetMessages() const {return _messages;}
                std::vector<double> GetTimes() const {return _unitTimes;}
                std::vector<float> GetLevels() const {return _pressureLevels;}
                float GetLevel(int index) const {return _pressureLevels[index];}
                void PrintTimes();
                void PrintMessages();
                void PrintIndex(double time, float level);
                void _SortLevels() {sort(_pressureLevels.begin(), _pressureLevels.end());}
                void _SortTimes() {sort(_unitTimes.begin(), _unitTimes.end());}
                bool _Exists(double time) const;
                void setScanDirection(bool i, bool j) {iScan = i; jScan = j;}
                void setOperatingCenter(string oc) {_operatingCenter = oc;}
                void setParamId(int id) {_paramId = id;}
                string getOperatingCenter() {return _operatingCenter;}
                int getParamId() {return _paramId;}
                bool getiScan() const {return iScan;}
                bool getjScan() const {return jScan;}

            private:
                //       time             level
                std::map<double, std::map<float, MessageLocation> > _indices;
                std::vector<int> _messages;
                std::vector<float> _pressureLevels;

                std::vector<size_t> _varTimes;
                std::vector<double> _unitTimes;
                string _operatingCenter;
                int _paramId;
                bool iScan;
                bool jScan;
                bool isGaussian;
        };

        bool _ignoreForecastData;
        static int _sliceNum;
        int _Ni;
        int _Nj;
        double _DxInMetres;
        double _DyInMetres;
        double _LaDInDegrees;
        double _LoVInDegrees;
        double _minLat;
        double _minLon;
        double _maxLat;
        double _maxLon;
        bool _iScanNeg;
        bool _jScanPos;
        string _gridType;
        string _openVar;
        string _Latin1InDegrees;
        string _Latin2InDegrees;
        string _orientationOfTheGridInDegrees;     

        static int _openTS;   
        FILE* _inFile;    
        grib_handle* h;
        std::vector<double> _pressureLevels;
        std::vector<double> _vertCoordinates;
        std::vector<double> _cartesianExtents;
        std::vector<double> _cartographicExtents;
        std::vector<double> _gribTimes;
        std::map<std::string, Variable*> _vars1d;
        std::map<std::string, Variable*> _vars2d;
        std::map<std::string, Variable*> _vars3d;
        double* _gaussianLats;
        std::vector<double> _weights;
        std::vector<int> _latIndices;
        float* _iValues;
        double* _regularLats;
        float* _hydrostaticElevation;

        UDUnits *_udunit;

        class GribParser {
            public:
                GribParser();
                ~GribParser();
                int _LoadRecord(string file, size_t offset);
                int _LoadRecordKeys(const string file); // loads only the keys that we need for vdc creation
                int _VerifyKeys();                  // verifies that key/values conform to our reqs
                std::vector<std::map<std::string, std::string> > GetRecords() const {return _recordKeys;}
                 int doWeIgnoreForecastTimes() {return _ignoreForecastTimes;}

            private:
                int _err;
                std::vector<std::map<std::string, std::string> > _recordKeys;
                std::vector<std::string> _consistentKeys;
                std::vector<std::string> _varyingKeys;
                bool _recordKeysVerified;
                int _ignoreForecastTimes;
                DCReaderGRIB *_metadata;

                // vars for key iteration 
                unsigned long _key_iterator_filter_flags;
                int _grib_count;
                char* _value;
                size_t _vlen;

                // vars for data dump
                double *_values;
                double _min,_max,_average;
                size_t _values_len;
                string _filename;
        };

        GribParser *parser;

        class Record {
            public:
                Record();
                Record(string file, int recordNum);
                ~Record();
                void setTime(string input) {time = input;}
                void setUnits(string input) {units = input;}
                void setNi(string input) {Ni = input;}
                void setNj(string input) {Nj = input;}
                void setGridType(string input) {gridType = input;}
                void setVarName(string input) {varName = input;}
                string getTime() {return time;}
                string getUnits() {return units;}
                string getNi() {return Ni;}
                string getNj() {return Nj;}
                string getGridType() {return gridType;}
                string getVarName() {return varName;}

            private:
                string time;
                string units;
                string Ni;
                string Nj;
                string gridType;
                string varName;
        };
    };
};
#endif // GRIBPARSER_H