gps-0.8.4: For manipulating GPS coordinates and trails.




A basic GPS library with calculations for distance and speed along with helper functions for filtering/smoothing trails. All distances are in meters and time is in seconds. Speed is thus meters/second



type Distance = DoubleSource

Distances are expressed in meters

type Heading = DoubleSource

Angles are expressed in radians from North. 0 == North pi/2 == West pi == South (32)pi == East == - (pi 2)

type Speed = DoubleSource

Speed is hard coded as meters per second

type Trail a = [a]Source


north :: HeadingSource

North is 0 radians

south :: HeadingSource

South, being 180 degrees from North, is pi.

east :: HeadingSource

East is 270 degrees (3 pi / 2)

west :: HeadingSource

West is 90 degrees (pi/2)

radiusOfEarth :: DoubleSource

radius of the earth in meters

circumferenceOfEarth :: DoubleSource

Circumference of earht (meters)

Coordinate Functions

heading :: (Lat a, Lon a, Lat b, Lon b) => a -> b -> HeadingSource

Direction two points aim toward (0 = North, pi2 = West, pi = South, 3pi2 = East)

distance :: (Lat a, Lon a, Lat b, Lon b) => a -> b -> DistanceSource

speed :: (Lat loc, Lon loc, Time loc, Lat b, Lon b, Time b) => loc -> b -> Maybe SpeedSource

Speed in meters per second, only if a Time was recorded for each waypoint.

getVector :: (Lat a, Lon a, Lat b, Lon b) => a -> b -> VectorSource

addVector :: (Lat c, Lon c) => Vector -> c -> cSource

Given a vector and coordinate, computes a new coordinate. Within some epsilon it should hold that if

dest = addVector (dist,heading) start


heading == heading start dest
dist    == distance start dest

getRadianPair :: (Lat p, Lon p) => p -> (LatitudeType, LongitudeType)Source

Provides a lat/lon pair of doubles in radians

divideArea :: (Lat c, Lon c) => Distance -> Distance -> c -> c -> [[c]]Source

divideArea vDist hDist nw se divides an area into a grid of equally spaced coordinates within the box drawn by the northwest point (nw) and southeast point (se). Because this uses floating point there might be a different number of points in some rows (the last might be too far east based on a heading from the se point).

interpolate :: (Lat a, Lon a) => a -> a -> Double -> aSource

IO helpers

readGPX :: FilePath -> IO (Trail WptType)Source

Reads a GPX file (using the GPX library) by simply concatenating all the tracks, segments, and points (trkpts, trksegs, trks) into a single Trail.



data AvgMethod c Source



Obtain the mean of the considered points


Obtain the harmonicMean


Obtain the geometricMean


Obtain the median of the considered points


Compute the speed considering only the given endpoints

AvgMinOf [AvgMethod c]

Take the minimum of the speeds from the given methods

AvgWith ([c] -> Speed) 

data Selected a Source

When grouping points, lists of points are either marked as Select or NotSelect.




unSelect :: a


unSelect :: a


Functor Selected 
Eq a => Eq (Selected a) 
Ord a => Ord (Selected a) 
Show a => Show (Selected a) 

type PointGrouping c = Trail c -> [Selected (Trail c)]Source

A PointGrouping is a function that selects segments of a trail.

Grouping point _does not_ result in deleted points. It is always true that:

forall g :: PointGrouping c --> concatMap unSelect (g ts) == ts

The purpose of grouping is usually for later processing. Any desire to drop points that didn't meet a particular grouping criteria can be filled with a composition with filter (or directly via filterPoints).

type TransformGrouping c = [Selected (Trail c)] -> [Selected (Trail c)]Source

Given a selection of coordinates, transform the selected coordinates in some way (while leaving the non-selected coordinates unaffected).

Utility Functions

onSelected :: (a -> b) -> (a -> b) -> Selected a -> bSource

Trail Functions


totalDistance :: (Lat a, Lon a) => [a] -> DistanceSource

Find the total distance traveled

