Ignore:
Timestamp:
04/06/07 10:35:17 (17 years ago)
Author:
pinsard
Message:

improvements/corrections of some *.pro headers + replace some message by some report

Location:
trunk/SRC/Documentation/idldoc_assistant_output/Interpolation
Files:
23 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/angle.html

    r234 r242  
    6464 north stereographic polar projection 
    6565 
     66 
    6667 Compute angles between grid lines and direction of the North pole 
    6768(fom angle.F,v 2.2 in OPA8.2) 
    … …  
    8081 
    8182     
     83 
    8284 
    8385     
    … …  
    252254     
    253255    <h4>Version</h4> 
    254  $Id: angle.pro 232 2007-03-20 16:59:36Z pinsard $ 
     256 $Id: angle.pro 238 2007-03-27 13:43:18Z pinsard $ 
     257 
    255258    <h4>History</h4> 
    256259       Original :  96-07 (O. Marti) 

  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/clickincell.html

    r234 r242  
    105105 
    106106     
    107  = 'T', 'W', 'U', 'V' or 'F' This this the type of point 
     107 = 'T', 'W', 'U', 'V' or 'F' 
     108 the type of point 
    108109     that is located in the center of the cell which the click is 
    109110     located. default is T type of cell (with corner defined by F 
    … …  
    174175 
    175176     
    176  see outputs 
     177 see returns 
    177178 
    178179     
    … …  
    190191 
    191192     
    192  Used to pass extra keywords to <a href=".//inquad.html">inquad</a> and  
     193 Used to pass extra keywords to <a href=".//inquad.html">inquad</a> and 
    193194 <proidl>plot</proidl> 
    194195 (when /drawcell) 
    … …  
    209210     
    210211    <h4>Version</h4> 
    211  $Id: clickincell.pro 232 2007-03-20 16:59:36Z pinsard $ 
     212 $Id: clickincell.pro 238 2007-03-27 13:43:18Z pinsard $ 
    212213 
    213214    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/compute_fromirr_bilinear_weigaddr.html

    r234 r242  
    235235     
    236236    <h4>Version</h4> 
    237  $Id: compute_fromirr_bilinear_weigaddr.pro 232 2007-03-20 16:59:36Z pinsard $ 
     237 $Id: compute_fromirr_bilinear_weigaddr.pro 238 2007-03-27 13:43:18Z pinsard $ 
    238238 
    239239    <h4>History</h4> 
    … …  
    257257  and the weight is redistributed on the remaining "water" corners 
    258258  -  points located out of the southern and northern boundaries or in cells 
    259   containing only land points are set the the same value as their closest neighbor 
     259  containing only land points are set the same value as their closest neighbor 
    260260 
    261261 

  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/compute_fromreg_bilinear_weigaddr.html

    r234 r242  
    236236     
    237237    <h4>Version</h4> 
    238  $Id: compute_fromreg_bilinear_weigaddr.pro 232 2007-03-20 16:59:36Z pinsard $ 
     238 $Id: compute_fromreg_bilinear_weigaddr.pro 238 2007-03-27 13:43:18Z pinsard $ 
    239239 
    240240    <h4>History</h4> 
    … …  
    249249    <h4>Restrictions</h4> 
    250250  - the input grid must be a "regular grid", defined as a grid for which each 
    251   longitudes lines have the same latitude and each latitudes columns have the 
     251  longitude lines have the same latitude and each latitude columns have the 
    252252  same longitude. 
    253253  - We supposed the data are located on a sphere, with a periodicity along 

  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/compute_fromreg_imoms3_weigaddr.html

    r234 r242  
    236236     
    237237    <h4>Version</h4> 
    238  $Id: compute_fromreg_imoms3_weigaddr.pro 231 2007-03-19 17:15:51Z pinsard $ 
     238 $Id: compute_fromreg_imoms3_weigaddr.pro 238 2007-03-27 13:43:18Z pinsard $ 
    239239 
    240240    <h4>History</h4> 
    … …  
    250250    <h4>Restrictions</h4> 
    251251  - the input grid must be a "regular/rectangular grid", defined as a grid for 
    252   which each longitudes lines have the same latitude and each latitudes columns 
     252  which each longitude lines have the same latitude and each latitude columns 
    253253  have the same longitude. 
    254254  -  We supposed the data are located on a sphere, with a periodicity along 

  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/cutpar.html

    r234 r242  
    209209     
    210210 1d arrays of p elements, giving the edge positions. 
    211  The edges must be given as in plot to draw the parallelogram. (see example). 
     211 The edges must be given as in <proidl>plot</proidl> to draw the  
     212 parallelogram. (see example). 
    212213 
    213214     
    … …  
    248249 
    249250     
    250  see outputs 
     251 see returns 
    251252 
    252253     
    … …  
    265266     
    266267 to specify that the points are located on a 
    267  sphere. In this case, x and y corresponds to longitude and 
     268 sphere. In this case, x and y correspond to longitude and 
    268269 latitude in degrees. 
    269270 

  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/cutsegment.html

    r234 r242  
    187187 
    188188     
    189  see outputs 
     189 see returns 
    190190 
    191191     
    … …  
    204204     
    205205 to specify that the points are located on a sphere. 
    206  In this case, x and y corresponds to longitude and latitude in degrees. 
     206 In this case, x and y correspond to longitude and latitude in degrees. 
    207207 
    208208     
    … …  
    210210 
    211211    <h3>Examples</h3><pre> 
    212  
    213212 IDL> x0=[2,5] 
    214213 IDL> y0=[5,1] 

  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/extrapolate.html

    r234 r242  
    6262 
    6363     
    64  extrapolate data (zinput) where maskinput eq 0 by filling step by 
     64 extrapolate data (zinput) where maskinput equal 0 by filling step by 
    6565 step the coastline points with the mean value of the 8 neighbourgs 
    6666 (weighted by their mask value). 
    … …  
    8181 
    8282 
    83     <h3>Return value</h3> {type=2d array} 
    84  the extrapolated array 
     83    <h3>Return value</h3> 
     84 the extrapolated 2d array 
    8585 
    8686 
    … …  
    137137 
    138138     
    139  Maximum number if iterations done in the extrapolation process. If there 
     139 Maximum number of iterations done in the extrapolation process. If there 
    140140 is no more masked values we exit extrapolate before reaching nb_iteration 
    141141 (to be sure to fill everything, you can use a very large value) 
    … …  
    225225     
    226226    <h4>Version</h4> 
    227  $Id: extrapolate.pro 232 2007-03-20 16:59:36Z pinsard $ 
     227 $Id: extrapolate.pro 238 2007-03-27 13:43:18Z pinsard $ 
    228228 
    229229    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/extrapsmooth.html

    r234 r242  
    6262 
    6363     
    64  similar to extrapolate but could to the job in a better way because the 
    65  extrapolated values are smoothed... takes more time than extrapolate. 
    66  extrapolate data where mskin eq 0 by filling 
     64 similar to <a href=".//extrapolate.html">extrapolate</a> but could to the job in a better way 
     65 because the extrapolated values are smoothed... 
     66 takes more time than <a href=".//extrapolate.html">extrapolate</a>. 
     67 extrapolate data where mskin is equal 0 by filling 
    6768 step by step the coastline points with the mean value of the 8 neighbourgs. 
    6869 
    … …  
    204205     
    205206    <h4>Version</h4> 
    206  $Id: extrapsmooth.pro 232 2007-03-20 16:59:36Z pinsard $ 
     207 $Id: extrapsmooth.pro 238 2007-03-27 13:43:18Z pinsard $ 
    207208    <h4>History</h4> 
    208209  January 2007: Sebastien Masson (smasson@lodyc.jussieu.fr) 

  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/fromirr.html

    r234 r242  
    101101 
    102102     
    103  a string defining the interpolation method. must be 'bilinear' 
     103 the interpolation method. must be 'bilinear' 
    104104 
    105105     
    … …  
    118118 
    119119     
    120  a 2D array the input data to interpolate 
     120 the input data to interpolate 
    121121 
    122122     
    … …  
    135135 
    136136     
    137  a 2D array defining the longitude of the input data 
     137 the longitude of the input data 
    138138 
    139139     
    … …  
    152152 
    153153     
    154  a 2D array defining the latitude of the input data. 
     154 the latitude of the input data. 
    155155 
    156156     
    … …  
    187187 
    188188     
    189  1D or 2D array defining the longitude of the output data. 
     189 the longitude of the output data. 
    190190 
    191191     
    … …  
    204204 
    205205     
    206  1D or 2D array defining the latitude of the output data. 
     206 the latitude of the output data. 
    207207 
    208208     
    … …  
    289289 IDL> help, a, b 
    290290 
    291  2) use a and b that are now defined to bypass the computation of the weights and addresses  
    292  and speed-up the computation! 
     291 2) use a and b that are now defined to bypass the computation of the weights  
     292 and addresses and speed-up the computation! 
    293293 
    294294 IDL> t2ncep = fromirr('bilinear', topa, WEIG = a, ADDR = b) 
    … …  
    297297     
    298298    <h4>Version</h4> 
    299  $Id: fromirr.pro 231 2007-03-19 17:15:51Z pinsard $ 
     299 $Id: fromirr.pro 238 2007-03-27 13:43:18Z pinsard $ 
    300300 
    301301    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/fromreg.html

    r234 r242  
    6464 interpolate data from a "regular/rectangular grid" to any grid. 
    6565   2 methods available: bilinear and imoms3 
    66    A "regular/rectangular grid" is defined as a grid for which each longitudes lines have 
    67    the same latitude and each latitudes columns have the same longitude. 
     66   A "regular/rectangular grid" is defined as a grid for which  
     67 each longitude lines have the same latitude and each latitude columns  
     68 have the same longitude. 
    6869 
    6970 
    … …  
    103104 
    104105     
    105  a string defining the interpolation method. 
     106 the interpolation method. 
    106107 must be 'bilinear' or 'imoms3' 
    107108 
    … …  
    121122 
    122123     
    123  a 2D array the input data to interpolate 
     124 the input data to interpolate 
    124125 
    125126     
    … …  
    138139 
    139140     
    140  1D or 2D array defining the longitude of the input data 
     141 the longitude of the input data 
    141142 
    142143     
    … …  
    155156 
    156157     
    157  1D or 2D array defining the latitude of the input data 
     158 the latitude of the input data 
    158159 
    159160     
    … …  
    172173 
    173174     
    174  1D or 2D array defining the longitude of the output data 
     175 the longitude of the output data 
    175176 
    176177     
    … …  
    189190 
    190191     
    191  1D or 2D array defining the latitude of the output data 
     192 the latitude of the output data 
    192193 
    193194     
    … …  
    284285  
    285286 1) get back the weights and addresses in variables a and b 
    286    (that must be undefined or equal to 0 before calling fromreg) 
     287   (that must be undefined or equal to 0 before calling fromreg 
    287288 
    288289 IDL> t1opa = fromreg('bilinear', t1ncep, xncep, yncep, glamt, gphit, WEIG = a, ADDR = b) 
    … …  
    297298     
    298299    <h4>Version</h4> 
    299  $Id: fromreg.pro 231 2007-03-19 17:15:51Z pinsard $ 
     300 $Id: fromreg.pro 238 2007-03-27 13:43:18Z pinsard $ 
    300301 
    301302    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/get_gridparams.html

    r234 r242  
    6666 
    6767 or 
    68  2) given longitude and latitude arrays get their dimensions and make 
     68 2) given longitude and latitude arrays, get their dimensions and make 
    6969 sure they are 1D or 2D arrays 
    7070 
    … …  
    104104     
    105105 Case 1: the name of the netcdf file 
    106  Case 2: 1d or 2D arrays defining longitudes and latitudes. 
     106 Case 2: 1d or 2d arrays defining longitudes and latitudes. 
    107107 Out: the variable that will contain the longitudes 
    108108 
    … …  
    123123     
    124124 Case 1: the name of the variable that contains the longitude in the NetCDF file 
    125  Case 2: 1d or 2D arrays defining longitudes and latitudes. 
     125 Case 2: 1d or 2d arrays defining longitudes and latitudes. 
    126126         Note that these arrays are also outputs and can therefore be modified. 
    127127 Out: the variable that will contain the latitudes 
    … …  
    181181 Case 2: 1 or 2 to specify if lon and lat should be 1D (jpi or jpj) 
    182182 arrays or 2D arrays (jpi,jpj). Note that of  n_dimensions = 1, then the 
    183  grid must be regular (each longitudes must be the same for all latitudes 
    184  and each latitudes should be the same for all longitudes). 
     183 grid must be regular (each longitude must be the same for all latitudes 
     184 and each latitude should be the same for all longitudes). 
    185185 
    186186     
    … …  
    270270 IDL> get_gridparams, lon, lat, jpi, jpj, n_dimensions 
    271271 
    272  1) 
    273272 
    274273 
    … …  
    281280     
    282281    <h4>Version</h4> 
    283  $Id: get_gridparams.pro 231 2007-03-19 17:15:51Z pinsard $ 
     282 $Id: get_gridparams.pro 238 2007-03-27 13:43:18Z pinsard $ 
    284283 
    285284    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/imoms3.html

    r234 r242  
    7575 
    7676 
    77  
    7877     
    7978 

  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/inquad.html

    r234 r242  
    8080 
    8181    <h3>Return value</h3> 
    82  a n element vector. Where n is the number of elements of 
     82 a n elements vector where n is the number of elements of 
    8383 x. res[i]=j means that the point number i is located in the 
    8484 quadrilateral number j with (0 <= j <= n_elements(x0)-1) 
    … …  
    300300     
    301301 the zoom (circle centered on the (x,y) with a radius of 
    302  zoomradius degree where we look for the the quadrilateral which 
     302 zoomradius degree where we look for the quadrilateral which 
    303303 contains the (x,y) point) used for the satellite projection 
    304304 when /ONSPHERE is activated. 
    … …  
    363363     
    364364    <h4>Version</h4> 
    365  $Id: inquad.pro 232 2007-03-20 16:59:36Z pinsard $ 
     365 $Id: inquad.pro 240 2007-03-28 12:17:24Z pinsard $ 
    366366 
    367367    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/inrecgrid.html

    r234 r242  
    7272      <a name="#_inrecgrid"></a> 
    7373 
    74       <h2>inrecgrid  <font size="-1" color="#006633">  
     74      <h2>inrecgrid  <font size="-1" color="#006633"> 
    7575 Without loop 
    7676</font></h2> 
    … …  
    215215     
    216216    <h4>Version</h4> 
    217  $Id: inrecgrid.pro 231 2007-03-19 17:15:51Z pinsard $ 
     217 $Id: inrecgrid.pro 238 2007-03-27 13:43:18Z pinsard $ 
    218218 
    219219    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/ll_narcs_distances.html

    r234 r242  
    6464 This function returns the longitude and latitude [lon, lat] of 
    6565 a point a given arc distance (-pi <= Arc_Dist <= pi), and azimuth (Az), 
    66  from a specified location Lon0, lat0. 
    67  Same as LL_ARC_DISTANCE but for n points without do loop. 
     66 from a specified location Lon0, Lat0. 
     67 Same as <proidl>LL_ARC_DISTANCE</proidl> but for n points without do loop. 
    6868 
    6969 Formula from Map Projections - a working manual.  USGS paper 
    … …  
    7676      <a name="#_ll_narcs_distances"></a> 
    7777 
    78       <h2>ll_narcs_distances  <font size="-1" color="#006633">  
     78      <h2>ll_narcs_distances  <font size="-1" color="#006633"> 
    7979 Mapping, geography 
    8080</font></h2> 
    … …  
    8686 
    8787    <h3>Return value</h3> 
    88  a (2, n) array containing the longitude/latitude of the resulting points. 
     88 a (2,n) array containing the longitude/latitude of the resulting points. 
    8989 Values are in radians unless the keyword DEGREES is set. 
    9090 
    … …  
    215215     
    216216    <h4>Version</h4> 
    217  $Id: ll_narcs_distances.pro 231 2007-03-19 17:15:51Z pinsard $ 
     217 $Id: ll_narcs_distances.pro 238 2007-03-27 13:43:18Z pinsard $ 
    218218 
    219219    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/map_npoints.html

    r234 r242  
    6666 returns the distances between number n of P0 points and number 
    6767 n of P1 points (in that case, np0 and np1 must be equal). 
    68  Same as map_2points with the meter parameter but for n points 
    69  without do loop. 
     68 Same as <proidl>map_2points</proidl> with the meter parameter but for n 
     69 points without do loop. 
    7070 
    7171 
    … …  
    8888 points P0 and np1 points P1. Element (i,j) of the output is the 
    8989 distance between element P0[i] and P1[j]. 
    90  If keyword /TWO_BY_TWO is given then Map_nPoints returns 
    91  an np-element vector giving the distance in meter between P0[i] 
     90 If keyword /TWO_BY_TWO is given then <a href=".//map_npoints.html">map_npoints</a> returns 
     91 an np-elements vector giving the distance in meter between P0[i] 
    9292 and P1[i] (in that case, we have np0 = np1 = np) ; if /MIDDLE see this keyword. 
    9393 
    … …  
    245245 
    246246     
    247  If given,then Map_nPoints returns the distances between number n of 
    248  P0 points and number n of P1 points 
     247 If given, then <a href=".//map_npoints.html">map_npoints</a> returns the distances between  
     248 number n of P0 points and number n of P1 pointsi. 
    249249 In that case, np0 and np1 must be equal. 
    250250 
    … …  
    301301     
    302302    <h4>Version</h4> 
    303  $Id: map_npoints.pro 231 2007-03-19 17:15:51Z pinsard $ 
     303 $Id: map_npoints.pro 238 2007-03-27 13:43:18Z pinsard $ 
    304304 
    305305    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/neighbor.html

    r234 r242  
    6262 
    6363     
    64  find the closetest point of (P0) within a list of np1 points 
    65  P1 Which can be on a sphere 
     64 find the closest point of (P0) within a list of np1 points 
     65 P1 which can be on a sphere 
    6666 
    6767 
    … …  
    7575</font></h2> 
    7676 
    77       <p><font face="Courier"><i>result = </i>neighbor(<i><a href="#_neighbor_keyword_p0lon">p0lon</a>, <a href="#_neighbor_keyword_p0lat">p0lat</a>[, <a href="#_neighbor_keyword_neighlon">neighlon</a>][, <a href="#_neighbor_keyword_neighlat">neighlat</a>]</i>, <a href="#_neighbor_keyword_sphere">sphere</a>=<i>sphere</i>, <a href="#_neighbor_keyword_distance">distance</a>=<i>distance</i>, <a href="#_neighbor_keyword_radians">radians</a>=<i>radians</i>)</font></p> 
     77      <p><font face="Courier"><i>result = </i>neighbor(<i><a href="#_neighbor_keyword_p0lon">p0lon</a>, <a href="#_neighbor_keyword_p0lat">p0lat</a>[, <a href="#_neighbor_keyword_neighlon">neighlon</a>][, <a href="#_neighbor_keyword_neighlat">neighlat</a>]</i>, <a href="#_neighbor_keyword_SPHERE">SPHERE</a>=<i>SPHERE</i>, <a href="#_neighbor_keyword_DISTANCE">DISTANCE</a>=<i>DISTANCE</i>, <a href="#_neighbor_keyword_RADIANS">RADIANS</a>=<i>RADIANS</i>)</font></p> 
    7878 
    7979     
    … …  
    9595      <font size="-1" color="#006633">required</font> 
    9696       
    97        
    98        
    99        
    100     </h4> 
    101  
    102      
    103  scalar. longitudes of point P0. 
     97      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     98       
     99       
     100    </h4> 
     101 
     102     
     103 longitudes of point P0. 
    104104 
    105105     
    … …  
    112112      <font size="-1" color="#006633">required</font> 
    113113       
    114        
    115        
    116        
    117     </h4> 
    118  
    119      
    120  scalar. latitudes of point P0. 
     114      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     115       
     116       
     117    </h4> 
     118 
     119     
     120 latitudes of point P0. 
    121121 
    122122     
    … …  
    159159 
    160160     
    161     <a name="#_neighbor_keyword_sphere"></a> 
    162     <h4>sphere&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    163        
    164        
    165        
    166        
    167        
    168        
    169        
    170        
    171     </h4> 
    172  
    173      to activate if points are located on a sphere. 
    174  
    175      
    176     <a name="#_neighbor_keyword_distance"></a> 
    177     <h4>distance&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     161    <a name="#_neighbor_keyword_SPHERE"></a> 
     162    <h4>SPHERE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     163       
     164       
     165       
     166       
     167       
     168       
     169       
     170       
     171    </h4> 
     172 
     173     
     174 to activate if points are located on a sphere. 
     175 
     176     
     177    <a name="#_neighbor_keyword_DISTANCE"></a> 
     178    <h4>DISTANCE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    178179       
    179180       
    … …  
    191192 
    192193     
    193     <a name="#_neighbor_keyword_radians"></a> 
    194     <h4>radians&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     194    <a name="#_neighbor_keyword_RADIANS"></a> 
     195    <h4>RADIANS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    195196       
    196197       
    … …  
    219220     
    220221    <h4>Version</h4> 
    221  $Id: neighbor.pro 231 2007-03-19 17:15:51Z pinsard $ 
     222 $Id: neighbor.pro 238 2007-03-27 13:43:18Z pinsard $ 
    222223 
    223224    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/quadrilateral2square.html

    r234 r242  
    9090 
    9191    <h3>Return value</h3> 
    92  
    93  (2,n) array: the new coordinates (xout, yout) of the (xin,yin) point(s) after 
     92 (2,n) array: the new coordinates (xout,yout) of the (xin,yin) point(s) after 
    9493 mapping. 
    9594 If xin is a scalar, then n is equal to the number of elements of x0. 
    96  If xin is an array , then n is equal to the number of elements of xin. 
     95 If xin is an array, then n is equal to the number of elements of xin. 
    9796 
    9897 
    … …  
    299298     
    300299    <h4>Version</h4> 
    301  $Id: quadrilateral2square.pro 231 2007-03-19 17:15:51Z pinsard $ 
     300 $Id: quadrilateral2square.pro 238 2007-03-27 13:43:18Z pinsard $ 
    302301 
    303302    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/spl_fstdrv.html

    r234 r242  
    6262 
    6363     
    64  SPL_FSTDRV returns the values of the first derivative of 
     64 returns the values of the first derivative of 
    6565 the interpolating function at the points X2i. It is a double 
    6666 precision array. 
    6767 
    6868 Given the arrays X and Y, which tabulate a function (with the X[i] 
    69  AND Y[i] in ascending order), and given an input value X2, the 
    70  SPL_INCR function returns an interpolated value for the given values 
    71  of X2. The interpolation method is based on cubic spline, corrected 
    72  in a way that interpolated value are also in ascending order 
     69 and Y[i] in ascending order), and given an input value X2, the 
     70 <a href=".//spl_incr.html">spl_incr</a> function returns an interpolated value for the given 
     71 values of X2. The interpolation method is based on cubic spline, corrected 
     72 in a way that interpolated value are also in ascending order. 
    7373 
    7474 
    … …  
    106106 
    107107     
    108  An n-element (at least 2) input vector that specifies the 
     108 An n-elements (at least 2) input vector that specifies the 
    109109 tabulate points in ascending order. 
    110110 
    … …  
    124124 
    125125     
    126  f(x) = y. An n-element input vector that specifies the values 
     126 f(x) = y. An n-elements input vector that specifies the values 
    127127 of the tabulated function F(Xi) corresponding to Xi. 
    128128 
    … …  
    142142 
    143143     
    144  The output from SPL_INIT for the specified X and Y. 
     144 The output from <proidl>SPL_INIT</pro> for the specified X and Y. 
    145145 
    146146     
    … …  
    153153      <font size="-1" color="#006633">required</font> 
    154154       
    155        
     155      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i> scalar or array</i></font> 
    156156       
    157157       
    … …  
    160160     
    161161 The input values for which the first derivative values are desired. 
    162  X can be scalar or an array of values. 
    163162 
    164163     
    … …  
    173172     
    174173    <h4>Version</h4> 
    175  $Id: spl_fstdrv.pro 231 2007-03-19 17:15:51Z pinsard $ 
     174 $Id: spl_fstdrv.pro 238 2007-03-27 13:43:18Z pinsard $ 
    176175 
    177176    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/spl_incr.html

    r234 r242  
    6262 
    6363     
    64  
    6564 Given the arrays X and Y, which tabulate a function (with the X[i] 
    6665 AND Y[i] in ascending order), and given an input value X2, the 
    67  SPL_INCR function returns an interpolated value for the given values 
     66 spl_incr function returns an interpolated value for the given values 
    6867 of X2. The interpolation method is based on cubic spline, corrected 
    6968 in a way that interpolated values are also monotonically increasing. 
    … …  
    7978       
    8079      <dt><a href="#_pure_convex"><i>result = </i>pure_convex(<i>x1, x2, y1, y2, der2, x</i>)</a><dt> 
    81       <dd><font size="-1"></font></dd> 
     80      <dd><font size="-1"> </font></dd> 
    8281       
    8382      <dt><a href="#_spl_incr"><i>result = </i>spl_incr(<i>x, y, x2</i>, YP0=<i>YP0</i>, YPN_1=<i>YPN_1</i>)</a><dt> 
    84       <dd><font size="-1"></font></dd> 
     83      <dd><font size="-1"> </font></dd> 
    8584       
    8685    </dl> 
    … …  
    10099 
    101100    <h3>Return value</h3> 
    102  
    103     y2: f(x2) = y2. Double precision array 
     101 y2: f(x2) = y2. Double precision array 
    104102 
    105103 
    … …  
    121119 
    122120     
    123  An n-element (at least 2) input vector that specifies the tabulate points in 
     121 An n-elements (at least 2) input vector that specifies the tabulate points in 
    124122 a strict ascending order. 
    125123 
    … …  
    157155 
    158156     
    159  f(x) = y. An n-element input vector that specifies the values 
     157 f(x) = y. An n-elements input vector that specifies the values 
    160158 of the tabulated function F(Xi) corresponding to Xi. As f is 
    161159 supposed to be monotonically increasing, y values must be 
    … …  
    215213 
    216214    <h3>Examples</h3><pre> 
    217  
    218215 IDL> n = 100L 
    219216 IDL> x = (dindgen(n))^2 
    … …  
    238235     
    239236    <h4>Version</h4> 
    240  $Id: spl_incr.pro 231 2007-03-19 17:15:51Z pinsard $ 
     237 $Id: spl_incr.pro 238 2007-03-27 13:43:18Z pinsard $ 
    241238 
    242239    <h4>History</h4> 
    … …  
    273270     
    274271 
     272 
    275273     
    276274 
    … …  
    292290 
    293291     
    294  An n-element (at least 2) input vector that specifies the tabulate points in 
     292 An n-elements (at least 2) input vector that specifies the tabulate points in 
    295293 a strict ascending order. 
    296294 
    … …  
    328326 
    329327     
    330  f(x) = y. An n-element input vector that specifies the values 
     328 f(x) = y. An n-elements input vector that specifies the values 
    331329    of the tabulated function F(Xi) corresponding to Xi. As f is 
    332330    supposed to be monotonically increasing, y values must be 
    … …  
    363361 
    364362     
     363 
    365364     
    366365 
    … …  
    416415     
    417416 
     417 
    418418     
    419419 
    … …  
    484484    </h4> 
    485485 
    486      The first derivative of the interpolating function at the 
     486     
     487 The first derivative of the interpolating function at the 
    487488    point X0. If YP0 is omitted, the second derivative at the 
    488489    boundary is set to zero, resulting in a "natural spline." 
     490 
    489491     
    490492    <a name="#_spl_incr_keyword_YPN_1"></a> 
    … …  
    500502    </h4> 
    501503 
    502      The first derivative of the interpolating function at the 
     504     
     505 The first derivative of the interpolating function at the 
    503506    point Xn-1. If YPN_1 is omitted, the second derivative at the 
    504507    boundary is set to zero, resulting in a "natural spline." 

  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/spl_keep_mean.html

    r234 r242  
    6262 
    6363     
    64  
    6564 Given the arrays X and Y, which tabulate a function (with the X[i] 
    6665 AND Y[i] in ascending order), and given an input value X2, the 
    67  SPL_INCR function returns an interpolated value for the given values 
     66 <a href=".//spl_incr.html">spl_incr</a> function returns an interpolated value for the given values 
    6867 of X2. The interpolation method is based on cubic spline, corrected 
    6968 in a way that integral of the interpolated values is the same as the 
    … …  
    107106 
    108107     
    109  An n-element (at least 2) input vector that specifies the tabulate points in 
     108 An n-elements (at least 2) input vector that specifies the tabulate points in 
    110109 a strict ascending order. 
    111110 
    … …  
    233232     
    234233    <h4>Version</h4> 
    235  $Id: spl_keep_mean.pro 232 2007-03-20 16:59:36Z pinsard $ 
     234 $Id: spl_keep_mean.pro 238 2007-03-27 13:43:18Z pinsard $ 
    236235 
    237236    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/square2quadrilateral.html

    r234 r242  
    8888 
    8989    <h3>Return value</h3> 
    90  (2,n) array: the new coordinates (xout, yout) of the (xin,yin) 
     90 (2,n) array: the new coordinates (xout,yout) of the (xin,yin) 
    9191 point(s) after mapping. 
    9292 If xin is a scalar, then n is equal to the number of elements of 
    9393 x0. If xin is an array , then n is equal to the number of 
    9494 elements of xin. 
    95  If xin and yin are omited, square2quadrilateral returns the 
     95 If xin and yin are omited, <a href=".//square2quadrilateral.html">square2quadrilateral</a> returns the 
    9696 matrix A which is used for the inverse transformation. 
    9797 
    … …  
    223223 Can be scalar or array. 
    224224 (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are given in the anticlockwise order. 
    225  
    226225 
    227226     
    … …  
    274273     
    275274    <h4>Version</h4> 
    276  $Id: square2quadrilateral.pro 231 2007-03-19 17:15:51Z pinsard $ 
     275 $Id: square2quadrilateral.pro 238 2007-03-27 13:43:18Z pinsard $ 
    277276 
    278277    <h4>History</h4> 
Note: See TracChangeset for help on using the changeset viewer.