Revision: 5509
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5509&view=rev
Author: jswhit
Date: 2008-06-13 08:13:39 -0700 (Fri, 13 Jun 2008)
Log Message:
-----------
updating 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
15:04:49 UTC (rev 5508)
+++ trunk/toolkits/basemap/lib/mpl_toolkits/basemap/__init__.py 2008-06-13
15:13:39 UTC (rev 5509)
@@ -112,6 +112,11 @@
and creates the coastline data structures in native map projection
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). The inverse transformation is done if the optional keyword
+ ``inverse`` is set to True.
+
The desired projection is set with the projection keyword. Default is ``cyl``.
Supported values for the projection keyword are:
@@ -1296,18 +1301,19 @@
"""
Draw coastlines.
- linewidth - coastline width (default 1.)
+ ============== ====================================================
+ Keyword Description
+ ============== ====================================================
+ linewidth coastline width (default 1.)
+ color coastline color (default black)
+ antialiased antialiasing switch for coastlines (default True).
+ ax axes instance (overrides default axes instance)
+ zorder sets the zorder for the coastlines (if not specified,
+ uses default zorder for
+ matplotlib.patches.LineCollections).
+ ============== ====================================================
- color - coastline color (default black)
-
- antialiased - antialiasing switch for coastlines (default True).
-
- ax - axes instance (overrides default axes instance)
-
- zorder - sets the zorder for the coastlines (if not specified,
- uses default zorder for LineCollections).
-
- returns a LineCollection.
+ returns a matplotlib.patches.LineCollection object.
"""
if self.resolution is None:
raise AttributeError, 'there are no boundary datasets associated
with this Basemap instance'
@@ -1335,18 +1341,20 @@
"""
Draw country boundaries.
- linewidth - country boundary line width (default 0.5)
+ ============== ====================================================
+ Keyword Description
+ ============== ====================================================
+ linewidth country boundary line width (default 0.5)
+ color country boundary line color (default black)
+ antialiased antialiasing switch for country boundaries (default
+ True).
+ ax axes instance (overrides default axes instance)
+ zorder sets the zorder for the country boundaries (if not
+ specified uses default zorder for
+ matplotlib.patches.LineCollections).
+ ============== ====================================================
- color - country boundary line color (default black)
-
- antialiased - antialiasing switch for country boundaries (default
True).
-
- ax - axes instance (overrides default axes instance)
-
- zorder - sets the zorder for the country boundaries (if not specified,
- uses default zorder for LineCollections).
-
- returns a LineCollection.
+ returns a matplotlib.patches.LineCollection object.
"""
if self.resolution is None:
raise AttributeError, 'there are no boundary datasets associated
with this Basemap instance'
@@ -1378,18 +1386,20 @@
"""
Draw state boundaries in Americas.
- linewidth - state boundary line width (default 0.5)
+ ============== ====================================================
+ Keyword Description
+ ============== ====================================================
+ linewidth state boundary line width (default 0.5)
+ color state boundary line color (default black)
+ antialiased antialiasing switch for state boundaries
+ (default True).
+ ax axes instance (overrides default axes instance)
+ zorder sets the zorder for the state boundaries (if not
+ specified, uses default zorder for
+ matplotlib.patches.LineCollections).
+ ============== ====================================================
- color - state boundary line color (default black)
-
- antialiased - antialiasing switch for state boundaries (default True).
-
- ax - axes instance (overrides default axes instance)
-
- zorder - sets the zorder for the state boundaries (if not specified,
- uses default zorder for LineCollections).
-
- returns a LineCollection.
+ returns a matplotlib.patches.LineCollection object.
"""
if self.resolution is None:
raise AttributeError, 'there are no boundary datasets associated
with this Basemap instance'
@@ -1421,18 +1431,20 @@
"""
Draw major rivers.
- linewidth - river boundary line width (default 0.5)
+ ============== ====================================================
+ Keyword Description
+ ============== ====================================================
+ linewidth river boundary line width (default 0.5)
+ color river boundary line color (default black)
+ antialiased antialiasing switch for river boundaries (default
+ True).
+ ax axes instance (overrides default axes instance)
+ zorder sets the zorder for the rivers (if not
+ specified uses default zorder for
+ matplotlib.patches.LineCollections).
+ ============== ====================================================
- color - river boundary line color (default black)
-
- antialiased - antialiasing switch for river boundaries (default True).
-
- ax - axes instance (overrides default axes instance)
-
- zorder - sets the zorder for the rivers (if not specified,
- uses default zorder for LineCollections).
-
- returns a LineCollection
+ returns a matplotlib.patches.LineCollection 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
