[Scipy-svn] r6896 - trunk/scipy/interpolate

[scipy-svn at scipy.org]

Author: ptvirtan
Date: 2010-11-14 10:23:56 -0600 (Sun, 14 Nov 2010)
New Revision: 6896

Modified:
   trunk/scipy/interpolate/info.py
Log:
DOC: fix scipy.interpolate module docstring

Modified: trunk/scipy/interpolate/info.py
===================================================================
--- trunk/scipy/interpolate/info.py	2010-11-14 16:18:57 UTC (rev 6895)
+++ trunk/scipy/interpolate/info.py	2010-11-14 16:23:56 UTC (rev 6896)
@@ -7,114 +7,115 @@
 wrappers for `FITPACK <http://www.cisl.ucar.edu/softlib/FITPACK.html>`_
 and DFITPACK functions.
 
-Spline Functions
-----------------
+Univariate interpolation
+========================
 
 .. autosummary::
    :toctree: generated/
 
-   bisplev
-   bisplrep
-   insert
-   spalde
-   splev
-   spleval
-   splint
-   spline
-   splmake
-   splprep
-   splrep
-   spltopp
-   sproot
+   interp1d
+   BarycentricInterpolator
+   KroghInterpolator
+   PiecewisePolynomial
+   barycentric_interpolate
+   krogh_interpolate
+   piecewise_polynomial_interpolate
 
-Spline Classes
---------------
 
+Multivariate interpolation
+==========================
+
+Unstructured data:
+
 .. autosummary::
    :toctree: generated/
 
+   griddata
+   LinearNDInterpolator
+   NearestNDInterpolator
+   CloughTocher2DInterpolator
+   Rbf
+
+Data given on a regular grid:
+
+.. autosummary::
+   :toctree: generated/
+
+   interp2d
+
+
+1-D Splines
+===========
+
+.. autosummary::
+   :toctree: generated/
+
    UnivariateSpline
    InterpolatedUnivariateSpline
    LSQUnivariateSpline
-   BivariateSpline
-   SmoothBivariateSpline
 
-Interpolation Classes (univariate)
-----------------------------------
+The above univariate spline classes have the following methods:
 
+
 .. autosummary::
    :toctree: generated/
 
-   interp1d
-   BarycentricInterpolator
-   barycentric_interpolate
-   KroghInterpolator
-   krogh_interpolate
-   PiecewisePolynomial
-   piecewise_polynomial_interpolate
-   ppform
+   UnivariateSpline.__call__
+   UnivariateSpline.derivatives
+   UnivariateSpline.integral
+   UnivariateSpline.roots
+   UnivariateSpline.get_coeffs
+   UnivariateSpline.get_knots
+   UnivariateSpline.get_residual
+   UnivariateSpline.set_smoothing_factor
 
-Interpolation Classes (multivariate)
-------------------------------------
 
+Low-level interface to FITPACK functions:
+
 .. autosummary::
    :toctree: generated/
 
-   interp2d
-   Rbf
+   splrep
+   splprep
+   splev
+   splint
+   sproot
+   spalde
+   bisplrep
+   bisplev
 
-Additional tools
-----------------
 
+2-D Splines
+===========
+
+.. seealso:: scipy.ndimage.map_coordinates
+
 .. autosummary::
    :toctree: generated/
 
-   lagrange
-   approximate_taylor_polynomial
+   BivariateSpline
+   SmoothBivariateSpline
+   LSQBivariateSpline
 
-Wrappers around FITPACK functions
----------------------------------
+Low-level interface to FITPACK functions:
 
 .. autosummary::
    :toctree: generated/
 
-   fitpack.bisplev
-   fitpack.bisplrep
-   fitpack.insert
-   fitpack.spalde
-   fitpack.splev
-   fitpack.splint
-   fitpack.splprep
-   fitpack.splrep
-   fitpack.sproot
+   bisplrep
+   bisplev
 
-Wrappers around DFITPACK functions
-----------------------------------
+Additional tools
+================
 
-   `dfitpack.bispeu`
-   `dfitpack.bispev`
-   `dfitpack.curfit`
-   `dfitpack.dblint`
-   `dfitpack.fpcurf0`
-   `dfitpack.fpcurf1`
-   `dfitpack.fpcurfm1`
-   `dfitpack.parcur`
-   `dfitpack.percur`
-   `dfitpack.regrid_smth`
-   `dfitpack.spalde`
-   `dfitpack.splder`
-   `dfitpack.splev`
-   `dfitpack.splint`
-   `dfitpack.sproot`
-   `dfitpack.surfit_lsq`
-   `dfitpack.surfit_smth`
-
-See Also
---------
-
 .. autosummary::
    :toctree: generated/
 
+   lagrange
+   approximate_taylor_polynomial
+
+.. seealso::
+
    ndimage.map_coordinates
    ndimage.spline_filter
    signal.resample