[Scipy-svn] r4583 - in branches/Interpolate1D/docs: . build/doctrees build/html build/html/_sources
scipy-svn at scipy.org
scipy-svn at scipy.org
Wed Jul 30 16:32:35 EDT 2008
Author: fcady
Date: 2008-07-30 15:32:32 -0500 (Wed, 30 Jul 2008)
New Revision: 4583
Modified:
branches/Interpolate1D/docs/build/doctrees/environment.pickle
branches/Interpolate1D/docs/build/doctrees/tutorial.doctree
branches/Interpolate1D/docs/build/html/_sources/tutorial.txt
branches/Interpolate1D/docs/build/html/searchindex.json
branches/Interpolate1D/docs/build/html/tutorial.html
branches/Interpolate1D/docs/tutorial.rst
Log:
improved docstrings and documentation
Modified: branches/Interpolate1D/docs/build/doctrees/environment.pickle
===================================================================
(Binary files differ)
Modified: branches/Interpolate1D/docs/build/doctrees/tutorial.doctree
===================================================================
(Binary files differ)
Modified: branches/Interpolate1D/docs/build/html/_sources/tutorial.txt
===================================================================
--- branches/Interpolate1D/docs/build/html/_sources/tutorial.txt 2008-07-30 20:14:30 UTC (rev 4582)
+++ branches/Interpolate1D/docs/build/html/_sources/tutorial.txt 2008-07-30 20:32:32 UTC (rev 4583)
@@ -21,7 +21,8 @@
Basic Usage
-------------
-The following example uses the 'interp1d' function to linearly interpolate a sin curve from a sparse set of values.::
+The following example uses the 'interp1d' function to linearly interpolate a sin
+curve from a sparse set of values. ::
# start up ipython for our examples.
$ ipython -pylab
@@ -41,25 +42,24 @@
In [9]: interp1d(x, y, array(1.2) )
Out [10]: 0.76394372684109768
- # To interpolate from these x,y values at multiple points, possibly to get a more dense set of new_x, new_y values,
- # pass a numpy array to interp1d, and the return type will also be a numpy array.
+ # To interpolate from these x,y values at multiple points, possibly to get a more dense set
+ # of new_x, new_y values to approximate the function, pass a numpy array to interp1d,
+ # and the return type will also be a numpy array.
In [4]: new_x = linspace(0, 2*pi, 21)
In [5]: new_y = interp1d(x, y, new_x)
# Plot the results using matplotlib. [note examples assume you are running in ipython -pylab]
In [6]: plot(x, y, 'ro', new_x, new_y, 'b-')
-.. image:: interp1d_linear_simple.png
+.. image:: interp1d_linear_simple.png
::
-
+
# Alternatively, x, y and new_x can also be lists (they are internally converted into arrays
# before processing)
In []: interp1d( [1.0, 2.0], [1.0, 2.0], [1.3] )
Out []: array([ 1.3 ])
-
-
What happens if we pass in a new_x with values outside the range of x? By default, new_y will be
NaN at all such points: ::
@@ -68,7 +68,6 @@
In [7]: interp1d(x, y, array([-2, -1, 1, 2]))
Out [8]: array([ NaN, NaN, 0.63661977, 0.72676046])
-
If we want a type of interpolation other than linear, there is a range of options which we can specify
with the keyword argument interp, which is usually a string. For example::
@@ -78,7 +77,6 @@
.. image:: interp1d_linear_and_quadratic.png
-
There is a large selection of strings which specify a range of interpolation methods. The list includes:
#. 'linear' : linear interpolation, same as the default
Modified: branches/Interpolate1D/docs/build/html/searchindex.json
===================================================================
--- branches/Interpolate1D/docs/build/html/searchindex.json 2008-07-30 20:14:30 UTC (rev 4582)
+++ branches/Interpolate1D/docs/build/html/searchindex.json 2008-07-30 20:32:32 UTC (rev 4583)
@@ -1 +1 @@
-[["index","tutorial"],["Welcome to interpolate’s documentation!","Overview"],{"all":[1],"extrapol":[1],"just":[1],"extrap_low":[1],"abl":[1],"pylab":[1],"veri":[1],"scalar":[1],"keyword":[1],"72676046":[1],"follow":[1],"flexibl":[1],"anywai":[1],"underlin":[],"interp1d":[1],"onli":[1],"inlin":[],"but":[0,1],"21":[1],"easi":[1],"29":[0],"should":[0],"to":[0,1],"4":[1],"primit":[1],"__call__":[1],"8":[1],"modul":[0],"inform":[1],"overwritten":[1],"then":[1],"non":[1],"liter":[],"return":[1],"string":[1],"thei":[1],"get":[1],"handl":[1],"9":[1],"ident":[1],"know":[1],"failur":[1],"not":[1],"now":[1],"you":[0,1],"dure":[1],"like":[0],"55":[1],"lowkw":[1],"56":[0],"list":[1],"linspac":[1],"2d":[1],"default":[1],"quintic":[1],"datapoint":[0,1],"either":[1],"contain":[0],"x":[1],"where":[1],"page":[0],"dimens":[1],"set_xi":[1],"set":[1],"arang":[1],"51":[0],"dataset":[1],"multipl":[1],"some":[1],"direct":[0,1],"10":[1],"self":[1],"extrap_high":[1],"signifi":[1],"result":[1],"pass":[1],"corrupt":[1],"our":[1],"happen":[1],"orient":[1],"out":[1],"even":[1],"index":[0],"00":[0],"jul":[0],"appear":[1],"for":[1],"space":[1],"miss":[1],"though":[1],"definit":[],"bad":[0,1],"trickier":[1],"content":[0],"toctre":[0],"3":[1],"larg":[1],"adapt":[0],"7":[1],"it":[0,1],"new":[1],"fall":[1],"ro":[1],"method":[0,1],"note":[1],"altern":[1],"be":[1],"spars":[1],"newi":[1],"run":[1],"linear":[1],"do":[1],"titl":[],"spline":[1],"exampl":[1],"usag":[0,1],"matplotlib":[1],"interfac":[0,1],"fixm":[1],"them":[1],"interp1d_linear_simpl":[],"found":[],"ipython":[1],"100":[1],"strong":[],"by":[0,1],"valu":[1],"care":[1],"box":[1],"both":[1],"convert":[1],"indent":[],"val":[1],"g":[1],"of":[0,1],"howev":[1],"current":[1],"slightli":[1],"newx":[1],"round":[1],"s":[0],"instanc":[1],"present":[1],"includ":[1],"outsid":[1],"permit":[],"correct":[1],"mani":[1],"heart":[1],"or":[1],"block":[1],"e":[1],"and":[0,1],"rang":[1],"own":[1],"effici":[1],"point":[1],"overview":[0,1],"arrai":[1],"new_y_bad":[1],"number":[1],"linearli":[1],"2nd":[1],"down":[1],"right":[1],"blank":[],"import":[1],"76394372684109768":[1],"assum":[1],"your":[0,1],"select":[1],"quickstart":[0],"plot":[1],"from":[1],"i":[1],"wai":[1],"0":[1],"abov":[1],"data":[1],"support":[1],"there":[1],"numpi":[1],"least":[0],"tue":[0],"start":[1],"2":[1],"call":[1],"1d":[0,1],"6":[1],"master":[0],"pi":[1],"type":[1],"final":[1],"treat":[1],"function":[0,1],"interpkw":[1],"desir":[1],"option":[1],"unexpect":[],"that":[1],"afford":[1],"interp":[1],"imag":[],"basic":[0,1],"search":[0],"specifi":[1],"argument":[1],"file":[0],"too":[],"intern":[1],"known":[1],"sphinx":[0],"line":[],"ha":[1],"with":[0,1],"than":[1],"png":[],"must":[1],"case":[1],"unind":[],"none":[1],"b":[1],"quartic":[1],"possibl":[1],"provid":[1],"remov":[0,1],"when":[1],"bad_data":[1],"up":[1],"us":[1],"n":[1],"will":[1],"defin":[0,1],"below":[1],"r":[1],"can":[0,1],"behavior":[1],"error":[1],"about":[1],"intepol":[],"z":[1],"root":[0],"def":[1],"new_i":[1],"control":[1],"nearest":[1],"have":[1],"creat":[0,1],"new_x":[1],"process":[1],"is":[1],"in":[1],"ani":[1],"accept":[1],"an":[1],"packag":[1],"8217":[0],"init_xi":[1],"5th":[1],"at":[0,1],"want":[1],"tabl":[0],"kw":[1],"quadrat":[1],"the":[0,1],"as":[1],"if":[1],"such":[1],"these":[1],"end":[1],"form":[1],"equival":[1],"quot":[],"perform":[1],"anoth":[1],"make":[1],"format":[1],"nan":[1],"expect":[],"same":[1],"1":[1],"also":[1],"other":[1],"5":[1],"__init__":[1],"indic":[0],"63661977":[1],"np":[1],"so":[1],"more":[1],"document":[0],"ar":[1],"tool":[1],"singl":[1],"complet":[0],"new_y_quadrat":[1],"curv":[1],"sure":[1],"recogn":[1],"y":[1],"see":[1],"cubic":[1],"class":[1],"object":[1],"what":[1],"befor":[1],"4th":[1],"user":[0,1],"thi":[0,1],"new_y_no_bad":[1],"faint":[1],"on":[0,1],"uniformli":[1],"grow":[],"welcom":[0],"a":[1],"short":[],"attempt":[1],"3rd":[1],"dens":[1],"into":[1],"no":[],"well":[1],"rais":[1],"dimension":[1],"caus":[1],"dummi":[1],"which":[1],"without":[],"ignor":[1],"phoni":[1],"interpol":[0,1],"callabl":[1],"sin":[1],"2008":[0],"lambda":[1],"order":[1],"we":[1],"usual":[1]}]
\ No newline at end of file
+[["index","tutorial"],["Welcome to interpolate’s documentation!","Overview"],{"all":[1],"extrapol":[1],"scalar":[1],"follow":[1],"interp1d":[1],"to":[0,1],"liter":[],"string":[1],"end":[1],"fall":[1],"veri":[1],"list":[1],"round":[1],"dimens":[1],"direct":[0,1],"pass":[1],"even":[1],"index":[0],"what":[1],"appear":[1],"abl":[1],"current":[1],"new":[1],"method":[0,1],"set_xi":[1],"behavior":[1],"matplotlib":[1],"100":[1],"strong":[],"valu":[1],"box":[1],"convert":[1],"permit":[],"nearest":[1],"primit":[1],"approxim":[1],"linearli":[1],"select":[1],"plot":[1],"from":[1],"0":[1],"faint":[1],"call":[1],"6":[1],"type":[1],"more":[1],"desir":[1],"spline":[1],"indic":[0],"known":[1],"phoni":[1],"must":[1],"none":[1],"quartic":[1],"arang":[1],"can":[0,1],"root":[0],"def":[1],"control":[1],"heart":[1],"quickstart":[0],"process":[1],"accept":[1],"want":[1],"multipl":[1],"quot":[],"anoth":[1],"1":[1],"sin":[1],"recogn":[1],"befor":[1],"4th":[1],"such":[1],"data":[1],"grow":[],"a":[1],"short":[],"attempt":[1],"explicit":[],"caus":[1],"inform":[1],"so":[1],"callabl":[1],"order":[1],"failur":[1],"flexibl":[1],"21":[1],"29":[0],"then":[1],"them":[1],"return":[1],"thei":[1],"handl":[1],"not":[1],"now":[1],"lowkw":[1],"linspac":[1],"2d":[1],"quintic":[1],"found":[],"expect":[],"our":[1],"happen":[1],"orient":[1],"out":[1],"3rd":[1],"space":[1],"trickier":[1],"content":[0],"adapt":[0],"7":[1],"ro":[1],"correct":[1],"linear":[1],"interp1d_linear_simpl":[],"fixm":[1],"care":[1],"indent":[],"wai":[1],"g":[1],"outsid":[1],"lambda":[1],"rang":[1],"arrai":[1],"number":[1],"blank":[],"76394372684109768":[1],"miss":[1],"5th":[1],"least":[0],"underlin":[],"master":[0],"1d":[0,1],"final":[1],"too":[],"option":[1],"that":[1],"tool":[1],"specifi":[1],"than":[1],"png":[],"unind":[],"b":[1],"keyword":[1],"provid":[1],"remov":[0,1],"r":[1],"intepol":[],"and":[0,1],"ani":[1],"packag":[1],"have":[1],"tabl":[0],"new_y_no_bad":[1],"unexpect":[],"equival":[1],"self":[1],"note":[1],"also":[1],"without":[],"which":[1],"singl":[1],"new_y_quadrat":[1],"sure":[1],"though":[1],"object":[1],"jul":[0],"class":[1],"dens":[1],"dummi":[1],"kw":[1],"extrap_low":[1],"anywai":[1],"onli":[1],"ha":[1],"should":[0],"__call__":[1],"8":[1],"overwritten":[1],"do":[1],"init_xi":[1],"get":[1],"2":[1],"bad":[0,1],"contain":[0],"x":[1],"where":[1],"set":[1],"we":[1],"up":[1],"see":[1],"signifi":[1],"result":[1],"corrupt":[1],"00":[0],"3":[1],"import":[1],"altern":[1],"spars":[1],"newi":[1],"newx":[1],"ipython":[1],"tue":[0],"both":[1],"howev":[1],"s":[0],"instanc":[1],"mani":[1],"point":[1],"overview":[0,1],"new_y_bad":[1],"8217":[0],"2nd":[1],"non":[1],"assum":[1],"numpi":[1],"treat":[1],"basic":[0,1],"pi":[1],"63661977":[1],"imag":[],"search":[0],"argument":[1],"present":[1],"case":[1],"ident":[1],"these":[1],"new_x":[1],"n":[1],"will":[1],"defin":[0,1],"abov":[1],"error":[1],"new_i":[1],"is":[1],"it":[0,1],"in":[1],"quadrat":[1],"__init__":[1],"if":[1],"welcom":[0],"perform":[1],"make":[1],"same":[1],"9":[1],"document":[0],"complet":[0],"cubic":[1],"rais":[1],"user":[0,1],"i":[1],"markup":[],"well":[1],"exampl":[1],"thi":[0,1],"interpol":[0,1],"y":[1],"the":[0,1],"dimension":[1],"usual":[1],"just":[1],"when":[1],"pylab":[1],"72676046":[1],"easi":[1],"4":[1],"modul":[0],"format":[1],"know":[1],"like":[0],"55":[1],"56":[0],"51":[0],"datapoint":[0,1],"either":[1],"page":[0],"right":[1],"some":[1],"extrap_high":[1],"toctre":[0],"for":[1],"definit":[],"larg":[1],"be":[1],"run":[1],"usag":[0,1],"by":[0,1],"interpkw":[1],"on":[0,1],"about":[1],"of":[0,1],"slightli":[1],"or":[1],"block":[1],"own":[1],"effici":[1],"into":[1],"dataset":[1],"down":[1],"your":[0,1],"val":[1],"support":[1],"there":[1],"start":[1],"interfac":[0,1],"includ":[1],"function":[0,1],"form":[1],"interp":[1],"but":[0,1],"sphinx":[0],"line":[],"inlin":[],"with":[0,1],"possibl":[1],"default":[1],"bad_data":[1],"intern":[1],"us":[1],"below":[1],"z":[1],"curv":[1],"creat":[0,1],"dure":[1],"an":[1],"as":[1],"ar":[1],"at":[0,1],"file":[0],"no":[],"titl":[],"nan":[1],"afford":[1],"other":[1],"5":[1],"np":[1],"you":[0,1],"10":[1],"uniformli":[1],"e":[1],"ignor":[1],"2008":[0]}]
\ No newline at end of file
Modified: branches/Interpolate1D/docs/build/html/tutorial.html
===================================================================
--- branches/Interpolate1D/docs/build/html/tutorial.html 2008-07-30 20:14:30 UTC (rev 4582)
+++ branches/Interpolate1D/docs/build/html/tutorial.html 2008-07-30 20:32:32 UTC (rev 4583)
@@ -59,7 +59,8 @@
<h1 id="d-interpolation-with-the-functional-interface">1D Interpolation with the Functional Interface<a class="headerlink" href="#d-interpolation-with-the-functional-interface" title="Permalink to this headline">¶</a></h1>
<div class="section">
<h2 id="basic-usage">Basic Usage<a class="headerlink" href="#basic-usage" title="Permalink to this headline">¶</a></h2>
-<p>The following example uses the ‘interp1d’ function to linearly interpolate a sin curve from a sparse set of values.:</p>
+<p>The following example uses the ‘interp1d’ function to linearly interpolate a sin
+curve from a sparse set of values.</p>
<pre> # start up ipython for our examples.
$ ipython -pylab
@@ -78,8 +79,9 @@
In [9]: interp1d(x, y, array(1.2) )
Out [10]: 0.76394372684109768
- # To interpolate from these x,y values at multiple points, possibly to get a more dense set of new_x, new_y values,
-# pass a numpy array to interp1d, and the return type will also be a numpy array.
+ # To interpolate from these x,y values at multiple points, possibly to get a more dense set
+# of new_x, new_y values to approximate the function, pass a numpy array to interp1d,
+# and the return type will also be a numpy array.
In [4]: new_x = linspace(0, 2*pi, 21)
In [5]: new_y = interp1d(x, y, new_x)
Modified: branches/Interpolate1D/docs/tutorial.rst
===================================================================
--- branches/Interpolate1D/docs/tutorial.rst 2008-07-30 20:14:30 UTC (rev 4582)
+++ branches/Interpolate1D/docs/tutorial.rst 2008-07-30 20:32:32 UTC (rev 4583)
@@ -21,7 +21,8 @@
Basic Usage
-------------
-The following example uses the 'interp1d' function to linearly interpolate a sin curve from a sparse set of values.::
+The following example uses the 'interp1d' function to linearly interpolate a sin
+curve from a sparse set of values. ::
# start up ipython for our examples.
$ ipython -pylab
@@ -41,25 +42,24 @@
In [9]: interp1d(x, y, array(1.2) )
Out [10]: 0.76394372684109768
- # To interpolate from these x,y values at multiple points, possibly to get a more dense set of new_x, new_y values,
- # pass a numpy array to interp1d, and the return type will also be a numpy array.
+ # To interpolate from these x,y values at multiple points, possibly to get a more dense set
+ # of new_x, new_y values to approximate the function, pass a numpy array to interp1d,
+ # and the return type will also be a numpy array.
In [4]: new_x = linspace(0, 2*pi, 21)
In [5]: new_y = interp1d(x, y, new_x)
# Plot the results using matplotlib. [note examples assume you are running in ipython -pylab]
In [6]: plot(x, y, 'ro', new_x, new_y, 'b-')
-.. image:: interp1d_linear_simple.png
+.. image:: interp1d_linear_simple.png
::
-
+
# Alternatively, x, y and new_x can also be lists (they are internally converted into arrays
# before processing)
In []: interp1d( [1.0, 2.0], [1.0, 2.0], [1.3] )
Out []: array([ 1.3 ])
-
-
What happens if we pass in a new_x with values outside the range of x? By default, new_y will be
NaN at all such points: ::
@@ -68,7 +68,6 @@
In [7]: interp1d(x, y, array([-2, -1, 1, 2]))
Out [8]: array([ NaN, NaN, 0.63661977, 0.72676046])
-
If we want a type of interpolation other than linear, there is a range of options which we can specify
with the keyword argument interp, which is usually a string. For example::
@@ -78,7 +77,6 @@
.. image:: interp1d_linear_and_quadratic.png
-
There is a large selection of strings which specify a range of interpolation methods. The list includes:
#. 'linear' : linear interpolation, same as the default
More information about the Scipy-svn
mailing list