DCBOV.h

Go to the documentation of this file.

#pragma once
 
#include <vector>
#include <algorithm>
#include <map>
#include <iostream>
#include <vapor/MyBase.h>
#include <vapor/NetCDFCFCollection.h>
#include <vapor/Proj4API.h>
#include <vapor/UDUnitsClass.h>
#include <vapor/utils.h>
#include <vapor/DC.h>
#include <vapor/BOVCollection.h>
 
namespace VAPoR {
 
class BOVCollection;
 
// Example BOV header file, bovA1.bov
//
// # TIME is a floating point value specifying the timestep being read in DATA_FILE
// TIME: 1.1
//
// # DATA_FILE points to a binary data file.  It can be a full file path, or a path relative to the BOV header.
// DATA_FILE: bovA1.bin
//
// # The data size corresponds to NX,NY,NZ in the above example code.  It must contain three values
// DATA_SIZE: 10 10 10
//
// # Allowable values for DATA_FORMAT are: INT,FLOAT,DOUBLE
// DATA_FORMAT: FLOAT
//
// # VARIABLE is a string that specifies the variable being read in DATA_FILE.  Must be alphanumeric (abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890_-)
// VARIABLE: myVariable
//
// # BRICK_ORIGIN lets you specify a new coordinate system origin for # the mesh that will be created to suit your data.  It must contain three values.
// BRICK_ORIGIN: 0. 0. 0.
//
// # BRICK_SIZE lets you specify the size of the brick on X, Y, and Z.  It must contain three values.
// BRICK_SIZE: 10. 20. 5.
//
// # BYTE_OFFSET is optional and lets you specify some number of
// # bytes to skip at the front of the file. This can be useful for # skipping the 4-byte header that Fortran tends to write to files. # If your file does not have a header then DO NOT USE
// BYTE_OFFSET. BYTE_OFFSET: 4
 
class VDF_API DCBOV : public VAPoR::DC {
public:
    DCBOV();
    virtual ~DCBOV();
 
protected:
    //
    virtual int initialize(const vector<string> &paths, const std::vector<string> &options);
 
    virtual bool getDimension(string dimname, DC::Dimension &dimension) const;
 
    virtual std::vector<string> getDimensionNames() const;
 
    std::vector<string> getMeshNames() const;
 
    virtual bool getMesh(string mesh_name, DC::Mesh &mesh) const;
 
    virtual bool getCoordVarInfo(string varname, DC::CoordVar &cvar) const;
 
    virtual bool getDataVarInfo(string varname, DC::DataVar &datavar) const;
 
    virtual bool getAuxVarInfo(string varname, DC::AuxVar &var) const { return (false); }
 
    //
    virtual bool getBaseVarInfo(string varname, DC::BaseVar &var) const;
 
    virtual std::vector<string> getDataVarNames() const;
 
    virtual std::vector<string> getAuxVarNames() const { return (vector<string>()); }
 
    virtual std::vector<string> getCoordVarNames() const;
 
    virtual size_t getNumRefLevels(string varname) const { return (1); }
 
    virtual string getMapProjection() const { return (""); }
 
    virtual bool getAtt(string varname, string attname, vector<double> &values) const;
    virtual bool getAtt(string varname, string attname, vector<long> &values) const;
    virtual bool getAtt(string varname, string attname, string &values) const;
 
    virtual std::vector<string> getAttNames(string varname) const;
 
    virtual XType getAttType(string varname, string attname) const;
 
    virtual int getDimLensAtLevel(string varname, int level, std::vector<size_t> &dims_at_level, std::vector<size_t> &bs_at_level) const;
 
    virtual int openVariableRead(size_t ts, string varname, int, int) { return (DCBOV::openVariableRead(ts, varname)); }
 
    virtual int openVariableRead(size_t ts, string varname);
 
    virtual int closeVariable(int fd);
 
    //
    virtual int readRegion(int fd, const vector<size_t> &min, const vector<size_t> &max, float *region) { return (_readRegionTemplate(fd, min, max, region)); }
    virtual int readRegion(int fd, const vector<size_t> &min, const vector<size_t> &max, double *region) { return (_readRegionTemplate(fd, min, max, region)); }
    virtual int readRegion(int fd, const vector<size_t> &min, const vector<size_t> &max, int *region) { return (_readRegionTemplate(fd, min, max, region)); }
 
    virtual bool variableExists(size_t ts, string varname, int reflevel = 0, int lod = 0) const;
 
private:
    VAPoR::UDUnits _udunits;
 
    BOVCollection *_bovCollection;
 
    string                          _varname;
    std::map<string, DC::Dimension> _dimsMap;
    std::map<string, DC::CoordVar>  _coordVarsMap;
    std::map<string, DC::Mesh>      _meshMap;
    std::map<string, DC::DataVar>   _dataVarsMap;
    std::map<string, string>        _coordVarKeys;
 
    void _InitCoordinates();
 
    void _InitDimensions();
 
    void _InitVars();
 
    int _isCoordinateVariable(std::string variable) const;
 
    template<class T> void _generateCoordinates(int dim, const vector<size_t> &min, const vector<size_t> &max, T *region) const;
 
    template<class T> int _readRegionTemplate(int fd, const vector<size_t> &min, const vector<size_t> &max, T *region);
};
}    // namespace VAPoR