File: graceL1a2SatelliteTracking.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 (147 lines) | stat: -rw-r--r-- 5,260 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
/***********************************************/
/**
* @file graceL1a2SatelliteTracking.cpp
*
* @brief Read GRACE L1A data.
*
* @author Beate Klinger
* @date 2018-01-29
*
*/
/***********************************************/

// Latex documentation
#define DOCSTRING docstring
static const char *docstring = R"(
This program converts Level-1A satellite tracking data (KBR1A) to the GROOPS instrument file format.
The GRACE Level-1A format is described in \verb|GRACEiolib.h| given at
\url{http://podaac-tools.jpl.nasa.gov/drive/files/allData/grace/sw/GraceReadSW_L1_2010-03-31.tar.gz}.
The output is one arc of satellite data which can include data gaps.
To split the arc in multiple gap free arcs use \program{InstrumentSynchronize}.
)";

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

#include "programs/program.h"
#include "files/fileInstrument.h"
#include "fileGrace.h"

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

/** @brief Read Level-1A GRACE data.
* @ingroup programsConversionGroup */
class GraceL1a2SatelliteTracking
{
public:
  void run(Config &config, Parallel::CommunicatorPtr comm);
};

GROOPS_REGISTER_PROGRAM(GraceL1a2SatelliteTracking, SINGLEPROCESS, "read GRACE L1A data (KBR1A)", Conversion, Grace, Instrument)

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

void GraceL1a2SatelliteTracking::run(Config &config, Parallel::CommunicatorPtr /*comm*/)
{
  try
  {
    FileName fileNameSst;
    std::vector<FileName> fileNameIn;

    readConfig(config, "outputfileSatelliteTracking", fileNameSst, Config::OPTIONAL, "", "MISCVALUES(ant_id, K_phase, Ka_phase, K_SNR, Ka_SNR)");
    readConfig(config, "inputfile",                   fileNameIn,  Config::MUSTSET,  "", "KBR1A");
    if(isCreateSchema(config)) return;

    // =============================================

    logStatus<<"read input files"<<Log::endl;
    Arc arc;
    for(UInt idFile=0; idFile<fileNameIn.size(); idFile++)
    {
      logStatus<<"read file <"<<fileNameIn.at(idFile)<<">"<<Log::endl;
      UInt numberOfRecords;
      FileInGrace file(fileNameIn.at(idFile), numberOfRecords);

      for(UInt idEpoch=0; idEpoch<numberOfRecords; idEpoch++)
      {
        Int32             seconds, microSeconds;    // receiver time, microseconds part
        Char              GRACE_id;                 // GRACE satellite ID
        FileInGrace::Int8 prn_id, ant_id;           // GPS PRN id or GRACE id, KBR antenna id
        UInt16            prodFlag;
        Byte              qualityFlag;
        Double            CA_range, L1_range, L2_range;
        Double            CA_phase, L1_phase, L2_phase;
        UInt16            CA_SNR, L1_SNR, L2_SNR;
        UInt16            CA_chan, L1_chan, L2_chan;
        Double            K_phase, Ka_phase;                 // K-Band carrier phase, Ka-Band carrier phase
        UInt16            K_SNR, Ka_SNR;                     // K-Band SNR, Ka-Band SNR

        try
        {
          file>>seconds>>microSeconds>>GRACE_id>>prn_id>>ant_id>>FileInGrace::flag(prodFlag)>>FileInGrace::flag(qualityFlag);
          if(prodFlag & (1<<0))  file>>CA_range;
          if(prodFlag & (1<<1))  file>>L1_range;
          if(prodFlag & (1<<2))  file>>L2_range;
          if(prodFlag & (1<<3))  file>>CA_phase;
          if(prodFlag & (1<<4))  file>>L1_phase;
          if(prodFlag & (1<<5))  file>>L2_phase;
          if(prodFlag & (1<<6))  file>>CA_SNR;
          if(prodFlag & (1<<7))  file>>L1_SNR;
          if(prodFlag & (1<<8))  file>>L2_SNR;
          if(prodFlag & (1<<9))  file>>CA_chan;
          if(prodFlag & (1<<10)) file>>L1_chan;
          if(prodFlag & (1<<11)) file>>L2_chan;
          if(prodFlag & (1<<12)) file>>K_phase;
          if(prodFlag & (1<<13)) file>>Ka_phase;
          if(prodFlag & (1<<14)) file>>K_SNR;
          if(prodFlag & (1<<15)) file>>Ka_SNR;
        }
        catch(std::exception &/*e*/)
        {
          // GRACE-FO number of records issue
          logWarning<<arc.back().time.dateTimeStr()<<": file ended at "<<idEpoch<<" of "<<numberOfRecords<<" expected records"<<Log::endl;
          break;
        }

        if((ant_id == 9) || (ant_id == 11) || (ant_id == -11))
        {
          MiscValuesEpoch epoch(7);
          epoch.time      = mjd2time(51544.5) + seconds2time(seconds) + seconds2time(microSeconds*1e-6);
          epoch.values(0) = ant_id;
          epoch.values(1) = K_phase;
          epoch.values(2) = Ka_phase;
          epoch.values(3) = K_SNR;
          epoch.values(4) = Ka_SNR;
          arc.push_back(epoch);
        }
      } // for(idEpoch)
    } // for(idFile)

    // =============================================


    logStatus<<"sort epochs"<<Log::endl;
    arc.sort();

    logStatus<<"eliminate duplicates"<<Log::endl;
    const UInt oldSize = arc.size();
    arc.removeDuplicateEpochs(TRUE/*keepFirst*/);
    if(arc.size() < oldSize)
      logInfo<<" "<<oldSize-arc.size()<<" duplicates removed!"<<Log::endl;

    Arc::printStatistics(arc);
    if(arc.size() == 0)
      return;

    if(!fileNameSst.empty())
    {
      logInfo<<"write data to <"<<fileNameSst<<">"<<Log::endl;
      InstrumentFile::write(fileNameSst, arc);
    }
  }
  catch(std::exception &e)
  {
    GROOPS_RETHROW(e)
  }
}

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