source: project/wiki/eggref/4/geo-utils @ 34131

[[tags: egg]]

== geo-utils

Geographic Utilities

[[toc:]]


== Documentation

API for constructing and manipulating geographic data.

=== Usage

<enscript language=scheme>
(require-extension geopoint)
</enscript>

=== Argument Conventions

; {{GP}} : {{geopoint}}.
; {{LAT}} : latitude {{real}}.
; {{LON}} : longitude {{real}}.

=== make-geopoint

<procedure>(make-geopoint LAT LON) => geopoint</procedure>

=== geopoint?

<procedure>(geopoint? OBJ) => boolean</procedure>

=== check-geopoint

<procedure>(check-geopoint LOC OBJ [VARNAM]) => geopoint</procedure>

=== error-geopoint

<procedure>(error-geopoint LOC OBJ [VARNAM])</procedure>

=== geopoint-latitude

<procedure>(geopoint-latitude GP) => real</procedure>

=== geopoint-longitude

<procedure>(geopoint-longitude GP) => real</procedure>

=== geopoint-strictly-above

<procedure>(geopoint-strictly-above GP1 GP2) => boolean</procedure>

=== geopoint-above

<procedure>(geopoint-above GP1 GP2) => boolean</procedure>

=== geopoint-strictly-below

<procedure>(geopoint-strictly-below GP1 GP2) => boolean</procedure>

=== geopoint-below

<procedure>(geopoint-below GP1 GP2) => boolean</procedure>

=== geopoint-strictly-left

<procedure>(geopoint-strictly-left GP1 GP2) => boolean</procedure>

=== geopoint-left

<procedure>(geopoint-left GP1 GP2) => boolean</procedure>

=== geopoint-strictly-right

<procedure>(geopoint-strictly-right GP1 GP2) => boolean</procedure>

=== geopoint-right

<procedure>(geopoint-right GP1 GP2) => boolean</procedure>

=== geopoint=

<procedure>(geopoint= GP1 GP2) => boolean</procedure>

=== geopoint<

<procedure>(geopoint< GP1 GP2) => boolean</procedure>

=== geopoint>

<procedure>(geopoint> GP1 GP2) => boolean</procedure>

=== geopoint<=

<procedure>(geopoint<= GP1 GP2) => boolean</procedure>

=== geopoint>=

<procedure>(geopoint>= GP1 GP2) => boolean</procedure>


=== Usage

<enscript language=scheme>
(require-extension geobox)
</enscript>

=== Argument Conventions

; {{GB}} : {{geobox}}.

=== make-geobox

<procedure>(make-geobox GP-MIN GP-MAX) => geobox</procedure>

=== geobox?

<procedure>(geobox? OBJ) => boolean</procedure>

=== check-geobox

<procedure>(check-geobox LOC OBJ [VARNAM]) => geobox</procedure>

=== error-geobox

<procedure>(error-geobox LOC OBJ [VARNAM])</procedure>

=== geobox-minimum

<procedure>(geobox-minimum GB) => geopoint</procedure>

=== geobox-maximum

<procedure>(geobox-maximum GB) => geopoint</procedure>

=== geobox=

<procedure>(geobox= GB1 GB2) => boolean</procedure>

=== geobox<

<procedure>(geobox< GB1 GB2) => boolean</procedure>

=== geobox>

<procedure>(geobox> GB1 GB2) => boolean</procedure>

=== geobox<=

<procedure>(geobox<= GB1 GB2) => boolean</procedure>

=== geobox>=

<procedure>(geobox>= GB1 GB2) => boolean</procedure>

=== geopoint-within-box

<procedure>(geopoint-within-box GP GB) => boolean</procedure>


=== Usage

<enscript language=scheme>
(require-extension geopolygon)
</enscript>

=== Argument Conventions

; {{GPOLY}} : {{geopolygon}}.

=== make-geopolygon

<procedure>(make-geopolygon GP-COLL) => geopolygon</procedure>

{{GP-COLL}} is {{list}} or {{vector}} of {{geopoint}}.

=== geopolygon?

<procedure>(geopolygon? OBJ) => boolean</procedure>

=== check-geopolygon

<procedure>(check-geopolygon LOC OBJ [VARNAM]) => geopolygon</procedure>

