Crate rinex

source ·
Expand description

§RINEX

crates.io rustc crates.io

RINEX is a crate in the GeoRust ecosystem that aims at supporting most common RINEX formats, for both data analysis and data production, without performance compromises.

One of its objectives is to be a credible modern alternative to tools like teqc.

§File naming conventions

In this current form, the parser disregards file names and conventions. Although we aim at providing methods that help generate files that respect the standards, in file production context.

§RINEX Standards

This library was built to support RINEX V4 completely, but efforts were made to also support older revisions too.

All revisions are supported when parsing. Some restrictions still apply in file production context, see the front page table.

§Crate features

One crate feature per supported RINEX format exists.
For example, nav enables RINEX Navigation specific methods.

The qc feature enables a set of structures for RINEX file quality analysis.

The processing feature enables the Preprocessing toolkit to resample, filter and sort RINEX datasets prior further analysis.

The flate2 feature enables native gz decompression.
If this feature is not enabled, one must first uncompress .gz files prior parsing.

The sbas feature enables one method to select appropriate augmentation system based on current location on Earth.

Compile with full to support all features.

§License

Licensed under either of:

Re-exports§

Modules§

  • Antex (ATX) - special RINEX, for antenna caracteristics
  • Carrier channels and associated methods
  • RINEX Clock files parser & analysis
  • COSPAR ID number
  • Epoch parsing helpers
  • Hardware: receiver, antenna informations
  • RINEX compression / decompression module
  • Describes a RINEX file header.
  • IONEX module
  • Geodetic marker description
  • RINEX File merging (combination)
  • Meteo RINEX module
  • NAV RINEX module
  • Observation RINEX module
  • Package to include all basic structures
  • preprocessingprocessing
    Package to include all preprocessing methods like filtering, data smoothing and masking.
  • Package dedicated to file production.
  • Buffered Reader wrapper, for efficient data reading and integrated .gz decompression.
  • RINEX File splitting operation
  • RINEX types description
  • RINEX revision description
  • Generic Buffered Writer, for efficient record production, with integrated optionnal .gz compression

Macros§

Structs§

  • Rinex describes a RINEX file, it comprises a Header section, and a record::Record file body.
    This parser can also store comments encountered while parsing the file body, stored as record::Comments, without much application other than presenting all encountered data at the moment.
    Following is an example of high level usage (mainly header fields).
    For each RINEX type you get a method named after that type, which exposes the whole dataset, for example Self::meteo for Meteo RINEX. Other (high level information, calculations) are type dependent and contained in a specific crate feature.

Enums§

  • Important articles and references that proved useful when designing this library
  • RINEX Parsing related errors