The mgrs Reference Manual

Table of Contents

The mgrs Reference Manual

This is the mgrs Reference Manual, version 1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 14:24:08 2020 GMT+0.

1 Introduction

#+TITLE: mgrs

This is a Common Lisp library to convert coordinates between Latitude/Longitude
and MGRS.

* API

In the library, latitude and longitude are represented by real numbers
(degrees), positive for northern latitude and eastern longitudes, and negative
for southern latitude and western longitudes.


#+BEGIN_SRC lisp
(lat/lon->mgrs latitude longitude &optional precision) -> string
#+END_SRC

Return the MGRS locator for the given /latitude/ and /longitude/. The
/precision/ (in meters) of the locator can be 1, 10, 100, 1000, 10000.


#+BEGIN_SRC lisp
(mgrs->lat/lon locator) -> list
#+END_SRC

Return the latitude and longitude for the southwest corner of the given
MGRS /locator/ square.

* Examples

Load the library:

#+BEGIN_SRC lisp
> (asdf:load-system "mgrs")
...
#+END_SRC


Get the MGRS locator of Munich:

#+BEGIN_SRC lisp
> (mgrs:lat/lon->mgrs 48.146660d0 11.60833d0)
"32UPU9401035891"
#+END_SRC


Same thing with a lower precision (100 meters):

#+BEGIN_SRC lisp
> (mgrs:lat/lon->mgrs 48.146660d0 11.60833d0 100)
"32UPU940358"
#+END_SRC


Get back the latitude and longitude of Munich:

#+BEGIN_SRC lisp
> (mgrs:mgrs->lat/lon "32UPU9401035891")
(48.146655723267834d0 11.60832570541976d0)
#+END_SRC

* Tests

The tests require the /fiveam/ library.

#+BEGIN_SRC lisp
(asdf:test-system "mgrs")
#+END_SRC

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 mgrs

Author

Guillaume Le Vaillant

License

GPL-3

Description

Convert coordinates between Latitude/Longitude and MGRS.

Version

1.0

Dependency

utm-ups

Source

mgrs.asd (file)

Component

mgrs.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 mgrs.asd

Location

mgrs.asd

Systems

mgrs (system)

3.1.2 mgrs/mgrs.lisp

Parent

mgrs (system)

Location

mgrs.lisp

Packages

mgrs

Exported Definitions

• lat/lon->mgrs (function)
• mgrs->lat/lon (function)

Internal Definitions

• false-easting (function)
• false-northing (function)
• letter (function)
• letter-position (function)
• mgrs/ups->lat/lon (function)
• mgrs/utm->lat/lon (function)
• minimum-northing (function)
• ups->mgrs (function)
• utm->mgrs (function)

4 Packages

Packages are listed by definition order.

4.1 mgrs

Source

mgrs.lisp (file)

Use List

common-lisp

Exported Definitions

• lat/lon->mgrs (function)
• mgrs->lat/lon (function)

Internal Definitions

• false-easting (function)
• false-northing (function)
• letter (function)
• letter-position (function)
• mgrs/ups->lat/lon (function)
• mgrs/utm->lat/lon (function)
• minimum-northing (function)
• ups->mgrs (function)
• utm->mgrs (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: lat/lon->mgrs LATITUDE LONGITUDE &optional PRECISION

Return the MGRS locator for the given LATITUDE and LONGITUDE. The PRECISION (in meters) of the locator can be 1, 10, 100, 1000, 10000.

Package

mgrs

Source

mgrs.lisp (file)

Function: mgrs->lat/lon LOCATOR

Return the latitude and longitude for the southwest corner of the given MGRS LOCATOR square.

Package

mgrs

Source

mgrs.lisp (file)

5.2 Internal definitions

5.2.1 Functions

Function: false-easting BAND

Return the false easting for a UPS BAND.

Package

mgrs

Source

mgrs.lisp (file)

Function: false-northing BAND

Return the false northing for a UPS BAND.

Package

mgrs

Source

mgrs.lisp (file)

Function: letter N

Return the letter associated to number N.

Package

mgrs

Source

mgrs.lisp (file)

Function: letter-position C

Return the number associated to letter C.

Package

mgrs

Source

mgrs.lisp (file)

Function: mgrs/ups->lat/lon NORTHP BAND SQUARE-X SQUARE-Y EASTING NORTHING

Return tle latitude and longitude for the given MGRS coordinates.

Package

mgrs

Source

mgrs.lisp (file)

Function: mgrs/utm->lat/lon ZONE BAND SQUARE-X SQUARE-Y EASTING NORTHING

Return tle latitude and longitude for the given MGRS coordinates.

Package

mgrs

Source

mgrs.lisp (file)

Function: minimum-northing BAND

Return the minimum northing of a UTM BAND.

Package

mgrs

Source

mgrs.lisp (file)

Function: ups->mgrs NORTHP BAND EASTING NORTHING PRECISION

Return the MGRS locator for the given UPS coordinates.

Package

mgrs

Source

mgrs.lisp (file)

Function: utm->mgrs ZONE BAND EASTING NORTHING PRECISION

Return the MGRS locator for the given UTM coordinates.

Package

mgrs

Source

mgrs.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types