avgSpeeds :: (Lat a, Lon a, Time a) => NominalDiffTime -> Trail a -> [(UTCTime, Speed)]Source

avgSpeeds n points Average speed using a window of up to n seconds and averaging by taking the Median (AvgMedian).

slidingAverageSpeed :: (Lat a, Lon a, Time a) => AvgMethod a -> NominalDiffTime -> Trail a -> [(UTCTime, Speed)]Source

slidingAverageSpeed m n Average speed using a moving window of up to n seconds and an AvgMethod of m.

closestDistance :: (Lat a, Lon a) => Trail a -> Trail a -> Maybe DistanceSource

Returns the closest distance between two trails (or Nothing if a trail is empty). Inefficient implementation: O( (n * m) * log (n * m) )

convexHull :: (Eq c, Lat c, Lon c) => [c] -> [c]Source

Uses Grahams scan to compute the convex hull of the given points. This operation requires sorting of the points, so don't try it unless you have notably more memory than the list of points will consume.


bezierCurveAt :: (Lat a, Lon a, Time a) => [UTCTime] -> Trail a -> Trail aSource

Construct a bezier curve using the provided trail. Construct a new trail by sampling the given bezier curve at the given times. The current implementation assumes the times of the input coordinates are available and all equal (Ex: all points are 5 seconds apart), the results will be poor if this is not the case!

bezierCurve :: (Lat a, Lon a, Time a) => [Selected (Trail a)] -> Trail aSource

Interpolate selected points onto a bezier curve. Note this gets exponentially more expensive with the length of the segement being transformed - it is not advisable to perform this operation on trail segements with more than ten points!

linearTime :: (Lon a, Lat a, Time a) => [a] -> [a]Source

Filters out any points that go backward in time (thus must not be valid if this is a trail)

filterPoints :: PointGrouping a -> Trail a -> Trail aSource

Remove all points that remain NotSelected by the given grouping algorithm.

Grouping Methods

betweenSpeeds :: (Lat a, Lon a, Time a) => Double -> Double -> PointGrouping aSource

Groups trail segments into contiguous points within the speed and all others outside of the speed. The speed from point p(i) to p(i+1) is associated with p(i) (execpt for the first speed value, which is associated with both the first and second point)

restLocations :: (Lat a, Lon a, Time a) => Distance -> NominalDiffTime -> PointGrouping aSource

A rest point means the coordinates remain within a given distance for at least a particular amount of time.

spansTime :: (Lat a, Lon a, Time a) => NominalDiffTime -> PointGrouping aSource

chunking points into groups spanning at most the given time interval.

everyNPoints :: Int -> PointGrouping aSource

chunk the trail into groups of N points

Group Transformations

intersectionOf :: (Lat a, Lon a, Time a) => [PointGrouping a] -> PointGrouping aSource

intersects the given groupings

invertSelection :: TransformGrouping aSource

Inverts the selected/nonselected segments

firstGrouping :: TransformGrouping aSource

firstGrouping f ps only the first segment remains Selected, and only if it was already selected by f.

lastGrouping :: TransformGrouping aSource

Only the last segment, if any, is selected (note: the current implementation is inefficient, using reverse)

unionOf :: (Lat a, Lon a, Time a) => [PointGrouping a] -> PointGrouping aSource

Union all the groupings

refineGrouping :: PointGrouping a -> TransformGrouping aSource

For every selected group, refine the selection using the second grouping method. This differs from IntersectionOf by restarting the second grouping algorithm at the beginning each group selected by the first algorithm.

(/\) :: [Selected (Trail a)] -> TransformGrouping aSource

Intersection binary operator

(\/) :: [Selected (Trail a)] -> TransformGrouping aSource

Union binary operator

Composite Operations (Higher Level)

smoothRests :: (Lat a, Lon a, Time a) => Trail a -> Trail aSource

smoothSome :: (Lat a, Lon a, Time a) => Trail a -> Trail aSource

smoothMore :: (Lat a, Lon a, Time a) => Trail a -> Trail aSource


bezierPoint :: (Lat a, Lon a) => [a] -> Double -> aSource