mirror of
https://github.com/gnss-sdr/gnss-sdr
synced 2024-12-15 04:30:33 +00:00
Improve README
This commit is contained in:
parent
96889b5b74
commit
17d6034e72
@ -9,7 +9,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
|
||||
SPDX-FileCopyrightText: Javier Arribas, 2020. <jarribas@cttc.es>
|
||||
)
|
||||
|
||||
This program computes Single-difference and Double-difference from RINEX observation files.
|
||||
This program computes single-differences and double-differences from RINEX observation files.
|
||||
|
||||
## Building
|
||||
|
||||
@ -30,7 +30,7 @@ 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:
|
||||
There is some flexibility in how command-line flags may be specified. The following examples are equivalent:
|
||||
|
||||
```
|
||||
$ obsdiff -ref_rinex_obs=reference.20o
|
||||
@ -39,18 +39,28 @@ $ obsdiff -ref_rinex_obs reference.20o
|
||||
$ obsdiff --ref_rinex_obs reference.20o
|
||||
```
|
||||
|
||||
For boolean flags, the possibilities are slightly different:
|
||||
```
|
||||
$ obsdiff --single_diffs
|
||||
$ obsdiff --nosingle_diffs
|
||||
$ obsdiff --single_diffs=true
|
||||
$ obsdiff --single_diffs=false
|
||||
```
|
||||
|
||||
(as well as the single-dash variant on all of these).
|
||||
|
||||
Despite this flexibility, we recommend using only a single form: `--variable=value` for non-boolean flags, and `--variable/--novariable` for boolean flags.
|
||||
|
||||
Available command-line flags:
|
||||
|
||||
| **Command-line 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. |
|
||||
| `--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. |
|
||||
|
Loading…
Reference in New Issue
Block a user