Revision: 5501
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5501&view=rev
Author: jswhit
Date: 2008-06-13 05:20:35 -0700 (Fri, 13 Jun 2008)
Log Message:
-----------
further restifying of 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-13
12:11:33 UTC (rev 5500)
+++ trunk/toolkits/basemap/lib/mpl_toolkits/basemap/__init__.py 2008-06-13
12:20:35 UTC (rev 5501)
@@ -312,8 +312,28 @@
for the map projection as defined by PROJ.4.
================ ====================================================
- Example Usage:
+ **Converting from Geographic (lon/lat) to Map Projection (x/y) Coordinates**
+ Calling a Basemap class instance with the arguments lon, lat will
+ convert lon/lat (in degrees) to x/y native map projection
+ coordinates (in meters). If optional keyword ``inverse`` is
+ True (default is False), the inverse transformation from x/y
+ to lon/lat is performed.
+
+ For cylindrical equidistant projection (``cyl``), this
+ does nothing (i.e. x,y == lon,lat).
+
+ For non-cylindrical projections, the inverse transformation
+ always returns longitudes between -180 and 180 degrees. For
+ cylindrical projections (self.projection == ``cyl``, ``mill`` or ``merc``)
+ The inverse transformation will return longitudes between
+ self.llcrnrlon and self.llcrnrlat.
+
+ Input arguments lon, lat can be either scalar floats, sequences
+ or numpy arrays.
+
+ **Example Usage:**
+
>>> from mpl_toolkits.basemap import Basemap
>>> import numpy as np
>>> import matplotlib.pyplot as plt
@@ -739,7 +759,7 @@
Calling a Basemap class instance with the arguments lon, lat will
convert lon/lat (in degrees) to x/y native map projection
coordinates (in meters). If optional keyword ``inverse`` is
- ``True11 (default is ``False``), the inverse transformation from x/y
+ True (default is False), the inverse transformation from x/y
to lon/lat is performed.
For cylindrical equidistant projection (``cyl``), this
@@ -747,11 +767,13 @@
For non-cylindrical projections, the inverse transformation
always returns longitudes between -180 and 180 degrees. For
- cylindrical projections (self.projection == ``cyl``,``mill`` or
``merc``)
- the inverse transformation will return longitudes between
+ cylindrical projections (self.projection == ``cyl``,
+ ``mill`` or ``merc``)
+ The inverse transformation will return longitudes between
self.llcrnrlon and self.llcrnrlat.
- input arguments lon, lat can be either scalar floats or N arrays.
+ Input arguments lon, lat can be either scalar floats,
+ sequences, or numpy arrays.
"""
return self.projtran(x,y,inverse=inverse)
@@ -760,7 +782,7 @@
return arrays of shape (ny,nx) containing lon,lat coordinates of
an equally spaced native projection grid.
- if ``returnxy = True``, the x,y values of the grid are returned also.
+ If ``returnxy = True``, the x,y values of the grid are returned also.
"""
return self.projtran.makegrid(nx,ny,returnxy=returnxy)
@@ -1205,19 +1227,22 @@
"""
Fill continents.
- color - color to fill continents (default gray).
+ ============== ====================================================
+ Keyword Description
+ ============== ====================================================
+ color color to fill continents (default gray).
+ lake_color color to fill inland lakes (default axes background).
+ ax axes instance (overrides default axes instance).
+ zorder sets the zorder for the continent polygons (if not
+ specified, uses default zorder for a Polygon patch).
+ Set to zero if you want to paint over the filled
+ continents).
+ ============== ====================================================
- lake_color - color to fill inland lakes (default axes background).
+ After filling continents, lakes are re-filled with
+ axis background color.
- ax - axes instance (overrides default axes instance).
-
- zorder - sets the zorder for the continent polygons (if not specified,
- uses default zorder for a Polygon patch). Set to zero if you want to
paint
- over the filled continents).
-
- After filling continents, lakes are re-filled with axis background
color.
-
- returns Polygon object.
+ returns matplotlib.patches.Polygon object.
"""
if self.resolution is None:
raise AttributeError, 'there are no boundary datasets associated
with this Basemap instance'
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