=== error-geopolygon

<procedure>(error-geopolygon LOC OBJ [VARNAM])</procedure>

=== geopolygon

<procedure>(geopolygon GP...) => geopolygon</procedure>

=== geopolygon-closed?

<procedure>(geopolygon-closed? GPOLY) => boolean</procedure>

Polygon has the same initial and final {{geopoint}}.

=== geopolygon-open?

<procedure>(geopolygon-open? GPOLY) => boolean</procedure>

Polygon does not have the same initial and final {{geopoint}}.

=== geopolygon-bounding-box

<procedure>(geopolygon-bounding-box GPOLY) => geobox</procedure>


=== Usage

<enscript language=scheme>
(require-extension geopoint-utils)
</enscript>

=== geopoint-in-closed-polygon?

<procedure>(geopoint-in-closed-polygon? GP GPOLY) => boolean</procedure>

Treats an open geopolygon as closed.


=== Usage

<enscript language=scheme>
(require-extension geo-utils)
</enscript>

=== earth-flattening

<variable>earth-flattening</variable>

=== earth-radius-miles

<variable>earth-radius-miles</variable>

=== earth-radius-kilometers

<variable>earth-radius-kilometers</variable>


=== pythagorean-distance

<procedure>(pythagorean-distance LAT1 LON1 LAT2 LON2) => real</procedure>

=== pythagorean-distance*

<procedure>(pythagorean-distance* LAT1 LON1 LAT2 LON2) => real</procedure>

=== spherical-surface-distance

<procedure>(spherical-surface-distance LAT1 LON1 LAT2 LON2 (R EARTH-RADIUS-MILES)) => real</procedure>

=== great-circle-distance

<procedure>(great-circle-distance LAT1 LON1 LAT2 LON2 (R EARTH-RADIUS-MILES)) => real</procedure>

=== great-circle-distance-radians

<procedure>(great-circle-distance-radians LAT1 LON1 LAT2 LON2 (R EARTH-RADIUS-MILES)) => real</procedure>

=== approximate-ellipsoid-distance

<procedure>(approximate-ellipsoid-distance LAT1 LON1 LAT2 LON2 (R EARTH-RADIUS-MILES)) => real</procedure>

=== great-circle-azimuth

<procedure>(great-circle-azimuth LAT1 LON1 LAT2 LON2 [PREC 5]) => real</procedure>

=== great-circle-position

<procedure>(great-circle-position LAT LON DIS AZI (R EARTH-RADIUS-MILES)) => (values latitude longitude)</procedure>


=== Usage

<enscript language=scheme>
(require-extension geo-dms)
</enscript>

=== Argument Conventions

; {{D}} : degrees {{real}}.
; {{M}} : minutes {{real}}.
; {{S}} : seconds {{real}}.
; {{LAT?}} : latitude? {{boolean}}.
; {{PAD}} : padding between elements {{string}}.

=== degree-minute-second-text

<procedure>(degree-minute-second-text [DMS-TEXT]) => (list-of string)</procedure>

{{DMS-TEXT}} is a 3 element {{list}} of {{string}} of the form {{(<degrees
suffix> <minutes suffix> <seconds suffix>)}}.

=== dms->degree

<procedure>(dms->degree D M S) => real</procedure>

=== degree->dms

<procedure>(degree->dms DEG) => (values D M S)</procedure>

Returns the degree+minutes+seconds for the degrees {{DEG}} {{real}}.

=== dms->string

<procedure>(dms->string D M S [LAT? [LEADING-DIR? [PAD ""]]]) => string</procedure>

; {{LEADING-DIR?}} : compass direction is prefix?

Example: 122°45'10"W

=== dms->string*

<procedure>(dms->string* D M S [PAD ""]) => string</procedure>

Example: 122°45'10"

=== string-dms->degree

<procedure>(string-dms->degree STR [LAT?]) => real</procedure>

Returns the degrees for string form of dms {{STR}}.


== Bugs & Limitations

* Probably some.


== Notes

* The relational predicates are rather useless.

* Incomplete.


== Author

[[/users/kon-lovett|Kon Lovett]]


== Version history

; 0.1.0 : Hello


== License

Copyright (C) 2017 Kon Lovett.  All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the Software),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ASIS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.