kshana 0.32.0

Open, reproducible PNT-resilience simulator with quantum-sensor performance models
Documentation
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
// SPDX-License-Identifier: AGPL-3.0-only
//! The units-and-provenance table of the `leo-pvt` report: one [`FieldUnit`] per numeric
//! field.
//!
//! A declarative catalog and nothing else. It lives in its own file so that the
//! copy-paste detector's exemption for catalogs (`sonar.cpd.exclusions`) covers the table
//! and no logic. [`super::pvt_kind`] re-exports it under its original path.

use crate::field_schema::{FieldUnit, ProvenanceClass::*};

/// Units of the `leo-pvt` report.
pub const PVT_UNITS: &[FieldUnit] = &[
    FieldUnit {
        path: "duration_s",
        unit: "s",
        provenance: Input,
        definition: "span of the run",
    },
    FieldUnit {
        path: "step_s",
        unit: "s",
        provenance: Input,
        definition: "epoch spacing",
    },
    FieldUnit {
        path: "user_lat_deg",
        unit: "deg",
        provenance: Input,
        definition: "user geodetic latitude",
    },
    FieldUnit {
        path: "user_lon_deg",
        unit: "deg",
        provenance: Input,
        definition: "user east longitude",
    },
    FieldUnit {
        path: "systems[].n_satellites",
        unit: "count",
        provenance: Input,
        definition: "satellites of the system",
    },
    FieldUnit {
        path: "systems[].mean_altitude_km",
        unit: "km",
        provenance: Computed,
        definition: "mean altitude of the semi-major axes",
    },
    FieldUnit {
        path: "systems[].carrier_hz",
        unit: "Hz",
        provenance: Input,
        definition: "carrier frequency (preset or scenario)",
    },
    FieldUnit {
        path: "systems[].cn0_dbhz[]",
        unit: "dB-Hz",
        provenance: ModelledInput,
        definition: "C/N0 at the elevation mask and at the zenith",
    },
    FieldUnit {
        path: "systems[].sisre_m",
        unit: "m",
        provenance: ModelledInput,
        definition: "signal-in-space range error of orbit and clock, one sigma",
    },
    FieldUnit {
        path: "systems[].sigma_pr_30deg_m",
        unit: "m",
        provenance: Modelled,
        definition:
            "pseudorange one-sigma at 30 deg elevation: loop noise at C/N0 combined with the SISRE",
    },
    FieldUnit {
        path: "systems[].sigma_range_rate_mps",
        unit: "m/s",
        provenance: Modelled,
        definition: "range-rate one-sigma: wavelength times the Doppler one-sigma",
    },
    FieldUnit {
        path: "doppler.n_obs",
        unit: "count",
        provenance: Computed,
        definition: "range-rate measurements in the full fit",
    },
    FieldUnit {
        path: "doppler.n_sats",
        unit: "count",
        provenance: Computed,
        definition: "distinct satellites in the full fit",
    },
    FieldUnit {
        path: "doppler.height_sigma_m",
        unit: "m",
        provenance: Input,
        definition: "one-sigma of the height constraint",
    },
    FieldUnit {
        path: "doppler.error_3d_m",
        unit: "m",
        provenance: Modelled,
        definition: "3D position error of the full batch Doppler fit",
    },
    FieldUnit {
        path: "doppler.horizontal_error_m",
        unit: "m",
        provenance: Modelled,
        definition: "horizontal position error of the full fit",
    },
    FieldUnit {
        path: "doppler.sigma_enu_m[]",
        unit: "m",
        provenance: Modelled,
        definition: "formal one-sigma east, north, up of the full fit",
    },
    FieldUnit {
        path: "doppler.velocity_error_mps",
        unit: "m/s",
        provenance: Modelled,
        definition: "velocity error when the velocity is estimated",
    },
    FieldUnit {
        path: "doppler.drift_error_mps",
        unit: "m/s",
        provenance: Modelled,
        definition: "clock-drift error of the fit",
    },
    FieldUnit {
        path: "doppler.weighted_rms",
        unit: "1",
        provenance: InternalConsistency,
        definition: "weighted post-fit residual RMS; near 1 when the sigmas describe the noise",
    },
    FieldUnit {
        path: "doppler.windows[].window_s",
        unit: "s",
        provenance: Input,
        definition: "window length from the start of the run",
    },
    FieldUnit {
        path: "doppler.windows[].t_s",
        unit: "s",
        provenance: Input,
        definition: "time of the fix after the start of the run: the window's end",
    },
    FieldUnit {
        path: "doppler.windows[].n_obs",
        unit: "count",
        provenance: Computed,
        definition: "measurements in the window",
    },
    FieldUnit {
        path: "doppler.windows[].n_sats",
        unit: "count",
        provenance: Computed,
        definition: "distinct satellites in the window",
    },
    FieldUnit {
        path: "doppler.windows[].error_3d_m",
        unit: "m",
        provenance: Modelled,
        definition: "3D error of the fit over the window",
    },
    FieldUnit {
        path: "doppler.windows[].horizontal_error_m",
        unit: "m",
        provenance: Modelled,
        definition: "horizontal error of the fit over the window",
    },
    FieldUnit {
        path: "doppler.windows[].sigma_horizontal_m",
        unit: "m",
        provenance: Modelled,
        definition: "formal horizontal one-sigma of the fit over the window",
    },
    FieldUnit {
        path: "doppler.envelopes[].*.max_doppler_hz",
        unit: "Hz",
        provenance: Computed,
        definition: "largest absolute Doppler shift",
    },
    FieldUnit {
        path: "doppler.envelopes[].*.max_doppler_rate_hz_s",
        unit: "Hz/s",
        provenance: Computed,
        definition: "largest absolute Doppler rate",
    },
    FieldUnit {
        path: "doppler.envelopes[].*.max_doppler_jerk_hz_s2",
        unit: "Hz/s^2",
        provenance: Computed,
        definition: "largest absolute rate of change of the Doppler rate",
    },
    FieldUnit {
        path: "doppler.single_pass[].cross_track_offset_km",
        unit: "km",
        provenance: Input,
        definition: "user distance from the ground track at closest approach",
    },
    FieldUnit {
        path: "doppler.single_pass[].max_elevation_deg",
        unit: "deg",
        provenance: Computed,
        definition: "highest elevation of the pass",
    },
    FieldUnit {
        path: "doppler.single_pass[].pass_duration_s",
        unit: "s",
        provenance: Computed,
        definition: "time above the mask",
    },
    FieldUnit {
        path: "doppler.single_pass[].n_obs",
        unit: "count",
        provenance: Computed,
        definition: "measurements over the pass",
    },
    FieldUnit {
        path: "doppler.single_pass[].sigma_along_m",
        unit: "m",
        provenance: Modelled,
        definition: "formal along-track one-sigma of the single-pass fit",
    },
    FieldUnit {
        path: "doppler.single_pass[].sigma_cross_m",
        unit: "m",
        provenance: Modelled,
        definition: "formal cross-track one-sigma of the single-pass fit",
    },
    FieldUnit {
        path: "doppler.single_pass[].sigma_up_m",
        unit: "m",
        provenance: Modelled,
        definition: "formal vertical one-sigma of the single-pass fit",
    },
    FieldUnit {
        path: "joint.*.availability",
        unit: "1",
        provenance: Computed,
        definition: "fraction of epochs with a fix",
    },
    FieldUnit {
        path: "joint.*.median_pdop",
        unit: "1",
        provenance: Computed,
        definition: "median position dilution of precision",
    },
    FieldUnit {
        path: "joint.*.rms_error_3d_m",
        unit: "m",
        provenance: Modelled,
        definition: "RMS 3D error of the seeded fixes",
    },
    FieldUnit {
        path: "joint.*.median_sigma_3d_m",
        unit: "m",
        provenance: Modelled,
        definition: "median formal 3D one-sigma",
    },
    FieldUnit {
        path: "joint.fraction_epochs_with_leo",
        unit: "1",
        provenance: Computed,
        definition: "fraction of epochs with at least one LEO ranging satellite in view",
    },
    FieldUnit {
        path: "joint.isb_estimates[][]",
        unit: "m",
        provenance: Modelled,
        definition:
            "median estimated inter-system bias of each system with its own clock, fused fix",
    },
    FieldUnit {
        path: "joint.isb_truth[][]",
        unit: "m",
        provenance: Input,
        definition: "true inter-system bias used to simulate each system's pseudoranges",
    },
    FieldUnit {
        path: "joint.dop_sweep[].n_leo",
        unit: "count",
        provenance: Input,
        definition: "LEO satellites added to the GNSS geometry, highest elevation first",
    },
    FieldUnit {
        path: "joint.dop_sweep[].median_pdop",
        unit: "1",
        provenance: Computed,
        definition: "median PDOP over epochs with that many LEO satellites in view",
    },
    FieldUnit {
        path: "joint.dop_sweep[].median_hdop",
        unit: "1",
        provenance: Computed,
        definition: "median HDOP",
    },
    FieldUnit {
        path: "joint.dop_sweep[].median_vdop",
        unit: "1",
        provenance: Computed,
        definition: "median VDOP",
    },
    FieldUnit {
        path: "joint.dop_sweep[].n_epochs",
        unit: "count",
        provenance: Computed,
        definition: "epochs contributing",
    },
    FieldUnit {
        path: "joint.epochs[].t_s",
        unit: "s",
        provenance: Computed,
        definition: "time from the start",
    },
    FieldUnit {
        path: "joint.epochs[].n_gnss",
        unit: "count",
        provenance: Computed,
        definition: "GNSS satellites in view",
    },
    FieldUnit {
        path: "joint.epochs[].n_leo",
        unit: "count",
        provenance: Computed,
        definition: "LEO ranging satellites in view",
    },
    FieldUnit {
        path: "joint.epochs[].pdop_gnss",
        unit: "1",
        provenance: Computed,
        definition: "PDOP of the GNSS-only fix",
    },
    FieldUnit {
        path: "joint.epochs[].pdop_fused",
        unit: "1",
        provenance: Computed,
        definition: "PDOP of the fused fix",
    },
    FieldUnit {
        path: "joint.epochs[].error_gnss_m",
        unit: "m",
        provenance: Modelled,
        definition: "3D error of the GNSS-only fix",
    },
    FieldUnit {
        path: "joint.epochs[].error_fused_m",
        unit: "m",
        provenance: Modelled,
        definition: "3D error of the fused fix",
    },
    FieldUnit {
        path: "joint.epochs[].error_leo_m",
        unit: "m",
        provenance: Modelled,
        definition: "3D error of the LEO-only fix",
    },
    FieldUnit {
        path: "polar.pdop_threshold",
        unit: "1",
        provenance: Input,
        definition: "PDOP threshold for availability",
    },
    FieldUnit {
        path: "polar.rows[].lat_deg",
        unit: "deg",
        provenance: Input,
        definition: "latitude",
    },
    FieldUnit {
        path: "polar.rows[].*.mean_in_view",
        unit: "count",
        provenance: Computed,
        definition: "mean satellites in view",
    },
    FieldUnit {
        path: "polar.rows[].*.median_pdop",
        unit: "1",
        provenance: Computed,
        definition: "median PDOP",
    },
    FieldUnit {
        path: "polar.rows[].*.median_hdop",
        unit: "1",
        provenance: Computed,
        definition: "median HDOP",
    },
    FieldUnit {
        path: "polar.rows[].*.median_vdop",
        unit: "1",
        provenance: Computed,
        definition: "median VDOP",
    },
    FieldUnit {
        path: "polar.rows[].*.availability",
        unit: "1",
        provenance: Computed,
        definition: "fraction of samples with PDOP at or below the threshold",
    },
    FieldUnit {
        path: "timing.utc_offset_s",
        unit: "s",
        provenance: ClosedForm,
        definition: "system-time-to-UTC offset at the start, IS-GPS-200 20.3.3.5.2.4 expression",
    },
    FieldUnit {
        path: "timing.utc_time_of_day_s",
        unit: "s",
        provenance: ClosedForm,
        definition: "UTC time of day at the start",
    },
    FieldUnit {
        path: "timing.utc_sigma_s",
        unit: "s",
        provenance: ModelledInput,
        definition: "one-sigma of the broadcast UTC offset",
    },
    FieldUnit {
        path: "timing.median_measurement_sigma_s",
        unit: "s",
        provenance: Modelled,
        definition: "median one-epoch clock-measurement one-sigma at the nominal C/N0",
    },
    FieldUnit {
        path: "timing.rows[].cn0_offset_db",
        unit: "dB",
        provenance: Input,
        definition: "C/N0 offset applied to every system",
    },
    FieldUnit {
        path: "timing.rows[].stats.rms_s",
        unit: "s",
        provenance: Modelled,
        definition: "RMS time error to UTC",
    },
    FieldUnit {
        path: "timing.rows[].stats.p95_s",
        unit: "s",
        provenance: Modelled,
        definition: "95th percentile of the absolute time error",
    },
    FieldUnit {
        path: "timing.rows[].stats.max_abs_s",
        unit: "s",
        provenance: Modelled,
        definition: "largest absolute time error",
    },
    FieldUnit {
        path: "timing.rows[].stats.median_predicted_sigma_s",
        unit: "s",
        provenance: Modelled,
        definition: "median predicted one-sigma including the UTC-offset term",
    },
    FieldUnit {
        path: "timing.rows[].stats.max_predicted_sigma_s",
        unit: "s",
        provenance: Modelled,
        definition: "largest predicted one-sigma",
    },
    FieldUnit {
        path: "timing.rows[].stats.fraction_in_view",
        unit: "1",
        provenance: Computed,
        definition: "fraction of epochs with a LEO satellite in view",
    },
    FieldUnit {
        path: "timing.rows[].stats.longest_gap_s",
        unit: "s",
        provenance: Computed,
        definition: "longest interval without a satellite",
    },
    FieldUnit {
        path: "timing.rows[].stats.rms_normalised",
        unit: "1",
        provenance: InternalConsistency,
        definition: "RMS of the error over its predicted sigma; near 1 when consistent",
    },
    FieldUnit {
        path: "timing.rows[].series[].t_s",
        unit: "s",
        provenance: Computed,
        definition: "seconds after the start of the run",
    },
    FieldUnit {
        path: "timing.rows[].series[].error_ns",
        unit: "ns",
        provenance: Computed,
        definition: "time error against UTC at this epoch, the UTC-offset error included",
    },
    FieldUnit {
        path: "timing.rows[].series[].sigma_ns",
        unit: "ns",
        provenance: Computed,
        definition: "the filter's predicted one-sigma at this epoch, UTC-offset term included",
    },
];