File: graceSstSpecialEvents.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 (181 lines) | stat: -rw-r--r-- 7,470 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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
/***********************************************/
/**
* @file graceSstSpecialEvents.cpp
*
* @brief Detect GRACE events (eclipse, sun intrusion into star camera box).
*
* @author Saniya Behzadpour
* @date 2018-08-08
*
*/
/***********************************************/

// Latex documentation
#define DOCSTRING docstring
static const char *docstring = R"(
Time-indexing deterministic signals in the GRACE K-Band measurements caused by Sun intrusions
into the star camera baffles of GRACE-A and eclipse transits of the satellites.
The events are determined by satellites' position (\configFile{inputfileOrbit1/2}{instrument})
and orientation (\configFile{inputfileStarCamera1/2}{instrument}). Each type of event is represented
by its mid-interval point per orbit revolution and is reported in \configFile{outputfileEvents}{instrument}.

The waveform of each event is nearly constant within one month and can be approximated by a polynomial.
For the purpose of gravity field recovery, each waveform is parameterized by a polynomial and the coefficients
of this polynomial are estimated as additional instrument calibration parameters in a common adjustment
with all other instrument, satellite, and gravity field parameters,
see \configClass{parametrizationSatelliteTracking:specialEffect}{parametrizationSatelliteTrackingType:specialEffect}.
)";

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

#include "programs/program.h"
#include "files/fileInstrument.h"
#include "files/fileMatrix.h"
#include "classes/ephemerides/ephemerides.h"
#include "classes/eclipse/eclipse.h"

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

/** @brief Detect GRACE events (eclipse, sun intrusion into star camera box).
* @ingroup programsGroup */
class GraceSstSpecialEvents
{
public:
  void run(Config &config, Parallel::CommunicatorPtr comm);
};

GROOPS_REGISTER_PROGRAM(GraceSstSpecialEvents, SINGLEPROCESS, "Detect GRACE events (eclipse, sun intrusion into star camera box).", Grace)

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

