HDFCFUtil.h

Go to the documentation of this file.

// Helper functions for handling dimension maps,clear memories and separating namelist
//
//  Authors:   MuQun Yang <myang6@hdfgroup.org> Eunsoo Seo
// Copyright (c) 2010-2012 The HDF Group
#ifndef HDFCFUTIL_H
#define HDFCFUTIL_H

#include <stdlib.h>
#include <string>
#include <iostream>
#include <sstream>
#include <vector>
#include <map>
#include <set>
#include <assert.h>
#include <iomanip>
#include <dirent.h>
#include <libgen.h>
#include <unistd.h>

#include "mfhdf.h"
#include "hdf.h"

#ifdef USE_HDFEOS2_LIB
#include "HdfEosDef.h"
#include "HDFEOS2.h"
#endif
#include "HDFSP.h"

#include <TheBESKeys.h>
#include <BESUtil.h>
#include <DDS.h>
#include <DAS.h>
#include <InternalErr.h>

#include "escaping.h" // for escattr

// This is the maximum number of MODIS special values.
#define MAX_NON_SCALE_SPECIAL_VALUE 65535

// This is the minimum number of MODIS special values.
#define MIN_NON_SCALE_SPECIAL_VALUE 65500


// This is used to retrieve dimension map info. when retrieving the data values of HDF-EOS swath that 
// has swath dimension maps.
struct dimmap_entry
{
    // geo dimension name
    std::string geodim;

    // data dimension name
    std::string datadim;
    
    // offset and increment of a dimension map
    int32 offset, inc;
};


struct HDFCFUtil
{

    static void close_fileid(int32 sdfd,int32 file_id,int32 gridfd,int32 swathfd,bool pass_fileid_key);

    //static void reset_fileid(int& sdfd, int&file_id,int&gridfd,int&swathfd);

    static std::string escattr(std::string  s);


    static bool check_beskeys(const std::string& key);

    static void Split (const char *s, int len, char sep,
        std::vector < std::string > &names);

    static void Split (const char *sz, char sep,
                            std::vector < std::string > &names);

    static bool insert_map(std::map<std::string,std::string>& m, std::string key, std::string val);

    static std::string get_CF_string(std::string s);

    static void gen_unique_name(std::string &str,std::set<std::string>& namelist, int&clash_index);

    static void Handle_NameClashing(std::vector<std::string>&newobjnamelist);
    static void Handle_NameClashing(std::vector<std::string>&newobjnamelist,std::set<std::string>&objnameset);

    static std::string print_attr(int32, int, void*);

    static std::string print_type(int32);

    // Subsetting the 2-D fields
    template <typename T> static void LatLon2DSubset (T* outlatlon, int ydim, int xdim, T* latlon, int32 * offset, int32 * count, int32 * step);

    static void correct_fvalue_type(libdap::AttrTable *at,int32 dtype);


    static void correct_scale_offset_type(libdap::AttrTable *at);


#ifdef USE_HDFEOS2_LIB


    static bool change_data_type(libdap::DAS & das, SOType scaletype, const std::string & new_field_name);

    static bool is_special_value(int32 dtype,float fillvalue, float realvalue);

    static int check_geofile_dimmap(const std::string & geofilename);

    static bool is_modis_dimmap_nonll_field(std::string & fieldname);

    static void obtain_dimmap_info(const std::string& filename, HDFEOS2::Dataset*dataset,std::vector<struct dimmap_entry>& dimmaps, std::string & modis_geofilename,bool &geofile_nas_dimmap);

    static void handle_modis_special_attrs_disable_scale_comp(libdap::AttrTable *at,const string &filename, bool is_grid, const std::string &newfname, SOType scaletype);


    static void handle_modis_special_attrs(libdap::AttrTable *at,const std::string &filename, bool is_grid, const std::string & newfname, SOType scaletype, bool gridname_change_valid_range, bool changedtype, bool &change_fvtype);

