The utm-ups Reference Manual

This is the utm-ups Reference Manual, version 1.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Feb 15 07:47:46 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 utm-ups

Convert coordinates between Latitude/Longitude and UTM or UPS.

Author

Guillaume Le Vaillant

License

GPL-3

Version

1.2

Source

utm-ups.asd.

Child Component

utm-ups.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 utm-ups/utm-ups.asd

Source

utm-ups.asd.

Parent Component

utm-ups (system).

ASDF Systems

utm-ups.


3.1.2 utm-ups/utm-ups.lisp

Source

utm-ups.asd.

Parent Component

utm-ups (system).

Packages

utm-ups.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 utm-ups

Source

utm-ups.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *ellipsoid*

Ellipsoid to use by default.

Package

utm-ups.

Source

utm-ups.lisp.


5.1.2 Ordinary functions

Function: band (latitude longitude)

Return the UTM or UPS band for the given LATITUDE and LONGITUDE.

Package

utm-ups.

Source

utm-ups.lisp.

Function: ellipsoids ()

Return the list of supported ellipsoids.

Package

utm-ups.

Source

utm-ups.lisp.

Function: format-lat/lon (latitude longitude &optional format)

Return the coordinates as a string. If FORMAT is NIL or :DMS, d°m’s" notation will be used for angles. If FORMAT is :DM, d°m’ notation will be used. If FORMAT is T or :D, decimal notation will be used.

Package

utm-ups.

Source

utm-ups.lisp.

Function: format-utm/ups (zone easting northing &optional band)

Return UTM or UPS coordinates as a string. If BAND is not specified, it will be set to "+" for northern zones and to "-" for southern zones.

Package

utm-ups.

Source

utm-ups.lisp.

Function: lat/lon->ups (latitude longitude)

Return the UPS hemisphere, easting and northing for the given LATITUDE and LONGITUDE. The second returned value is the UPS band.

Package

utm-ups.

Source

utm-ups.lisp.

Function: lat/lon->utm (latitude longitude &optional zone)

Return the UTM zone, easting and northing for the given LATITUDE and LONGITUDE. The second returned value is the UTM band. The ZONE parameter can be used to force in which UTM zone the coordinates will be computed.

Package

utm-ups.

Source

utm-ups.lisp.

Function: lat/lon->utm/ups (latitude longitude &optional zone)

Return the UTM or UPS zone, easting and northing for the given LATITUDE and LONGITUDE. The second returned value is the UTM or UPS band. The ZONE parameter can be used to force in which UTM zone the coordinates will be computed.

Package

utm-ups.

Source

utm-ups.lisp.

Function: parse-lat/lon (string)

Return the latitude and longitude represented as a STRING.

Package

utm-ups.

Source

utm-ups.lisp.

Function: parse-utm/ups (string)

Return the UTM or UPS coordinates represented as a STRING.

Package

utm-ups.

Source

utm-ups.lisp.

Function: ups->lat/lon (northp easting northing)

Return the LATITUDE and LONGITUDE for the given UPS hemisphere, EASTING and NORTHING.

Package

utm-ups.

Source

utm-ups.lisp.

Function: ups-band (latitude longitude)

Return the UPS band for the given LATITUDE and LONGITUDE.

Package

utm-ups.

Source

utm-ups.lisp.

Function: utm->lat/lon (zone easting northing)

Return the latitude and longitude for the given UTM ZONE, EASTING and NORTHING.

Package

utm-ups.

Source

utm-ups.lisp.

Function: utm-band (latitude)

Return the UTM band for the given LATITUDE.

Package

utm-ups.

Source

utm-ups.lisp.

Function: utm-zone (latitude longitude)

Return the UTM zone number for the given LATITUDE and LONGITUDE.

Package

utm-ups.

Source

utm-ups.lisp.

Function: utm/ups->lat/lon (zone easting northing)

Return the latitude and longitude for the given UTM or UPS ZONE, EASTING and NORTHING.

Package

utm-ups.

Source

utm-ups.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *ellipsoids*

Ellipsoids used to modelize the earth, defined by an equatorial radius and a squared eccentricity.

Package

utm-ups.

Source

utm-ups.lisp.


5.2.2 Ordinary functions

Function: deg->rad (angle)

Convert ANGLE from radians to degrees.

Package

utm-ups.

Source

utm-ups.lisp.

Function: ellipsoid-e2 (ellipsoid)

Return the squared eccentricity of an ELLIPSOID.

Package

utm-ups.

Source

utm-ups.lisp.

Function: ellipsoid-r (ellipsoid)

Return the equatorial radius of an ELLIPSOID.

Package

utm-ups.

Source

utm-ups.lisp.

Function: rad->deg (angle)

Convert ANGLE from degrees to radians.

Package

utm-ups.

Source

utm-ups.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   B   D   E   F   L   P   R   U  
Index Entry  Section

B
band: Public ordinary functions

D
deg->rad: Private ordinary functions

E
ellipsoid-e2: Private ordinary functions
ellipsoid-r: Private ordinary functions
ellipsoids: Public ordinary functions

F
format-lat/lon: Public ordinary functions
format-utm/ups: Public ordinary functions
Function, band: Public ordinary functions
Function, deg->rad: Private ordinary functions
Function, ellipsoid-e2: Private ordinary functions
Function, ellipsoid-r: Private ordinary functions
Function, ellipsoids: Public ordinary functions
Function, format-lat/lon: Public ordinary functions
Function, format-utm/ups: Public ordinary functions
Function, lat/lon->ups: Public ordinary functions
Function, lat/lon->utm: Public ordinary functions
Function, lat/lon->utm/ups: Public ordinary functions
Function, parse-lat/lon: Public ordinary functions
Function, parse-utm/ups: Public ordinary functions
Function, rad->deg: Private ordinary functions
Function, ups->lat/lon: Public ordinary functions
Function, ups-band: Public ordinary functions
Function, utm->lat/lon: Public ordinary functions
Function, utm-band: Public ordinary functions
Function, utm-zone: Public ordinary functions
Function, utm/ups->lat/lon: Public ordinary functions

L
lat/lon->ups: Public ordinary functions
lat/lon->utm: Public ordinary functions
lat/lon->utm/ups: Public ordinary functions

P
parse-lat/lon: Public ordinary functions
parse-utm/ups: Public ordinary functions

R
rad->deg: Private ordinary functions

U
ups->lat/lon: Public ordinary functions
ups-band: Public ordinary functions
utm->lat/lon: Public ordinary functions
utm-band: Public ordinary functions
utm-zone: Public ordinary functions
utm/ups->lat/lon: Public ordinary functions