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_html_output/Interpolation
Files:
24 edited

Legend:

Unmodified
Added
Removed

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

    r234 r242  
    9090 north stereographic polar projection 
    9191 
     92 
    9293 Compute angles between grid lines and direction of the North pole 
    9394(fom angle.F,v 2.2 in OPA8.2) 
    … …  
    114115            angle<span class="result">, <a href="#_angle_param_fileocemesh">fileocemesh</a>, <a href="#_angle_param_gcosu">gcosu</a>, <a href="#_angle_param_gsinu">gsinu</a>, <a href="#_angle_param_gcosv">gcosv</a>, <a href="#_angle_param_gsinv">gsinv</a>, <a href="#_angle_param_gcost">gcost</a>, <a href="#_angle_param_gsint">gsint</a></span>, <a href="#_angle_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">scalar string</span>, <a href="#_angle_keyword_DOUBLE">DOUBLE</a>=<span class="result">1 ou 2</span></p> 
    115116         
    116           <div class="comments"></div> 
     117          <div class="comments"> 
     118</div> 
    117119 
    118120           
    … …  
    273275           
    274276          <h4>Version</h4><div class="preformat"> 
    275  $Id: angle.pro 232 2007-03-20 16:59:36Z pinsard $</div> 
     277 $Id: angle.pro 238 2007-03-27 13:43:18Z pinsard $ 
     278</div> 
    276279          <h4>History</h4><div class="preformat"> 
    277280       Original :  96-07 (O. Marti) 

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

    r234 r242  
    139139         
    140140            <div class="comments"> 
    141  = 'T', 'W', 'U', 'V' or 'F' This this the type of point 
     141 = 'T', 'W', 'U', 'V' or 'F' 
     142 the type of point 
    142143     that is located in the center of the cell which the click is 
    143144     located. default is T type of cell (with corner defined by F 
    … …  
    204205         
    205206            <div class="comments"> 
    206  see outputs 
     207 see returns 
    207208</div> 
    208209             
    … …  
    219220         
    220221            <div class="comments"> 
    221  Used to pass extra keywords to <a href=".//inquad.html">inquad</a> and  
     222 Used to pass extra keywords to <a href=".//inquad.html">inquad</a> and 
    222223 <proidl>plot</proidl> 
    223224 (when /drawcell) 
    … …  
    238239           
    239240          <h4>Version</h4><div class="preformat"> 
    240  $Id: clickincell.pro 232 2007-03-20 16:59:36Z pinsard $ 
     241 $Id: clickincell.pro 238 2007-03-27 13:43:18Z pinsard $ 
    241242</div> 
    242243          <h4>History</h4><div class="preformat"> 

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

    r234 r242  
    256256           
    257257          <h4>Version</h4><div class="preformat"> 
    258  $Id: compute_fromirr_bilinear_weigaddr.pro 232 2007-03-20 16:59:36Z pinsard $ 
     258 $Id: compute_fromirr_bilinear_weigaddr.pro 238 2007-03-27 13:43:18Z pinsard $ 
    259259</div> 
    260260          <h4>History</h4><div class="preformat"> 
    … …  
    278278  and the weight is redistributed on the remaining "water" corners 
    279279  -  points located out of the southern and northern boundaries or in cells 
    280   containing only land points are set the the same value as their closest neighbor 
     280  containing only land points are set the same value as their closest neighbor 
    281281</div> 
    282282         

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

    r234 r242  
    259259           
    260260          <h4>Version</h4><div class="preformat"> 
    261  $Id: compute_fromreg_bilinear_weigaddr.pro 232 2007-03-20 16:59:36Z pinsard $ 
     261 $Id: compute_fromreg_bilinear_weigaddr.pro 238 2007-03-27 13:43:18Z pinsard $ 
    262262</div> 
    263263          <h4>History</h4><div class="preformat"> 
    … …  
    272272          <h4>Restrictions</h4><div class="preformat"> 
    273273  - the input grid must be a "regular grid", defined as a grid for which each 
    274   longitudes lines have the same latitude and each latitudes columns have the 
     274  longitude lines have the same latitude and each latitude columns have the 
    275275  same longitude. 
    276276  - We supposed the data are located on a sphere, with a periodicity along 

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

    r234 r242  
    259259           
    260260          <h4>Version</h4><div class="preformat"> 
    261  $Id: compute_fromreg_imoms3_weigaddr.pro 231 2007-03-19 17:15:51Z pinsard $ 
     261 $Id: compute_fromreg_imoms3_weigaddr.pro 238 2007-03-27 13:43:18Z pinsard $ 
    262262</div> 
    263263          <h4>History</h4><div class="preformat"> 
    … …  
    273273          <h4>Restrictions</h4><div class="preformat"> 
    274274  - the input grid must be a "regular/rectangular grid", defined as a grid for 
    275   which each longitudes lines have the same latitude and each latitudes columns 
     275  which each longitude lines have the same latitude and each latitude columns 
    276276  have the same longitude. 
    277277  -  We supposed the data are located on a sphere, with a periodicity along 

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

    r234 r242  
    229229          <div class="comments"> 
    230230 1d arrays of p elements, giving the edge positions. 
    231  The edges must be given as in plot to draw the parallelogram. (see example). 
     231 The edges must be given as in <proidl>plot</proidl> to draw the  
     232 parallelogram. (see example). 
    232233</div> 
    233234             
    … …  
    266267         
    267268            <div class="comments"> 
    268  see outputs 
     269 see returns 
    269270</div> 
    270271             
    … …  
    282283            <div class="comments"> 
    283284 to specify that the points are located on a 
    284  sphere. In this case, x and y corresponds to longitude and 
     285 sphere. In this case, x and y correspond to longitude and 
    285286 latitude in degrees. 
    286287</div> 

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

    r234 r242  
    213213         
    214214            <div class="comments"> 
    215  see outputs 
     215 see returns 
    216216</div> 
    217217             
    … …  
    229229            <div class="comments"> 
    230230 to specify that the points are located on a sphere. 
    231  In this case, x and y corresponds to longitude and latitude in degrees. 
     231 In this case, x and y correspond to longitude and latitude in degrees. 
    232232</div> 
    233233             
    … …  
    235235 
    236236          <h3>Examples</h3><div class="preformat"> 
    237  
    238237 IDL> x0=[2,5] 
    239238 IDL> y0=[5,1] 

  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/directory-overview.html

    r234 r242  
    9090       
    9191        <dt><a href="angle.html">angle.pro</a></dt> 
    92         <dd>  north stereographic polar projection   Compute angles between grid lines and direction of the North pole (fom angle.</dd> 
     92        <dd>  north stereographic polar projection    Compute angles between grid lines and direction of the North pole (fom angle.</dd> 
    9393       
    9494        <dt><a href="clickincell.html">clickincell.pro</a></dt> 
    … …  
    111111       
    112112        <dt><a href="extrapolate.html">extrapolate.pro</a></dt> 
    113         <dd>  extrapolate data (zinput) where maskinput eq 0 by filling step by  step the coastline points with the mean value of the 8 neighbourgs  (weighted by their mask value).</dd> 
     113        <dd>  extrapolate data (zinput) where maskinput equal 0 by filling step by  step the coastline points with the mean value of the 8 neighbourgs  (weighted by their mask value).</dd> 
    114114       
    115115        <dt><a href="extrapsmooth.html">extrapsmooth.pro</a></dt> 
    116         <dd>  similar to extrapolate but could to the job in a better way because the extrapolated values are smoothed.</dd> 
     116        <dd>  similar to <a href=".//extrapolate.html">extrapolate</a> but could to the job in a better way  because the extrapolated values are smoothed.</dd> 
    117117       
    118118        <dt><a href="fromirr.html">fromirr.pro</a></dt> 
    … …  
    123123       
    124124        <dt><a href="get_gridparams.html">get_gridparams.pro</a></dt> 
    125         <dd>  1) extract from a NetCDF file the longitude, latitude, and their dimensions  and make sure it is 1D or 2D arrays   or  2) given longitude and latitude arrays get their dimensions and make  sure they are 1D or 2D arrays </dd> 
     125        <dd>  1) extract from a NetCDF file the longitude, latitude, and their dimensions  and make sure it is 1D or 2D arrays   or  2) given longitude and latitude arrays, get their dimensions and make  sure they are 1D or 2D arrays </dd> 
    126126       
    127127        <dt><a href="imoms3.html">imoms3.pro</a></dt> 
    … …  
    135135       
    136136        <dt><a href="ll_narcs_distances.html">ll_narcs_distances.pro</a></dt> 
    137         <dd>  This function returns the longitude and latitude [lon, lat] of  a point a given arc distance (-pi <= Arc_Dist <= pi), and azimuth (Az),  from a specified location Lon0, lat0.</dd> 
     137        <dd>  This function returns the longitude and latitude [lon, lat] of  a point a given arc distance (-pi <= Arc_Dist <= pi), and azimuth (Az),  from a specified location Lon0, Lat0.</dd> 
    138138       
    139139        <dt><a href="map_npoints.html">map_npoints.pro</a></dt> 
    … …  
    141141       
    142142        <dt><a href="neighbor.html">neighbor.pro</a></dt> 
    143         <dd>  find the closetest point of (P0) within a list of np1 points  P1 Which can be on a sphere </dd> 
     143        <dd>  find the closest point of (P0) within a list of np1 points  P1 which can be on a sphere </dd> 
    144144       
    145145        <dt><a href="quadrilateral2square.html">quadrilateral2square.pro</a></dt> 
    … …  
    147147       
    148148        <dt><a href="spl_fstdrv.html">spl_fstdrv.pro</a></dt> 
    149         <dd>  SPL_FSTDRV returns the values of the first derivative of  the interpolating function at the points X2i.</dd> 
     149        <dd>  returns the values of the first derivative of  the interpolating function at the points X2i.</dd> 
    150150       
    151151        <dt><a href="spl_incr.html">spl_incr.pro</a></dt> 
    152         <dd>   Given the arrays X and Y, which tabulate a function (with the X[i]  AND Y[i] in ascending order), and given an input value X2, the  SPL_INCR function returns an interpolated value for the given values  of X2.</dd> 
     152        <dd>  Given the arrays X and Y, which tabulate a function (with the X[i]  AND Y[i] in ascending order), and given an input value X2, the  spl_incr function returns an interpolated value for the given values  of X2.</dd> 
    153153       
    154154        <dt><a href="spl_keep_mean.html">spl_keep_mean.pro</a></dt> 
    155         <dd>   Given the arrays X and Y, which tabulate a function (with the X[i]  AND Y[i] in ascending order), and given an input value X2, the  SPL_INCR function returns an interpolated value for the given values  of X2.</dd> 
     155        <dd>  Given the arrays X and Y, which tabulate a function (with the X[i]  AND Y[i] in ascending order), and given an input value X2, the  <a href=".//spl_incr.html">spl_incr</a> function returns an interpolated value for the given values  of X2.</dd> 
    156156       
    157157        <dt><a href="square2quadrilateral.html">square2quadrilateral.pro</a></dt> 

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

    r234 r242  
    8888 
    8989      <div id="file_comments"> 
    90  extrapolate data (zinput) where maskinput eq 0 by filling step by 
     90 extrapolate data (zinput) where maskinput equal 0 by filling step by 
    9191 step the coastline points with the mean value of the 8 neighbourgs 
    9292 (weighted by their mask value). 
    … …  
    116116</div> 
    117117 
    118           <h3>Return value</h3><div class="preformat"> {type=2d array} 
    119  the extrapolated array 
     118          <h3>Return value</h3><div class="preformat"> 
     119 the extrapolated 2d array 
    120120</div> 
    121121 
    … …  
    167167         
    168168          <div class="comments"> 
    169  Maximum number if iterations done in the extrapolation process. If there 
     169 Maximum number of iterations done in the extrapolation process. If there 
    170170 is no more masked values we exit extrapolate before reaching nb_iteration 
    171171 (to be sure to fill everything, you can use a very large value) 
    … …  
    252252           
    253253          <h4>Version</h4><div class="preformat"> 
    254  $Id: extrapolate.pro 232 2007-03-20 16:59:36Z pinsard $ 
     254 $Id: extrapolate.pro 238 2007-03-27 13:43:18Z pinsard $ 
    255255</div> 
    256256          <h4>History</h4><div class="preformat"> 

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

    r234 r242  
    8888 
    8989      <div id="file_comments"> 
    90  similar to extrapolate but could to the job in a better way because the 
    91  extrapolated values are smoothed... takes more time than extrapolate. 
    92  extrapolate data where mskin eq 0 by filling 
     90 similar to <a href=".//extrapolate.html">extrapolate</a> but could to the job in a better way 
     91 because the extrapolated values are smoothed... 
     92 takes more time than <a href=".//extrapolate.html">extrapolate</a>. 
     93 extrapolate data where mskin is equal 0 by filling 
    9394 step by step the coastline points with the mean value of the 8 neighbourgs. 
    9495</div> 
    … …  
    233234           
    234235          <h4>Version</h4><div class="preformat"> 
    235  $Id: extrapsmooth.pro 232 2007-03-20 16:59:36Z pinsard $</div> 
     236 $Id: extrapsmooth.pro 238 2007-03-27 13:43:18Z pinsard $</div> 
    236237          <h4>History</h4><div class="preformat"> 
    237238  January 2007: Sebastien Masson (smasson@lodyc.jussieu.fr) 

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

    r234 r242  
    135135         
    136136          <div class="comments"> 
    137  a string defining the interpolation method. must be 'bilinear' 
     137 the interpolation method. must be 'bilinear' 
    138138</div> 
    139139             
    … …  
    150150         
    151151          <div class="comments"> 
    152  a 2D array the input data to interpolate 
     152 the input data to interpolate 
    153153</div> 
    154154             
    … …  
    165165         
    166166          <div class="comments"> 
    167  a 2D array defining the longitude of the input data 
     167 the longitude of the input data 
    168168</div> 
    169169             
    … …  
    180180         
    181181          <div class="comments"> 
    182  a 2D array defining the latitude of the input data. 
     182 the latitude of the input data. 
    183183</div> 
    184184             
    … …  
    211211         
    212212          <div class="comments"> 
    213  1D or 2D array defining the longitude of the output data. 
     213 the longitude of the output data. 
    214214</div> 
    215215             
    … …  
    226226         
    227227          <div class="comments"> 
    228  1D or 2D array defining the latitude of the output data. 
     228 the latitude of the output data. 
    229229</div> 
    230230             
    … …  
    308308 IDL> help, a, b 
    309309 
    310  2) use a and b that are now defined to bypass the computation of the weights and addresses  
    311  and speed-up the computation! 
     310 2) use a and b that are now defined to bypass the computation of the weights  
     311 and addresses and speed-up the computation! 
    312312 
    313313 IDL> t2ncep = fromirr('bilinear', topa, WEIG = a, ADDR = b) 
    … …  
    316316           
    317317          <h4>Version</h4><div class="preformat"> 
    318  $Id: fromirr.pro 231 2007-03-19 17:15:51Z pinsard $ 
     318 $Id: fromirr.pro 238 2007-03-27 13:43:18Z pinsard $ 
    319319</div> 
    320320          <h4>History</h4><div class="preformat"> 

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

    r234 r242  
    9090 interpolate data from a "regular/rectangular grid" to any grid. 
    9191   2 methods available: bilinear and imoms3 
    92    A "regular/rectangular grid" is defined as a grid for which each longitudes lines have 
    93    the same latitude and each latitudes columns have the same longitude. 
     92   A "regular/rectangular grid" is defined as a grid for which  
     93 each longitude lines have the same latitude and each latitude columns  
     94 have the same longitude. 
    9495</div> 
    9596 
    … …  
    137138         
    138139          <div class="comments"> 
    139  a string defining the interpolation method. 
     140 the interpolation method. 
    140141 must be 'bilinear' or 'imoms3' 
    141142</div> 
    … …  
    153154         
    154155          <div class="comments"> 
    155  a 2D array the input data to interpolate 
     156 the input data to interpolate 
    156157</div> 
    157158             
    … …  
    168169         
    169170          <div class="comments"> 
    170  1D or 2D array defining the longitude of the input data 
     171 the longitude of the input data 
    171172</div> 
    172173             
    … …  
    183184         
    184185          <div class="comments"> 
    185  1D or 2D array defining the latitude of the input data 
     186 the latitude of the input data 
    186187</div> 
    187188             
    … …  
    198199         
    199200          <div class="comments"> 
    200  1D or 2D array defining the longitude of the output data 
     201 the longitude of the output data 
    201202</div> 
    202203             
    … …  
    213214         
    214215          <div class="comments"> 
    215  1D or 2D array defining the latitude of the output data 
     216 the latitude of the output data 
    216217</div> 
    217218             
    … …  
    305306  
    306307 1) get back the weights and addresses in variables a and b 
    307    (that must be undefined or equal to 0 before calling fromreg) 
     308   (that must be undefined or equal to 0 before calling fromreg 
    308309 
    309310 IDL> t1opa = fromreg('bilinear', t1ncep, xncep, yncep, glamt, gphit, WEIG = a, ADDR = b) 
    … …  
    318319           
    319320          <h4>Version</h4><div class="preformat"> 
    320  $Id: fromreg.pro 231 2007-03-19 17:15:51Z pinsard $ 
     321 $Id: fromreg.pro 238 2007-03-27 13:43:18Z pinsard $ 
    321322</div> 
    322323          <h4>History</h4><div class="preformat"> 

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

    r234 r242  
    9292 
    9393 or 
    94  2) given longitude and latitude arrays get their dimensions and make 
     94 2) given longitude and latitude arrays, get their dimensions and make 
    9595 sure they are 1D or 2D arrays 
    9696</div> 
    … …  
    138138          <div class="comments"> 
    139139 Case 1: the name of the netcdf file 
    140  Case 2: 1d or 2D arrays defining longitudes and latitudes. 
     140 Case 2: 1d or 2d arrays defining longitudes and latitudes. 
    141141 Out: the variable that will contain the longitudes 
    142142</div> 
    … …  
    155155          <div class="comments"> 
    156156 Case 1: the name of the variable that contains the longitude in the NetCDF file 
    157  Case 2: 1d or 2D arrays defining longitudes and latitudes. 
     157 Case 2: 1d or 2d arrays defining longitudes and latitudes. 
    158158         Note that these arrays are also outputs and can therefore be modified. 
    159159 Out: the variable that will contain the latitudes 
    … …  
    207207 Case 2: 1 or 2 to specify if lon and lat should be 1D (jpi or jpj) 
    208208 arrays or 2D arrays (jpi,jpj). Note that of  n_dimensions = 1, then the 
    209  grid must be regular (each longitudes must be the same for all latitudes 
    210  and each latitudes should be the same for all longitudes). 
     209 grid must be regular (each longitude must be the same for all latitudes 
     210 and each latitude should be the same for all longitudes). 
    211211</div> 
    212212             
    … …  
    290290 IDL> get_gridparams, lon, lat, jpi, jpj, n_dimensions 
    291291 
    292  1) 
    293292 
    294293 
    … …  
    301300           
    302301          <h4>Version</h4><div class="preformat"> 
    303  $Id: get_gridparams.pro 231 2007-03-19 17:15:51Z pinsard $ 
     302 $Id: get_gridparams.pro 238 2007-03-27 13:43:18Z pinsard $ 
    304303</div> 
    305304          <h4>History</h4><div class="preformat"> 

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

    r234 r242  
    108108         
    109109          <div class="comments"> 
    110  
    111110</div> 
    112111 

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

    r234 r242  
    115115 
    116116          <h3>Return value</h3><div class="preformat"> 
    117  a n element vector. Where n is the number of elements of 
     117 a n elements vector where n is the number of elements of 
    118118 x. res[i]=j means that the point number i is located in the 
    119119 quadrilateral number j with (0 <= j <= n_elements(x0)-1) 
    … …  
    314314            <div class="comments"> 
    315315 the zoom (circle centered on the (x,y) with a radius of 
    316  zoomradius degree where we look for the the quadrilateral which 
     316 zoomradius degree where we look for the quadrilateral which 
    317317 contains the (x,y) point) used for the satellite projection 
    318318 when /ONSPHERE is activated. 
    … …  
    375375           
    376376          <h4>Version</h4><div class="preformat"> 
    377  $Id: inquad.pro 232 2007-03-20 16:59:36Z pinsard $ 
     377 $Id: inquad.pro 240 2007-03-28 12:17:24Z pinsard $ 
    378378</div> 
    379379          <h4>History</h4><div class="preformat"> 

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

    r234 r242  
    106106        <div class="routine_details" id="_inrecgrid"> 
    107107 
    108           <h2><a class="top" href="#container">top</a>inrecgrid <span class="categories">  
     108          <h2><a class="top" href="#container">top</a>inrecgrid <span class="categories"> 
    109109 Without loop 
    110110</span></h2> 
    … …  
    242242           
    243243          <h4>Version</h4><div class="preformat"> 
    244  $Id: inrecgrid.pro 231 2007-03-19 17:15:51Z pinsard $ 
     244 $Id: inrecgrid.pro 238 2007-03-27 13:43:18Z pinsard $ 
    245245</div> 
    246246          <h4>History</h4><div class="preformat"> 

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

    r234 r242  
    9090 This function returns the longitude and latitude [lon, lat] of 
    9191 a point a given arc distance (-pi <= Arc_Dist <= pi), and azimuth (Az), 
    92  from a specified location Lon0, lat0. 
    93  Same as LL_ARC_DISTANCE but for n points without do loop. 
     92 from a specified location Lon0, Lat0. 
     93 Same as <proidl>LL_ARC_DISTANCE</proidl> but for n points without do loop. 
    9494 
    9595 Formula from Map Projections - a working manual.  USGS paper 
    … …  
    110110        <div class="routine_details" id="_ll_narcs_distances"> 
    111111 
    112           <h2><a class="top" href="#container">top</a>ll_narcs_distances <span class="categories">  
     112          <h2><a class="top" href="#container">top</a>ll_narcs_distances <span class="categories"> 
    113113 Mapping, geography 
    114114</span></h2> 
    … …  
    121121 
    122122          <h3>Return value</h3><div class="preformat"> 
    123  a (2, n) array containing the longitude/latitude of the resulting points. 
     123 a (2,n) array containing the longitude/latitude of the resulting points. 
    124124 Values are in radians unless the keyword DEGREES is set. 
    125125</div> 
    … …  
    243243           
    244244          <h4>Version</h4><div class="preformat"> 
    245  $Id: ll_narcs_distances.pro 231 2007-03-19 17:15:51Z pinsard $ 
     245 $Id: ll_narcs_distances.pro 238 2007-03-27 13:43:18Z pinsard $ 
    246246</div> 
    247247          <h4>History</h4><div class="preformat"> 

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

    r234 r242  
    9292 returns the distances between number n of P0 points and number 
    9393 n of P1 points (in that case, np0 and np1 must be equal). 
    94  Same as map_2points with the meter parameter but for n points 
    95  without do loop. 
     94 Same as <proidl>map_2points</proidl> with the meter parameter but for n 
     95 points without do loop. 
    9696</div> 
    9797 
    … …  
    123123 points P0 and np1 points P1. Element (i,j) of the output is the 
    124124 distance between element P0[i] and P1[j]. 
    125  If keyword /TWO_BY_TWO is given then Map_nPoints returns 
    126  an np-element vector giving the distance in meter between P0[i] 
     125 If keyword /TWO_BY_TWO is given then <a href=".//map_npoints.html">map_npoints</a> returns 
     126 an np-elements vector giving the distance in meter between P0[i] 
    127127 and P1[i] (in that case, we have np0 = np1 = np) ; if /MIDDLE see this keyword.</div> 
    128128 
    … …  
    269269         
    270270            <div class="comments"> 
    271  If given,then Map_nPoints returns the distances between number n of 
    272  P0 points and number n of P1 points 
     271 If given, then <a href=".//map_npoints.html">map_npoints</a> returns the distances between  
     272 number n of P0 points and number n of P1 pointsi. 
    273273 In that case, np0 and np1 must be equal. 
    274274</div> 
    … …  
    325325           
    326326          <h4>Version</h4><div class="preformat"> 
    327  $Id: map_npoints.pro 231 2007-03-19 17:15:51Z pinsard $ 
     327 $Id: map_npoints.pro 238 2007-03-27 13:43:18Z pinsard $ 
    328328</div> 
    329329          <h4>History</h4><div class="preformat"> 

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

    r234 r242  
    8888 
    8989      <div id="file_comments"> 
    90  find the closetest point of (P0) within a list of np1 points 
    91  P1 Which can be on a sphere 
     90 find the closest point of (P0) within a list of np1 points 
     91 P1 which can be on a sphere 
    9292</div> 
    9393 
    … …  
    110110         
    111111          <p class="header"> 
    112             <span class="result">result = </span>neighbor(<span class="result"><a href="#_neighbor_param_p0lon">p0lon</a>, <a href="#_neighbor_param_p0lat">p0lat</a>[, <a href="#_neighbor_param_neighlon">neighlon</a>][, <a href="#_neighbor_param_neighlat">neighlat</a>]</span>, <a href="#_neighbor_keyword_sphere">sphere</a>=<span class="result">sphere</span>, <a href="#_neighbor_keyword_distance">distance</a>=<span class="result">distance</span>, <a href="#_neighbor_keyword_radians">radians</a>=<span class="result">radians</span>)</p> 
     112            <span class="result">result = </span>neighbor(<span class="result"><a href="#_neighbor_param_p0lon">p0lon</a>, <a href="#_neighbor_param_p0lat">p0lat</a>[, <a href="#_neighbor_param_neighlon">neighlon</a>][, <a href="#_neighbor_param_neighlat">neighlat</a>]</span>, <a href="#_neighbor_keyword_SPHERE">SPHERE</a>=<span class="result">SPHERE</span>, <a href="#_neighbor_keyword_DISTANCE">DISTANCE</a>=<span class="result">DISTANCE</span>, <a href="#_neighbor_keyword_RADIANS">RADIANS</a>=<span class="result">RADIANS</span>)</p> 
    113113         
    114114          <div class="comments"> 
    … …  
    129129              <span class="attr">required</span> 
    130130               
    131                
    132                
    133                
    134             </h4> 
    135          
    136           <div class="comments"> 
    137  scalar. longitudes of point P0. 
     131              <span class="attr">type:</span> <span class="value">scalar</span> 
     132               
     133               
     134            </h4> 
     135         
     136          <div class="comments"> 
     137 longitudes of point P0. 
    138138</div> 
    139139             
    … …  
    144144              <span class="attr">required</span> 
    145145               
    146                
    147                
    148                
    149             </h4> 
    150          
    151           <div class="comments"> 
    152  scalar. latitudes of point P0. 
     146              <span class="attr">type:</span> <span class="value">scalar</span> 
     147               
     148               
     149            </h4> 
     150         
     151          <div class="comments"> 
     152 latitudes of point P0. 
    153153</div> 
    154154             
    … …  
    188188            <h3>Keywords</h3> 
    189189             
    190             <h4 id="_neighbor_keyword_sphere">sphere&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     190            <h4 id="_neighbor_keyword_SPHERE">SPHERE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    191191               
    192192               
    … …  
    199199            </h4> 
    200200         
    201             <div class="comments"> to activate if points are located on a sphere. 
    202 </div> 
    203              
    204             <h4 id="_neighbor_keyword_distance">distance&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     201            <div class="comments"> 
     202 to activate if points are located on a sphere. 
     203</div> 
     204             
     205            <h4 id="_neighbor_keyword_DISTANCE">DISTANCE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    205206               
    206207               
    … …  
    218219</div> 
    219220             
    220             <h4 id="_neighbor_keyword_radians">radians&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     221            <h4 id="_neighbor_keyword_RADIANS">RADIANS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    221222               
    222223               
    … …  
    245246           
    246247          <h4>Version</h4><div class="preformat"> 
    247  $Id: neighbor.pro 231 2007-03-19 17:15:51Z pinsard $ 
     248 $Id: neighbor.pro 238 2007-03-27 13:43:18Z pinsard $ 
    248249</div> 
    249250          <h4>History</h4><div class="preformat"> 

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

    r234 r242  
    125125 
    126126          <h3>Return value</h3><div class="preformat"> 
    127  
    128  (2,n) array: the new coordinates (xout, yout) of the (xin,yin) point(s) after 
     127 (2,n) array: the new coordinates (xout,yout) of the (xin,yin) point(s) after 
    129128 mapping. 
    130129 If xin is a scalar, then n is equal to the number of elements of x0. 
    131  If xin is an array , then n is equal to the number of elements of xin. 
     130 If xin is an array, then n is equal to the number of elements of xin. 
    132131</div> 
    133132 
    … …  
    315314           
    316315          <h4>Version</h4><div class="preformat"> 
    317  $Id: quadrilateral2square.pro 231 2007-03-19 17:15:51Z pinsard $ 
     316 $Id: quadrilateral2square.pro 238 2007-03-27 13:43:18Z pinsard $ 
    318317</div> 
    319318          <h4>History</h4><div class="preformat"> 

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

    r234 r242  
    8888 
    8989      <div id="file_comments"> 
    90  SPL_FSTDRV returns the values of the first derivative of 
     90 returns the values of the first derivative of 
    9191 the interpolating function at the points X2i. It is a double 
    9292 precision array. 
    9393 
    9494 Given the arrays X and Y, which tabulate a function (with the X[i] 
    95  AND Y[i] in ascending order), and given an input value X2, the 
    96  SPL_INCR function returns an interpolated value for the given values 
    97  of X2. The interpolation method is based on cubic spline, corrected 
    98  in a way that interpolated value are also in ascending order 
     95 and Y[i] in ascending order), and given an input value X2, the 
     96 <a href=".//spl_incr.html">spl_incr</a> function returns an interpolated value for the given 
     97 values of X2. The interpolation method is based on cubic spline, corrected 
     98 in a way that interpolated value are also in ascending order. 
    9999</div> 
    100100 
    … …  
    140140         
    141141          <div class="comments"> 
    142  An n-element (at least 2) input vector that specifies the 
     142 An n-elements (at least 2) input vector that specifies the 
    143143 tabulate points in ascending order. 
    144144</div> 
    … …  
    156156         
    157157          <div class="comments"> 
    158  f(x) = y. An n-element input vector that specifies the values 
     158 f(x) = y. An n-elements input vector that specifies the values 
    159159 of the tabulated function F(Xi) corresponding to Xi. 
    160160</div> 
    … …  
    172172         
    173173          <div class="comments"> 
    174  The output from SPL_INIT for the specified X and Y. 
     174 The output from <proidl>SPL_INIT</pro> for the specified X and Y. 
    175175</div> 
    176176             
    … …  
    181181              <span class="attr">required</span> 
    182182               
    183                
     183              <span class="attr">type:</span> <span class="value"> scalar or array</span> 
    184184               
    185185               
    … …  
    188188          <div class="comments"> 
    189189 The input values for which the first derivative values are desired. 
    190  X can be scalar or an array of values. 
    191190</div> 
    192191             
    … …  
    202201           
    203202          <h4>Version</h4><div class="preformat"> 
    204  $Id: spl_fstdrv.pro 231 2007-03-19 17:15:51Z pinsard $ 
     203 $Id: spl_fstdrv.pro 238 2007-03-27 13:43:18Z pinsard $ 
    205204</div> 
    206205          <h4>History</h4><div class="preformat"> 

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

    r234 r242  
    8888 
    8989      <div id="file_comments"> 
    90  
    9190 Given the arrays X and Y, which tabulate a function (with the X[i] 
    9291 AND Y[i] in ascending order), and given an input value X2, the 
    93  SPL_INCR function returns an interpolated value for the given values 
     92 spl_incr function returns an interpolated value for the given values 
    9493 of X2. The interpolation method is based on cubic spline, corrected 
    9594 in a way that interpolated values are also monotonically increasing. 
    … …  
    112111           
    113112          <dt><p><a href="#_pure_convex"><span class="result">result = </span>pure_convex(<span class="result">x1, x2, y1, y2, der2, x</span>)</a></p><dt> 
    114           <dd></dd>      
     113          <dd> </dd>     
    115114           
    116115          <dt><p><a href="#_spl_incr"><span class="result">result = </span>spl_incr(<span class="result">x, y, x2</span>, YP0=<span class="result">YP0</span>, YPN_1=<span class="result">YPN_1</span>)</a></p><dt> 
    117           <dd></dd>      
     116          <dd> </dd>     
    118117                 
    119118        </dl> 
    … …  
    135134 
    136135          <h3>Return value</h3><div class="preformat"> 
    137  
    138     y2: f(x2) = y2. Double precision array 
     136 y2: f(x2) = y2. Double precision array 
    139137</div> 
    140138 
    … …  
    155153         
    156154          <div class="comments"> 
    157  An n-element (at least 2) input vector that specifies the tabulate points in 
     155 An n-elements (at least 2) input vector that specifies the tabulate points in 
    158156 a strict ascending order. 
    159157</div> 
    … …  
    187185         
    188186          <div class="comments"> 
    189  f(x) = y. An n-element input vector that specifies the values 
     187 f(x) = y. An n-elements input vector that specifies the values 
    190188 of the tabulated function F(Xi) corresponding to Xi. As f is 
    191189 supposed to be monotonically increasing, y values must be 
    … …  
    240238 
    241239          <h3>Examples</h3><div class="preformat"> 
    242  
    243240 IDL> n = 100L 
    244241 IDL> x = (dindgen(n))^2 
    … …  
    263260           
    264261          <h4>Version</h4><div class="preformat"> 
    265  $Id: spl_incr.pro 231 2007-03-19 17:15:51Z pinsard $ 
     262 $Id: spl_incr.pro 238 2007-03-27 13:43:18Z pinsard $ 
    266263</div> 
    267264          <h4>History</h4><div class="preformat"> 
    … …  
    305302            <span class="result">result = </span>pure_convex(<span class="result"><a href="#_pure_convex_param_x1">x1</a>, <a href="#_pure_convex_param_x2">x2</a>, <a href="#_pure_convex_param_y1">y1</a>, <a href="#_pure_convex_param_y2">y2</a>, <a href="#_pure_convex_param_der2">der2</a>, <a href="#_pure_convex_param_x">x</a></span>)</p> 
    306303         
    307           <div class="comments"></div> 
     304          <div class="comments"> 
     305</div> 
    308306 
    309307           
    … …  
    325323         
    326324          <div class="comments"> 
    327  An n-element (at least 2) input vector that specifies the tabulate points in 
     325 An n-elements (at least 2) input vector that specifies the tabulate points in 
    328326 a strict ascending order. 
    329327</div> 
    … …  
    357355         
    358356          <div class="comments"> 
    359  f(x) = y. An n-element input vector that specifies the values 
     357 f(x) = y. An n-elements input vector that specifies the values 
    360358    of the tabulated function F(Xi) corresponding to Xi. As f is 
    361359    supposed to be monotonically increasing, y values must be 
    … …  
    387385            </h4> 
    388386         
    389           <div class="comments"></div> 
     387          <div class="comments"> 
     388</div> 
    390389             
    391390            <h4 id="_pure_convex_param_x">x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    447446            <span class="result">result = </span>spl_incr(<span class="result"><a href="#_spl_incr_param_x">x</a>, <a href="#_spl_incr_param_y">y</a>, <a href="#_spl_incr_param_x2">x2</a></span>, <a href="#_spl_incr_keyword_YP0">YP0</a>=<span class="result">YP0</span>, <a href="#_spl_incr_keyword_YPN_1">YPN_1</a>=<span class="result">YPN_1</span>)</p> 
    448447         
     448          <div class="comments"> 
     449</div> 
     450 
     451           
     452 
     453           
     454            <h3>Parameters</h3> 
     455         
     456             
     457            <h4 id="_spl_incr_param_x">x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     458               
     459               
     460               
     461               
     462               
     463               
     464               
     465               
     466            </h4> 
     467         
    449468          <div class="comments"></div> 
    450  
    451            
    452  
    453            
    454             <h3>Parameters</h3> 
    455          
    456              
    457             <h4 id="_spl_incr_param_x">x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     469             
     470            <h4 id="_spl_incr_param_y">y&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    458471               
    459472               
    … …  
    468481          <div class="comments"></div> 
    469482             
    470             <h4 id="_spl_incr_param_y">y&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     483            <h4 id="_spl_incr_param_x2">x2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    471484               
    472485               
    … …  
    481494          <div class="comments"></div> 
    482495             
    483             <h4 id="_spl_incr_param_x2">x2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    484                
    485                
    486                
    487                
    488                
    489                
    490                
    491                
    492             </h4> 
    493          
    494           <div class="comments"></div> 
    495              
    496496 
    497497           
    … …  
    512512            </h4> 
    513513         
    514             <div class="comments"> The first derivative of the interpolating function at the 
     514            <div class="comments"> 
     515 The first derivative of the interpolating function at the 
    515516    point X0. If YP0 is omitted, the second derivative at the 
    516     boundary is set to zero, resulting in a "natural spline."</div> 
     517    boundary is set to zero, resulting in a "natural spline." 
     518</div> 
    517519             
    518520            <h4 id="_spl_incr_keyword_YPN_1">YPN_1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    527529            </h4> 
    528530         
    529             <div class="comments"> The first derivative of the interpolating function at the 
     531            <div class="comments"> 
     532 The first derivative of the interpolating function at the 
    530533    point Xn-1. If YPN_1 is omitted, the second derivative at the 
    531534    boundary is set to zero, resulting in a "natural spline."</div> 

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

    r234 r242  
    8888 
    8989      <div id="file_comments"> 
    90  
    9190 Given the arrays X and Y, which tabulate a function (with the X[i] 
    9291 AND Y[i] in ascending order), and given an input value X2, the 
    93  SPL_INCR function returns an interpolated value for the given values 
     92 <a href=".//spl_incr.html">spl_incr</a> function returns an interpolated value for the given values 
    9493 of X2. The interpolation method is based on cubic spline, corrected 
    9594 in a way that integral of the interpolated values is the same as the 
    … …  
    141140         
    142141          <div class="comments"> 
    143  An n-element (at least 2) input vector that specifies the tabulate points in 
     142 An n-elements (at least 2) input vector that specifies the tabulate points in 
    144143 a strict ascending order. 
    145144</div> 
    … …  
    261260           
    262261          <h4>Version</h4><div class="preformat"> 
    263  $Id: spl_keep_mean.pro 232 2007-03-20 16:59:36Z pinsard $ 
     262 $Id: spl_keep_mean.pro 238 2007-03-27 13:43:18Z pinsard $ 
    264263</div> 
    265264          <h4>History</h4><div class="preformat"> 

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

    r234 r242  
    123123 
    124124          <h3>Return value</h3><div class="preformat"> 
    125  (2,n) array: the new coordinates (xout, yout) of the (xin,yin) 
     125 (2,n) array: the new coordinates (xout,yout) of the (xin,yin) 
    126126 point(s) after mapping. 
    127127 If xin is a scalar, then n is equal to the number of elements of 
    128128 x0. If xin is an array , then n is equal to the number of 
    129129 elements of xin. 
    130  If xin and yin are omited, square2quadrilateral returns the 
     130 If xin and yin are omited, <a href=".//square2quadrilateral.html">square2quadrilateral</a> returns the 
    131131 matrix A which is used for the inverse transformation. 
    132132</div> 
    … …  
    243243 Can be scalar or array. 
    244244 (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are given in the anticlockwise order. 
    245  
    246245</div> 
    247246             
    … …  
    291290           
    292291          <h4>Version</h4><div class="preformat"> 
    293  $Id: square2quadrilateral.pro 231 2007-03-19 17:15:51Z pinsard $ 
     292 $Id: square2quadrilateral.pro 238 2007-03-27 13:43:18Z pinsard $ 
    294293</div> 
    295294          <h4>History</h4><div class="preformat"> 
Note: See TracChangeset for help on using the changeset viewer.