Add pyproj post.
[blog.git] / posts / pyproj.mdwn
1 [pyproj][] is a Python wrapper around [PROJ.4][].  Here's a quick
2 walkthrough.
3
4 Initialize a [geodetic][] converter:
5
6     >>> from pyproj import Geod
7     >>> g = Geod(ellps='clrk66')
8
9 where `ellps='clrk66'` selects [Clarke's 1866][clrk66] [reference
10 ellipsoid][rell].  `help(Geod.__new__)` gives a list of possible
11 ellipsoids.
12
13 Calculate the distance between two points, as well as the local
14 heading, try
15
16     >>> lat1,lng1 = (40.7143528, -74.0059731)  # New York, NY
17     >>> lat2,lng2 = (49.261226, -123.1139268)   # Vancouver, Canada
18     >>> az12,az21,dist = g.inv(lng1,lat1,lng2,lat2)
19     >>> az12,az21,dist
20     (-59.10918706123901, 84.99453463527395, 3914198.2912370963)
21
22 which gives forward and back [azimuths][] as well as the geodesic
23 distance in meters.  Not that longitude comes *before* latitude in the
24 these pyproj argument lists.
25
26 Calculate the terminus of a geodesic from an initial point, azimuth,
27 and distance with:
28
29     >>> lng3,lat3,az3 = g.fwd(lng1,lat1,az12, dist)
30     >>> lat3,lng3,az3
31     (49.26122600306212, -123.11392684861474, 84.99453467574762)
32
33 Plan your trip with:
34
35     >>> pts = g.npts(lng1,lat1,lng2,lat2,npts=5)
36     >>> pts.insert(0, (lng1, lat1))
37     >>> pts.append((lng2, lat2))
38     >>> import numpy
39     >>> npts = numpy.array(pts)
40     >>> npts
41     array([[ -74.0059731 ,   40.7143528 ],
42            [ -80.93566289,   43.52686057],
43            [ -88.48167748,   45.87969433],
44            [ -96.61187851,   47.6930911 ],
45            [-105.22271807,   48.89347605],
46            [-114.13503215,   49.42510006],
47            [-123.1139268 ,   49.261226  ]])
48
49 To plot the above New York to Vancouver route on a flat map, we need a
50 `Proj` instance:
51
52     >>> from pyproj import Proj
53     >>> awips221 = Proj(proj='lcc', R=6371200, lat_1=50, lat_2=50,
54     ...     lon_0=-107, ellps='clrk66')
55     >>> awips218 = Proj(proj='lcc', R=6371200, lat_1=25, lat_2=25,
56     ...     lon_0=-95, ellps='clrk66')  #x_0=-llcrnrx,y_0=-llcrnry)
57
58     #llcrnrlon,llcrnrlat are lon and lat (in degrees) of lower
59     #    left hand corner of projection region.
60
61 where `proj='lcc` selects the [Lambert conformal conic][lcc]
62 projection for the x/y points, and `ellps='clrk66'` selects the
63 reference ellipsoid for the lat/lng coordinates.  The other
64 coordinates are LCC parameters that select the [AWIPS 221][awips221]
65 and [AWIPS 226][awips226] projections respectively (`lat_1`
66 corresponds to `Latin1`, `lat_2` corresponds to `Latin2`, and `lon_0`
67 corresponds to `Lov`).
68
69 Convert our lat/lng pairs into grid points:
70
71     >>> awips221(lng1, lat1)
72     (2725283.842678774, 5823260.730665273)
73     >>> x221,y221 = awips221(npts[:,0], npts[:,1])
74     >>> # xy221 = numpy.concatenate((a1, a2, ...), axis=0)  # numpy-2.0
75     >>> xy221 = numpy.ndarray(shape=npts.shape, dtype=npts.dtype)
76     >>> xy221[:,0] = x221
77     >>> xy221[:,1] = y221
78     >>> xy221
79     array([[ 2725283.84267877,  5823260.73066527],
80            [ 2071820.3526011 ,  5892518.49630526],
81            [ 1422529.71760395,  5967565.49899035],
82            [  775650.03731228,  6046475.43928965],
83            [  129946.46495299,  6127609.80532071],
84            [ -515306.57275941,  6209785.69230076],
85            [-1160447.80254759,  6292455.41884832]])
86
87 Finally, you can convert points from one projection to another.
88
89     >>> from pyproj import transform
90     >>> x218,y218 = transform(awips221, awips218, x221, y221)
91     >>> xy218 = numpy.ndarray(shape=npts.shape, dtype=npts.dtype)
92     >>> xy218[:,0] = x218
93     >>> xy218[:,1] = y218
94     >>> xy218
95     array([[ 1834251.59591561,  4780900.70184736],
96            [ 1197541.13209718,  5028862.9881648 ],
97            [  542391.04388716,  5258740.71523961],
98            [ -131577.34942316,  5464828.45934687],
99            [ -822685.42269932,  5641393.59760613],
100            [-1527077.85176048,  5783597.16169582],
101            [-2239159.34620498,  5888495.91009021]])
102
103 Another useful coordinate system is the [Universal Transverse
104 Mercator][UTM] projection which slices the world into [zones][].
105
106     >>> p = Proj(proj='utm', zone=10, ellps='clrk66')
107
108 Putting everything together, here's a route map based on digital
109 lat/lng pairs stored in a text file:
110
111     >>> from numpy import array
112     >>> from pylab import plot, show
113     >>> from pyproj import Geod, Proj
114     >>> latlng = array([[float(x) for x in ln.split()]
115     ...                for ln in open('coords', 'r')
116     ...                if not ln.startswith('#')])
117     >>> g = Geod(ellps='WGS84')
118     >>> az12s,az21s,dists = g.inv(latlng[:-1,1], latlng[:-1,0],
119     ...                           latlng[1:,1], latlng[1:,0])
120     >>> print('total distance: %g m' % dists.sum())
121     total distance: 2078.93 m
122     >>> mlng = latlng[:,1].mean()
123     >>> zone = int(round((mlng + 180) / 6.))
124     >>> p = Proj(proj='utm', zone=zone, ellps='WGS84')
125     >>> xs,ys = p(latlng[:,1], latlng[:,0])
126     >>> lines = plot(xs, ys, 'r.-')
127     >>> show()
128
129 Note that you can easily get lat/lng pairs using [geopy][]:
130
131     >>> import geopy
132     >>> g = geopy.geocoders.Google()
133     >>> place1,(lat1,lng1) = g.geocode("New York, NY")
134     >>> place2,(lat2,lng2) = g.geocode("Vancouver, Canada")
135     >>> place1,(lat1,lng1)
136     (u'New York, NY, USA', (40.7143528, -74.0059731))
137     >>> place2,(lat2,lng2)
138     (u'Vancouver, BC, Canada', (49.261226, -123.1139268))
139
140 If you're looking for a more compact [[C++]] package for geographic
141 conversions, [GeographicLib][] looks promising.
142
143 [pyproj]: http://code.google.com/p/pyproj/
144 [PROJ.4]: http://trac.osgeo.org/proj/
145 [geodetic]: http://en.wikipedia.org/wiki/Geodesy
146 [clrk66]: http://en.wikipedia.org/wiki/Alexander_Ross_Clarke
147 [rell]: http://en.wikipedia.org/wiki/Reference_ellipsoid
148 [azimuths]: http://en.wikipedia.org/wiki/Azimuth
149 [LCC]: http://en.wikipedia.org/wiki/Lambert_conformal_conic_projection
150 [awips221]: http://www.nco.ncep.noaa.gov/pmb/docs/on388/tableb.html#GRID221
151 [awips226]: http://www.nco.ncep.noaa.gov/pmb/docs/on388/tableb.html#GRID218
152 [UTM]: http://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system
153 [zone]: http://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system#UTM_zone
154 [geopy]: http://code.google.com/p/geopy/
155 [GeographicLib]: http://geographiclib.sourceforge.net/html/
156
157 [[!tag tags/fun]]
158 [[!tag tags/linux]]
159 [[!tag tags/python]]
160 [[!tag tags/tools]]