geoconvert

Crates.iogeoconvert
lib.rsgeoconvert
version1.0.2
sourcesrc
created_at2024-01-07 23:56:28.981945
updated_at2024-01-23 15:42:16.455783
descriptionA lightweight library to convert between geographic coordinate systems
homepage
repositoryhttps://github.com/ncrothers/geoconvert-rs
max_upload_size
id1092097
size76,602
Nicholas Crothers (ncrothers)

documentation

README

geoconvert

Latest Version Docs

geoconvert is a lightweight library for converting between different geographic coordinate systems. Currently, there are three coordinate systems implemented:

  • LatLon
  • UtmUps
  • Mgrs

The implementation of this library is a translation of a subset of GeographicLib from C++ to Rust. Specifically, geoconvert implements some of the functionality of the GeoConvert command line tool.

Usage

You can create coordinates manually using a struct's create() function, then convert to other types using the to_*/from_* methods.

use geoconvert::{LatLon, Mgrs, UtmUps};

// This returns a result. When calling `create()`, the arguments are validated to ensure only a valid
// coordinate gets created.
let coord = LatLon::create(40.748333, -73.985278).unwrap();

// Convert to a UTM/UPS coordinate
let coord_utm = coord.to_utmups();
let coord_utm = UtmUps::from_latlon(&coord);

// Convert to an MGRS coordinate
// Note that for MGRS you must specify the precision
let coord_mgrs = coord.to_mgrs(6);
let coord_mgrs = Mgrs::from_latlon(&coord, 6);

Features

If you want serde compatibility with Serialize/Deserialize, activate the serde feature.

Testing Accuracy

To test the accuracy compared to GeographicLib yourself, you'll need a dataset of lat/lon and MGRS points. I have a gist that contains a sample dataset of ~100K points generated using Python and converted using GeoConvert. If you'd like to generate your own dataset to validate the accuracy, create files named mgrs.txt and latlon.txt, where mgrs.txt is a list of MGRS coordinates (one per line) and latlon.txt is a list of latitude longitude pairs, each pair internally delimited by a space (i.e. like <latitude> <longitude>). You can use GeoConvert to do the conversion, or use a different source for ground truth.

Once you have these files, place them into tests/ and run:

cargo test -- --include-ignored

The test will fail if the geoconvert conversion differs from the ground truth by a distance of 1mm or more (calculated using the haversine formula). It also prints the average distance error.

Commit count: 0

cargo fmt