Revision: 5567
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5567&view=rev
Author: jswhit
Date: 2008-06-17 05:10:43 -0700 (Tue, 17 Jun 2008)
Log Message:
-----------
fixing up docstrings
Modified Paths:
--------------
trunk/toolkits/basemap/lib/mpl_toolkits/basemap/__init__.py
Modified: trunk/toolkits/basemap/lib/mpl_toolkits/basemap/__init__.py
===================================================================
--- trunk/toolkits/basemap/lib/mpl_toolkits/basemap/__init__.py 2008-06-16
21:11:57 UTC (rev 5566)
+++ trunk/toolkits/basemap/lib/mpl_toolkits/basemap/__init__.py 2008-06-17
12:10:43 UTC (rev 5567)
@@ -2164,16 +2164,14 @@
def drawgreatcircle(self,lon1,lat1,lon2,lat2,del_s=100.,**kwargs):
"""
- Draw a great circle on the map.
+ Draw a great circle on the map from the longitude-latitude
+ pair ``lon1,lat1`` to ``lon2,lat2``
.. tabularcolumns:: |l|L|
==============
=======================================================
Keyword Description
==============
=======================================================
- lon1,lat1 longitude,latitude of one endpoint of the great
circle.
- lon2,lat2 longitude,latitude of the other endpoint of the great
- circle.
del_s points on great circle computed every del_s kilometers
(default 100).
\**kwargs other keyword arguments are passed on to :meth:`plot`
@@ -2210,7 +2208,7 @@
.. tabularcolumns:: |l|L|
============== ====================================================
- Keyword Description
+ Argument Description
============== ====================================================
datin input data on a lat/lon grid.
lons, lats rank-1 arrays containing longitudes and latitudes
@@ -2218,6 +2216,15 @@
For non-cylindrical projections (those other than
``cyl``, ``merc`` and ``mill``) lons must fit
within range -180 to 180.
+ nx, ny The size of the output regular grid in map
+ projection coordinates
+ ============== ====================================================
+
+ .. tabularcolumns:: |l|L|
+
+ ============== ====================================================
+ Keyword Description
+ ============== ====================================================
returnxy If True, the x and y values of the map
projection grid are also returned (Default False).
checkbounds If True, values of lons and lats are checked to see
@@ -2272,7 +2279,7 @@
.. tabularcolumns:: |l|L|
============== ====================================================
- Keyword Description
+ Arguments Description
============== ====================================================
uin, vin input vector field on a lat/lon grid.
lons, lats rank-1 arrays containing longitudes and latitudes
@@ -2280,6 +2287,15 @@
For non-cylindrical projections (those other than
``cyl``, ``merc`` and ``mill``) lons must fit
within range -180 to 180.
+ nx, ny The size of the output regular grid in map
+ projection coordinates
+ ============== ====================================================
+
+ .. tabularcolumns:: |l|L|
+
+ ============== ====================================================
+ Keyword Description
+ ============== ====================================================
returnxy If True, the x and y values of the map
projection grid are also returned (Default False).
checkbounds If True, values of lons and lats are checked to see
@@ -2335,7 +2351,7 @@
.. tabularcolumns:: |l|L|
============== ====================================================
- Keyword Description
+ Arguments Description
============== ====================================================
uin, vin input vector field on a lat/lon grid.
lons, lats Arrays containing longitudes and latitudes
@@ -2343,12 +2359,13 @@
For non-cylindrical projections (those other than
``cyl``, ``merc`` and ``mill``) lons must fit
within range -180 to 180.
- returnxy If True, the x and y values of the map
- projection grid are also returned (Default False).
============== ====================================================
Returns ``uout, vout`` (rotated vector field).
- If returnxy=True, returns ``uout,vout,x,y``.
+ If the optional keyword argument
+ ``returnxy`` is True (default is False),
+ returns ``uout,vout,x,y`` (where ``x,y`` are the map projection
+ coordinates of the grid defined by ``lons,lats``).
"""
if lons.ndim == 1 and lats.ndim == 1:
lons, lats = np.meshgrid(lons, lats)
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
-------------------------------------------------------------------------
Check out the new SourceForge.net Marketplace.
It's the best place to buy or sell services for
just about anything Open Source.
http://sourceforge.net/services/buy/index.php
_______________________________________________
Matplotlib-checkins mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/matplotlib-checkins
