File: netCdf2GriddedDataTimeSeries.cpp

package info (click to toggle)
groops 0%2Bgit20250907%2Bds-1
  • links: PTS, VCS
  • area: non-free
  • in suites: forky, sid
  • size: 11,140 kB
  • sloc: cpp: 135,607; fortran: 1,603; makefile: 20
file content (160 lines) | stat: -rw-r--r-- 6,647 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
/***********************************************/
/**
* @file netCdf2GriddedDataTimeSeries.cpp
*
* @brief Convert a NetCDF file to a GriddedDataTimeSeries file.
*
* @author Andreas Kvas
* @author Torsten Mayer-Guerr
* @date 2023-07-04
*/
/***********************************************/

// Latex documentation
#define DOCSTRING docstring
static const char *docstring = R"(
This program converts a COARDS compliant NetCDF file into
\configFile{outputfileGriddedDataTimeSeries}{griddedDataTimeSeries}.
If no specific input \config{variableNameData} are selected all suitable data are used.

See also \program{NetCdfInfo}, \program{NetCdf2GriddedData}, \program{GriddedDataTimeSeries2NetCdf}.
)";

/***********************************************/

#include "programs/program.h"
#include "inputOutput/fileNetCdf.h"
#include "files/fileGriddedDataTimeSeries.h"
#include "misc/miscGriddedData.h"

/***** CLASS ***********************************/

/** @brief Convert a NetCDF file to a GriddedDataTimeSeries file.
* @ingroup programsConversionGroup */
class NetCdf2GriddedDataTimeSeries
{
public:
  void run(Config &config, Parallel::CommunicatorPtr comm);
};

GROOPS_REGISTER_PROGRAM(NetCdf2GriddedDataTimeSeries, SINGLEPROCESS, "Convert a NetCDF file to a GriddedDataTimeSeries file", Conversion, Grid)

/***********************************************/

