SF.net SVN: matplotlib:[5809] trunk/matplotlib/lib/matplotlib/mlab.py

[<js...@us...>]

Revision: 5809
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5809&view=rev
Author:   jswhit
Date:     2008-07-22 11:23:49 +0000 (Tue, 22 Jul 2008)

Log Message:
-----------
update docstring for griddata to reflect the fact that
mpl_toolkits.natgrid will be used if installed.

Modified Paths:
--------------
    trunk/matplotlib/lib/matplotlib/mlab.py

Modified: trunk/matplotlib/lib/matplotlib/mlab.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/mlab.py	2008-07-22 11:12:50 UTC (rev 5808)
+++ trunk/matplotlib/lib/matplotlib/mlab.py	2008-07-22 11:23:49 UTC (rev 5809)
@@ -2710,6 +2710,15 @@
     hull defined by input data (no extrapolation is done).
 
     Uses natural neighbor interpolation based on Delaunay triangulation.
+    By default, this algorithm is provided by the matplotlib.delaunay
+    package, written by Robert Kern.  The triangulation algorithm in this
+    package is known to fail on some nearly pathological cases. For
+    this reason, a separate toolkit (mpl_tookits.natgrid) has been created
+    that provides a more robust algorithm fof triangulation and interpolation.
+    This toolkit is based on the NCAR natgrid library, which contains code 
+    that is not redistributable under a BSD-compatible license.  When installed,
+    this function will use the mpl_toolkits.natgrid algorithm, otherwise it
+    will use the built-in matplotlib.delaunay package.
     """
     if xi.ndim != yi.ndim:
         raise TypeError("inputs xi and yi must have same number of dimensions (1 or 2)")


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.