void GraceSstSpecialEvents::run(Config &config, Parallel::CommunicatorPtr /*comm*/)
{
  try
  {
    FileName       fileNameOut, fileNameOutInterval;
    FileName       fileNameOrbit1, fileNameOrbit2;
    FileName       fileNameStarCamera1, fileNameStarCamera2;
    EphemeridesPtr ephemerides;
    EclipsePtr     eclipse;
    Double         marginBefore, marginAfter;

    readConfig(config, "outputfileEvents",     fileNameOut,         Config::MUSTSET,  "", "");
    readConfig(config, "outputfileIntervals",  fileNameOutInterval, Config::OPTIONAL, "", "");
    readConfig(config, "inputfileOrbit1",      fileNameOrbit1,      Config::MUSTSET,  "", "");
    readConfig(config, "inputfileOrbit2",      fileNameOrbit2,      Config::MUSTSET,  "", "");
    readConfig(config, "inputfileStarCamera1", fileNameStarCamera1, Config::MUSTSET,  "", "");
    readConfig(config, "inputfileStarCamera2", fileNameStarCamera2, Config::MUSTSET,  "", "");
    readConfig(config, "ephemerides",          ephemerides,         Config::MUSTSET,  "", "");
    readConfig(config, "eclipse",              eclipse,             Config::MUSTSET,  "", "");
    readConfig(config, "marginLeft",           marginBefore,        Config::DEFAULT,  "100", "margin size (on both sides) [seconds]");
    readConfig(config, "marginRight",          marginAfter,         Config::DEFAULT,  "100", "margin size (on both sides) [seconds]");
    if(isCreateSchema(config)) return;

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

    logStatus<<"read star camera and orbit data"<<Log::endl;
    OrbitArc      orbit1      = InstrumentFile::read(fileNameOrbit1);
    OrbitArc      orbit2      = InstrumentFile::read(fileNameOrbit2);
    StarCameraArc starCamera1 = InstrumentFile::read(fileNameStarCamera1);
    Arc::checkSynchronized({orbit1, orbit2, starCamera1});

    MiscValueArc arc;
    for(UInt i=0; i<orbit1.size(); i++)
    {
      // eclipse transit
      // ---------------
      const Double delta = eclipse->factor(orbit2.at(i).time, orbit2.at(i).position, ephemerides)
                         - eclipse->factor(orbit1.at(i).time, orbit1.at(i).position, ephemerides);

      if(fabs(delta) > 1e-10)
      {
        MiscValueEpoch epoch;
        epoch.time  = orbit1.at(i).time;
        epoch.value = (delta>0) ? 1 : 2;
        arc.push_back(epoch);
        continue;
      }

      // star camera box
      // ----------------
      const Vector3d direction = normalize(orbit1.at(i).position - ephemerides->position(orbit1.at(i).time, Ephemerides::SUN)); // from sun to satellite
      const Vector3d normP     = rotaryZ(Angle(180*DEG2RAD)).rotate(rotaryX(Angle(+135*DEG2RAD)).rotate(starCamera1.at(i).rotary.inverseRotate(direction))); // Primary
      const Vector3d normS     = rotaryZ(Angle(180*DEG2RAD)).rotate(rotaryX(Angle(-135*DEG2RAD)).rotate(starCamera1.at(i).rotary.inverseRotate(direction))); // Secondary
      const Vector3d norm      = (normP.z() < normS.z()) ? normP : normS;
      const Double foreAft     = RAD2DEG * std::atan(norm.x()/norm.z());
      const Double upDown      = RAD2DEG * std::atan(norm.y()/norm.z());
      const Double width       = 0.6;
      if((std::fabs(foreAft) < 10+width) && (std::fabs(upDown) < 8.5+width) && ((std::fabs(std::fabs(foreAft)-10) < width) || (std::fabs(std::fabs(upDown)-8.5) < width)))
      {
        MiscValueEpoch epoch;
        epoch.time  = orbit1.at(i).time;
        if (std::fabs(std::fabs(upDown)-8.5) < width)
        {
          if (upDown>0)
            epoch.value = ((foreAft>0) ? 5 : 6);
          else
            epoch.value = ((foreAft>0) ? 7 : 8);
        }
        else
          epoch.value = ((foreAft>0) ? 3 : 4);
        arc.push_back(epoch);
      }
    }

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

    // Replace by mid epoch
    // --------------------
    MiscValueArc arcNew;
    Double       type = -1;
    Time         timeStart;
    for(UInt i=0; i<arc.size(); i++)
    {
      if((arc.at(i).value != type) || (arc.at(i).time > arc.at(i-1).time+seconds2time(10*60)))
      {
        arcNew.push_back(arc.at(i));
        timeStart = arc.at(i).time;
        type      = arc.at(i).value;
      }
      if(arc.at(i).value == type)
        arcNew.at(arcNew.size()-1).time = timeStart + 0.5*(arc.at(i).time-timeStart);
    }

    logStatus<<"write events to file<"<<fileNameOut<<">"<<Log::endl;
    InstrumentFile::write(fileNameOut, arcNew);
    Arc::printStatistics(arcNew);

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

    MiscValueArc arcInterval;
    std::vector<Time> time = orbit1.times();
    UInt idx = 0;
    for(UInt idEpoch=0; idEpoch<time.size(); idEpoch++)
    {
      // find event
      while((idx < arcNew.size()) && (arcNew.at(idx).time+seconds2time(marginAfter) < time.at(idEpoch)))
        idx++;
      if(idx >= arcNew.size())
        break;
      if(time.at(idEpoch) < arcNew.at(idx).time-seconds2time(marginBefore))
        continue;

      MiscValueEpoch epoch;
      epoch.time  = time.at(idEpoch);
      epoch.value = arcNew.at(idx).value;
      arcInterval.push_back(epoch);
    }//for

    logStatus<<"write intervals to file<"<<fileNameOutInterval<<">"<<Log::endl;
    InstrumentFile::write(fileNameOutInterval, arcInterval);
    Arc::printStatistics(arcInterval);

    // =============================================
  }
  catch(std::exception &e)
  {
    GROOPS_RETHROW(e)
  }
}

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