void NetCdf2GriddedDataTimeSeries::run(Config &config, Parallel::CommunicatorPtr /*comm*/)
{
  try
  {
    FileName    fileNameOut, fileNameNetcdf;
    std::string lonName, latName, timeName;
    std::vector<std::string> dataNames;
    Double      a, f;

    readConfig(config, "outputfileGriddedDataTimeSeries", fileNameOut,    Config::MUSTSET,  "",     "");
    readConfig(config, "inputfileNetCdf",                 fileNameNetcdf, Config::MUSTSET,  "",     "");
    readConfig(config, "variableNameLongitude",           lonName,        Config::MUSTSET,  "lon",  "name of NetCDF variable");
    readConfig(config, "variableNameLatitude",            latName,        Config::MUSTSET,  "lat",  "name of NetCDF variable");
    readConfig(config, "variableNameTime",                timeName,       Config::MUSTSET,  "time", "name of NetCDF variable)");
    readConfig(config, "variableNameData",                dataNames,      Config::OPTIONAL, "",     "data variables, otherwise all suitable data are used");
    readConfig(config, "R",                               a,              Config::DEFAULT,  STRING_DEFAULT_GRS80_a, "reference radius for ellipsoidal coordinates");
    readConfig(config, "inverseFlattening",               f,              Config::DEFAULT,  STRING_DEFAULT_GRS80_f, "reference flattening for ellipsoidal coordinates");
    if(isCreateSchema(config)) return;

#ifdef GROOPS_DISABLE_NETCDF
    throw(Exception("Compiled without NetCDF library"));
#else
    // open netCDF file
    // ----------------
    logStatus<<"read NETCDF file <"<<fileNameNetcdf<<">"<<Log::endl;
    NetCdf::InFile file(fileNameNetcdf);
    NetCdf::Variable  lon    = file.variable(lonName);
    NetCdf::Variable  lat    = file.variable(latName);
    NetCdf::Dimension dimLon = lon.dimensions().at(0);
    NetCdf::Dimension dimLat = lat.dimensions().at(0);

    // set up grid
    // -----------
    GriddedDataRectangular griddedDataRectangular;
    griddedDataRectangular.ellipsoid  = Ellipsoid(a, f);
    griddedDataRectangular.longitudes = NetCdf::convertAngles(lon.values());
    griddedDataRectangular.latitudes  = NetCdf::convertAngles(lat.values());
    griddedDataRectangular.heights.resize(griddedDataRectangular.latitudes.size(), 0.0);
    MiscGriddedData::printStatistics(griddedDataRectangular);
    GriddedData grid(griddedDataRectangular);

    // set up time axis
    // ----------------
    NetCdf::Variable  time    = file.variable(timeName);
    NetCdf::Dimension dimTime = time.dimensions().at(0);
    std::vector<Time> times   = NetCdf::convertTimes(time.values(), time.attribute("units").value());

    // set up data columns
    // -------------------
    if(!dataNames.size())
    {
      for(auto &var : file.variables())
      {
        auto dims = var.dimensions();
        if((dims.size() != 3) ||
           (std::find(dims.begin(), dims.end(), dimLat) == dims.end()) ||
           (std::find(dims.begin(), dims.end(), dimLon) == dims.end()) ||
           (std::find(dims.begin(), dims.end(), dimTime) == dims.end()))
          continue;
        dataNames.push_back(var.name());
      }
      if(!dataNames.size())
        logWarning<<"No suitable variables found"<<Log::endl;
    }

    std::vector<NetCdf::Variable>  vars(dataNames.size());
    std::vector<std::vector<NetCdf::Dimension>> dims(dataNames.size());
    UInt idx = 0;
    for(UInt i=0; i<vars.size(); i++)
    {
      vars.at(i) = file.variable(dataNames.at(i));
      dims.at(i) = vars.at(i).dimensions();
      logInfo<<"  data"<<idx++<<" = "<<vars.at(i).name()<<Log::endl;
      for(auto &attr : vars.at(i).attributes())
        logInfo<<"    - "<<attr.name()<<" value = "<<attr.value()<<Log::endl;
      if(dims.at(i).size() != 3)
        throw(Exception("variable <"+vars.at(i).name()+"> has wrong dimensions"));
      if(dims.at(i).at(0) != dimTime)
        throw(Exception("variable <"+vars.at(i).name()+"> must have time as first dimension"));
    }

    // read data variables
    // -------------------
    std::vector<Matrix> data(times.size(), Matrix(griddedDataRectangular.longitudes.size()*griddedDataRectangular.latitudes.size(), dataNames.size()));
    Single::forEach(times.size(), [&](UInt idEpoch)
    {
      for(UInt i=0; i<vars.size(); i++)
      {
        std::vector<UInt> start(dims.at(i).size(), 0);
        std::vector<UInt> count;
        for(auto &dim : dims.at(i))
          count.push_back(dim.length());
        start.at(0) = idEpoch;
        count.at(0) = 1;

        if((dims.at(i).at(1) == dimLon) && (dims.at(i).at(2) == dimLat))
          copy(vars.at(i).values(start, count), data.at(idEpoch).column(i));
        else if((dims.at(i).at(1) == dimLat) && (dims.at(i).at(2) == dimLon))
          reshape(reshape(vars.at(i).values(start, count), count.at(2), count.at(1)), data.at(idEpoch).column(i));
        else
          throw(Exception("variable <"+vars.at(i).name()+"> must have ("+latName+", "+lonName+") dimensions"));
      }
    });

    // write grid
    // ----------
    logStatus<<"write gridded data time series to <"<<fileNameOut<<">"<<Log::endl;
    writeFileGriddedDataTimeSeries(fileNameOut, 1/*splineDegree*/, times, grid, data);
#endif
  }
  catch(std::exception &e)
  {
    GROOPS_RETHROW(e)
  }
}

/***********************************************/