From 08fed1de15d262c9137455762e54ac965d2ce9a4 Mon Sep 17 00:00:00 2001 From: Carles Fernandez Date: Tue, 18 Feb 2020 19:49:52 +0100 Subject: [PATCH] Improve README --- src/utils/rinex-tools/README.md | 33 ++++++++++++++++++++++----------- 1 file changed, 22 insertions(+), 11 deletions(-) diff --git a/src/utils/rinex-tools/README.md b/src/utils/rinex-tools/README.md index 2296ce881..0280bec32 100644 --- a/src/utils/rinex-tools/README.md +++ b/src/utils/rinex-tools/README.md @@ -30,16 +30,27 @@ The last step is optional. Without it, you still will get the executable at `../ $ obsdiff --ref_rinex_obs=reference.20o --test_rinex_obs=rover.20o ``` +There is some flexibility in how flags may be specified. The following examples are equivalent: + +``` +$ obsdiff -ref_rinex_obs=reference.20o +$ obsdiff --ref_rinex_obs=reference.20o +$ obsdiff -ref_rinex_obs reference.20o +$ obsdiff --ref_rinex_obs reference.20o +``` + + + Available command-line flags: -| **flag** | **Default value** | **Description** | -|:------------------------:|:-----------------:|:-----------------| -| `--skip_obs_transitory_s` | `30.0` | Skip the initial observable outputs to avoid transitory results [s]. | -| `--skip_obs_ends_s` | `5.0` | Skip the lasts observable outputs to avoid transitory results [s]. | -| `--single_diffs` | `false` | [`true`, `false`]: If `true`, the program also computes the single difference errors for [Carrier Phase](https://gnss-sdr.org/docs/sp-blocks/observables/#carrier-phase-measurement) and [Doppler](https://gnss-sdr.org/docs/sp-blocks/observables/#doppler-shift-measurement) measurements (requires LO synchronization between receivers). | -| `--compare_with_5X` | `false` | [`true`, `false`]: If `true`, the program compares the E5a Doppler and Carrier Phases with the E5 full Bw in RINEX (expect discrepancy due to the center frequencies difference). | -| `--dupli_sat` | `false` | [`true`, `false`]: If `true`, this flag enables special observable test mode where the scenario contains duplicated satellite orbits. | -| `--dupli_sat_prns` | `1,2,3,4` | List of duplicated satellites PRN pairs (_i.e._, `1,2,3,4` indicates that the PRNs 1,2 share the same orbit. The same applies for PRNs 3,4). | -| `--ref_rinex_obs` | `reference.obs` | Filename of reference RINEX observation file. | -| `--test_rinex_obs` | `test.obs` | Filename of tested RINEX observation file. | -| `--show_plots` | `true` | [`true`, `false`]: If `true`, and if [gnuplot](http://www.gnuplot.info/) is found on the system, displays results plots on screen. Please set it to `false` for non-interactive testing. | +| **flag** | **Default value** | **Description** | +|:-------------------------:|:-----------------:|:-----------------| +| `-skip_obs_transitory_s` | `30.0` | Skip the initial observable outputs to avoid transitory results [s]. | +| `-skip_obs_ends_s` | `5.0` | Skip the lasts observable outputs to avoid transitory results [s]. | +| `-single_diffs` | `false` | [`true`, `false`]: If `true`, the program also computes the single difference errors for [Carrier Phase](https://gnss-sdr.org/docs/sp-blocks/observables/#carrier-phase-measurement) and [Doppler](https://gnss-sdr.org/docs/sp-blocks/observables/#doppler-shift-measurement) measurements (requires LO synchronization between receivers). | +| `-compare_with_5X` | `false` | [`true`, `false`]: If `true`, the program compares the E5a Doppler and Carrier Phases with the E5 full Bw in RINEX (expect discrepancy due to the center frequencies difference). | +| `-dupli_sat` | `false` | [`true`, `false`]: If `true`, this flag enables special observable test mode where the scenario contains duplicated satellite orbits. | +| `-dupli_sat_prns` | `1,2,3,4` | List of duplicated satellites PRN pairs (_i.e._, `1,2,3,4` indicates that the PRNs 1,2 share the same orbit. The same applies for PRNs 3,4). | +| `-ref_rinex_obs` | `reference.obs` | Filename of reference RINEX observation file. | +| `-test_rinex_obs` | `test.obs` | Filename of tested RINEX observation file. | +| `-show_plots` | `true` | [`true`, `false`]: If `true`, and if [gnuplot](http://www.gnuplot.info/) is found on the system, displays results plots on screen. Please set it to `false` for non-interactive testing. |