Skip to content

Commit 4e4dd12

Browse files
author
Jeff Whitaker
committed
update html docs
1 parent 8eb43d6 commit 4e4dd12

File tree

16 files changed

+55
-25
lines changed

16 files changed

+55
-25
lines changed

docs/html/_modules/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ <h3>Navigation</h3>
6868
</div>
6969
<div class="footer" role="contentinfo">
7070
&#169; Copyright 2019, Jeffrey Whitaker.
71-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.0+/db78402.
71+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.0+/8eb43d6.
7272
</div>
7373
</body>
7474
</html>

docs/html/_modules/pyproj.html

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -450,7 +450,7 @@ <h1>Source code for pyproj</h1><div class="highlight"><pre>
450450
<span class="k">return</span> <span class="n">Proj</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">crs</span><span class="o">.</span><span class="n">to_geodetic</span><span class="p">())</span></div></div>
451451

452452

453-
<div class="viewcode-block" id="transform"><a class="viewcode-back" href="../api/proj.html#pyproj.transform">[docs]</a><span class="k">def</span> <span class="nf">transform</span><span class="p">(</span><span class="n">p1</span><span class="p">,</span> <span class="n">p2</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">z</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
453+
<div class="viewcode-block" id="transform"><a class="viewcode-back" href="../api/proj.html#pyproj.transform">[docs]</a><span class="k">def</span> <span class="nf">transform</span><span class="p">(</span><span class="n">p1</span><span class="p">,</span> <span class="n">p2</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">z</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">radians</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
454454
<span class="sd">&quot;&quot;&quot;</span>
455455
<span class="sd"> x2, y2, z2 = transform(p1, p2, x1, y1, z1)</span>
456456

@@ -461,7 +461,10 @@ <h1>Source code for pyproj</h1><div class="highlight"><pre>
461461
<span class="sd"> transformed to x2,y2,z2 in the coordinate system defined by p2.</span>
462462

463463
<span class="sd"> z1 is optional, if it is not set it is assumed to be zero (and</span>
464-
<span class="sd"> only x2 and y2 are returned).</span>
464+
<span class="sd"> only x2 and y2 are returned). If the optional keyword </span>
465+
<span class="sd"> &#39;radians&#39; is True (default is False), then all input and </span>
466+
<span class="sd"> output coordinates will be in radians instead of the default </span>
467+
<span class="sd"> of degrees for geographic input/output projections.</span>
465468

466469
<span class="sd"> In addition to converting between cartographic and geographic</span>
467470
<span class="sd"> projection coordinates, this function can take care of datum</span>
@@ -523,6 +526,11 @@ <h1>Source code for pyproj</h1><div class="highlight"><pre>
523526
<span class="sd"> &gt;&gt;&gt; x3, y3 = transform(&quot;epsg:4326&quot;, &quot;epsg:3857&quot;, 33, 98)</span>
524527
<span class="sd"> &gt;&gt;&gt; &quot;%.3f %.3f&quot; % (x3, y3)</span>
525528
<span class="sd"> &#39;10909310.098 3895303.963&#39;</span>
529+
<span class="sd"> &gt;&gt;&gt; pj = Proj(init=&quot;epsg:4214&quot;)</span>
530+
<span class="sd"> &gt;&gt;&gt; pjx, pjy = pj(116.366, 39.867)</span>
531+
<span class="sd"> &gt;&gt;&gt; xr, yr = transform(pj, Proj(4326), pjx, pjy, radians=True)</span>
532+
<span class="sd"> &gt;&gt;&gt; &quot;%.3f %.3f&quot; % (xr, yr)</span>
533+
<span class="sd"> &#39;2.031 0.696&#39;</span>
526534
<span class="sd"> &quot;&quot;&quot;</span>
527535
<span class="c1"># check that p1 and p2 are valid</span>
528536
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">p1</span><span class="p">,</span> <span class="n">Proj</span><span class="p">):</span>
@@ -538,7 +546,7 @@ <h1>Source code for pyproj</h1><div class="highlight"><pre>
538546
<span class="k">else</span><span class="p">:</span>
539547
<span class="n">inz</span> <span class="o">=</span> <span class="kc">None</span>
540548
<span class="c1"># call pj_transform. inx,iny,inz buffers modified in place.</span>
541-
<span class="n">_proj</span><span class="o">.</span><span class="n">_transform</span><span class="p">(</span><span class="n">p1</span><span class="p">,</span> <span class="n">p2</span><span class="p">,</span> <span class="n">inx</span><span class="p">,</span> <span class="n">iny</span><span class="p">,</span> <span class="n">inz</span><span class="p">)</span>
549+
<span class="n">_proj</span><span class="o">.</span><span class="n">_transform</span><span class="p">(</span><span class="n">p1</span><span class="p">,</span> <span class="n">p2</span><span class="p">,</span> <span class="n">inx</span><span class="p">,</span> <span class="n">iny</span><span class="p">,</span> <span class="n">inz</span><span class="p">,</span> <span class="n">radians</span><span class="p">)</span>
542550
<span class="c1"># if inputs were lists, tuples or floats, convert back.</span>
543551
<span class="n">outx</span> <span class="o">=</span> <span class="n">_convertback</span><span class="p">(</span><span class="n">xisfloat</span><span class="p">,</span> <span class="n">xislist</span><span class="p">,</span> <span class="n">xistuple</span><span class="p">,</span> <span class="n">inx</span><span class="p">)</span>
544552
<span class="n">outy</span> <span class="o">=</span> <span class="n">_convertback</span><span class="p">(</span><span class="n">yisfloat</span><span class="p">,</span> <span class="n">yislist</span><span class="p">,</span> <span class="n">xistuple</span><span class="p">,</span> <span class="n">iny</span><span class="p">)</span>
@@ -549,7 +557,7 @@ <h1>Source code for pyproj</h1><div class="highlight"><pre>
549557
<span class="k">return</span> <span class="n">outx</span><span class="p">,</span> <span class="n">outy</span></div>
550558

551559

552-
<div class="viewcode-block" id="itransform"><a class="viewcode-back" href="../api/proj.html#pyproj.itransform">[docs]</a><span class="k">def</span> <span class="nf">itransform</span><span class="p">(</span><span class="n">p1</span><span class="p">,</span> <span class="n">p2</span><span class="p">,</span> <span class="n">points</span><span class="p">,</span> <span class="n">switch</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
560+
<div class="viewcode-block" id="itransform"><a class="viewcode-back" href="../api/proj.html#pyproj.itransform">[docs]</a><span class="k">def</span> <span class="nf">itransform</span><span class="p">(</span><span class="n">p1</span><span class="p">,</span> <span class="n">p2</span><span class="p">,</span> <span class="n">points</span><span class="p">,</span> <span class="n">switch</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">radians</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
553561
<span class="sd">&quot;&quot;&quot;</span>
554562
<span class="sd"> points2 = transform(p1, p2, points1)</span>
555563
<span class="sd"> Iterator/generator version of the function pyproj.transform.</span>
@@ -568,7 +576,9 @@ <h1>Source code for pyproj</h1><div class="highlight"><pre>
568576
<span class="sd"> - a generator of coordinates (xi,yi) for 2d points or (xi,yi,zi) for 3d</span>
569577

570578
<span class="sd"> If optional keyword &#39;switch&#39; is True (default is False) then x, y or lon,lat coordinates</span>
571-
<span class="sd"> of points are switched to y, x or lat, lon.</span>
579+
<span class="sd"> of points are switched to y, x or lat, lon. If the optional keyword &#39;radians&#39; is True</span>
580+
<span class="sd"> (default is False), then all input and output coordinates will be in radians instead</span>
581+
<span class="sd"> of the default of degrees for geographic input/output projections.</span>
572582

573583

574584
<span class="sd"> Example usage:</span>
@@ -589,6 +599,10 @@ <h1>Source code for pyproj</h1><div class="highlight"><pre>
589599
<span class="sd"> &#39;2221638.801 2637034.372&#39;</span>
590600
<span class="sd"> &#39;2212924.125 2619851.898&#39;</span>
591601
<span class="sd"> &#39;2238294.779 2703763.736&#39;</span>
602+
<span class="sd"> &gt;&gt;&gt; pj = Proj(init=&quot;epsg:4214&quot;)</span>
603+
<span class="sd"> &gt;&gt;&gt; pjx, pjy = pj(116.366, 39.867)</span>
604+
<span class="sd"> &gt;&gt;&gt; for pt in itransform(pj, Proj(4326), [(pjx, pjy)]): &#39;{:.3f} {:.3f}&#39;.format(*pt)</span>
605+
<span class="sd"> &#39;2.031 0.696&#39;</span>
592606
<span class="sd"> &quot;&quot;&quot;</span>
593607
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">p1</span><span class="p">,</span> <span class="n">Proj</span><span class="p">):</span>
594608
<span class="n">p1</span> <span class="o">=</span> <span class="n">CRS</span><span class="o">.</span><span class="n">from_user_input</span><span class="p">(</span><span class="n">p1</span><span class="p">)</span>
@@ -616,7 +630,7 @@ <h1>Source code for pyproj</h1><div class="highlight"><pre>
616630
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">buff</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
617631
<span class="k">break</span>
618632

619-
<span class="n">_proj</span><span class="o">.</span><span class="n">_transform_sequence</span><span class="p">(</span><span class="n">p1</span><span class="p">,</span> <span class="n">p2</span><span class="p">,</span> <span class="n">stride</span><span class="p">,</span> <span class="n">buff</span><span class="p">,</span> <span class="n">switch</span><span class="p">)</span>
633+
<span class="n">_proj</span><span class="o">.</span><span class="n">_transform_sequence</span><span class="p">(</span><span class="n">p1</span><span class="p">,</span> <span class="n">p2</span><span class="p">,</span> <span class="n">stride</span><span class="p">,</span> <span class="n">buff</span><span class="p">,</span> <span class="n">switch</span><span class="p">,</span> <span class="n">radians</span><span class="p">)</span>
620634

621635
<span class="k">for</span> <span class="n">pt</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="o">*</span><span class="p">([</span><span class="nb">iter</span><span class="p">(</span><span class="n">buff</span><span class="p">)]</span> <span class="o">*</span> <span class="n">stride</span><span class="p">)):</span>
622636
<span class="k">yield</span> <span class="n">pt</span></div>
@@ -670,7 +684,7 @@ <h3>Navigation</h3>
670684
</div>
671685
<div class="footer" role="contentinfo">
672686
&#169; Copyright 2019, Jeffrey Whitaker.
673-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.0+/db78402.
687+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.0+/8eb43d6.
674688
</div>
675689
</body>
676690
</html>

docs/html/_modules/pyproj/crs.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ <h3>Navigation</h3>
347347
</div>
348348
<div class="footer" role="contentinfo">
349349
&#169; Copyright 2019, Jeffrey Whitaker.
350-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.0+/db78402.
350+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.0+/8eb43d6.
351351
</div>
352352
</body>
353353
</html>

docs/html/_modules/pyproj/datadir.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ <h3>Navigation</h3>
133133
</div>
134134
<div class="footer" role="contentinfo">
135135
&#169; Copyright 2019, Jeffrey Whitaker.
136-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.0+/db78402.
136+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.0+/8eb43d6.
137137
</div>
138138
</body>
139139
</html>

docs/html/_modules/pyproj/geod.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -520,7 +520,7 @@ <h3>Navigation</h3>
520520
</div>
521521
<div class="footer" role="contentinfo">
522522
&#169; Copyright 2019, Jeffrey Whitaker.
523-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.0+/db78402.
523+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.0+/8eb43d6.
524524
</div>
525525
</body>
526526
</html>

docs/html/_sources/history.rst.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ Change Log
44
~~~~~
55
* add filter for boolean values in dict2string so "no_rot=True" works (issue #183).
66
* make sure .pxd files included in source tarball.
7+
* add radians flag back in for transform/itransform (issue #185).
78

89
2.0.1
910
~~~~~

docs/html/api/crs.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -391,7 +391,7 @@ <h3>Navigation</h3>
391391
</div>
392392
<div class="footer" role="contentinfo">
393393
&#169; Copyright 2019, Jeffrey Whitaker.
394-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.0+/db78402.
394+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.0+/8eb43d6.
395395
</div>
396396
</body>
397397
</html>

docs/html/api/datadir.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ <h3>Navigation</h3>
139139
</div>
140140
<div class="footer" role="contentinfo">
141141
&#169; Copyright 2019, Jeffrey Whitaker.
142-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.0+/db78402.
142+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.0+/8eb43d6.
143143
</div>
144144
</body>
145145
</html>

docs/html/api/geod.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ <h3>Navigation</h3>
298298
</div>
299299
<div class="footer" role="contentinfo">
300300
&#169; Copyright 2019, Jeffrey Whitaker.
301-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.0+/db78402.
301+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.0+/8eb43d6.
302302
</div>
303303
</body>
304304
</html>

docs/html/api/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ <h3>Navigation</h3>
117117
</div>
118118
<div class="footer" role="contentinfo">
119119
&#169; Copyright 2019, Jeffrey Whitaker.
120-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.0+/db78402.
120+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.0+/8eb43d6.
121121
</div>
122122
</body>
123123
</html>

0 commit comments

Comments
 (0)