    static void handle_modis_vip_special_attrs(const std::string& valid_range_value,const std::string& scale_factor_value, float& valid_min, float & valid_max);

    static void handle_amsr_attrs(libdap::AttrTable *at);
#endif 

    // Check OBPG attributes. Specifically, check if slope and intercept can be obtained from the file level. 
    // If having global slope and intercept,  obtain OBPG scaling, slope and intercept values.
    static void check_obpg_global_attrs(HDFSP::File*f,std::string & scaling, float & slope,bool &global_slope_flag,float & intercept, bool & global_intercept_flag);

    // For some OBPG files that only provide slope and intercept at the file level, 
    // global slope and intercept are needed to add to all fields and their names are needed to be changed to scale_factor and add_offset.
    // For OBPG files that provide slope and intercept at the field level,  slope and intercept are needed to rename to scale_factor and add_offset.
    static void add_obpg_special_attrs(HDFSP::File*f,libdap::DAS &das,  HDFSP::SDField* spsds,std::string & scaling, float&slope,bool &global_slope_flag,float& intercept,bool &global_intercept_flag);

    // Handle HDF4 OTHERHDF products that follow SDS dimension scale model. 
    // The special handling of AVHRR data is also included.
    static void handle_otherhdf_special_attrs(HDFSP::File *f, libdap::DAS &das);

    // Add  missing CF attributes for non-CV varibles
    static void add_missing_cf_attrs(HDFSP::File*f,libdap::DAS &das);

    // Handle Merra and CERES attributes with the BES key EnableCERESMERRAShortName.
    static void handle_merra_ceres_attrs_with_bes_keys(HDFSP::File*f, libdap::DAS &das,const std::string& filename);

    // Handle the attributes with the BES key EnableVdataDescAttr.
    static void handle_vdata_attrs_with_desc_key(HDFSP::File*f,libdap::DAS &das);

    // Parse TRMM V7 GridHeaders
    //static void parser_trmm_v7_gridheader(int& latsize, int&lonsize, float& lat_start, float& lon_start, bool &sw_origin, bool & cr_reg);
    static void parser_trmm_v7_gridheader(const std:: vector<char>&value, int& latsize, int&lonsize, float& lat_start, float& lon_start, float& lat_res, float& lon_res, bool check_reg_orig);

    // Use to generate cache file name.
    // Reverse the char array order
    static void rev_str(char *str, int len);

    // Return the index of the char array for the integer part 
    static int int_to_str(int,char str[],int);

    // Convert a double number to char array
    static void dtoa(double,char *,int);

    // Obtain the double number in the string format
    static std::string get_double_str(double,int,int);

    // Obtain the integer in the string format
    static std::string get_int_str(int);
     
    //template<typename T> static size_t write_vector_to_file(const std::string &,const vector<T> &,size_t);
   
#if 0
    static size_t write_vector_to_file(const std::string &,const vector<double> &,size_t);
    static ssize_t write_vector_to_file2(const std::string &,const vector<double> &,size_t);
#endif
    // Read double-type data from a file to a vector of double type
    static ssize_t read_vector_from_file(int fd,vector<double> &,size_t);
     
};

inline int32
INDEX_nD_TO_1D (const std::vector < int32 > &dims,
                                const std::vector < int32 > &pos)
{
    /*
     int a[10][20][30];  // & a[1][2][3] == a + (20*30+1 + 30*2 + 1 *3);
     int b[10][2]; // &b[1][2] == b + (20*1 + 2);
    */
    assert (dims.size () == pos.size ());
    int32 sum = 0;
    int32 start = 1;

    for (unsigned int p = 0; p < pos.size (); p++) {
        int32 m = 1;

        for (unsigned int j = start; j < dims.size (); j++)
            m *= dims[j];
        sum += m * pos[p];
        start++;
    }
    return sum;
}


#endif