Ignore:
Timestamp:
09/21/07 10:14:31 (17 years ago)
Author:
smasson
Message:

update documentation

Location:
trunk/SRC/Documentation/idldoc_assistant_output/Interpolation
Files:
1 added
20 edited

Legend:

Unmodified
Added
Removed

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

    r249 r290  
    289289     
    290290    <h4>Version</h4> 
    291  $Id: angle.pro 247 2007-05-29 08:58:52Z smasson $ 
     291 $Id: angle.pro 262 2007-08-21 14:19:32Z pinsard $ 
    292292 
    293293    <h4>History</h4> 
    … …  
    295295                   98-06 (G. Madec) 
    296296       Feb 2005: IDL adaptation S. Masson 
    297        May 2007: F points + call to <pro>lbcorca.pro</pro> 
     297       May 2007: F points + call to <a href="..//Interpolation/lbcorca.html">lbcorca</a> 
    298298 
    299299     
    … …  
    308308       =>    gcosu[*, 0] = gcosu[*, 1] 
    309309       =>    gsinu[*, 0] = gsinu[*, 1] 
    310      (2) the grid follows OPA x and north pole periodicity rule (see <pro>lbcorca.pro</pro>) 
     310     (2) the grid follows OPA x and north pole periodicity rule (see <a href="..//Interpolation/lbcorca.html">lbcorca</a>) 
    311311 
    312312 

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

    r249 r290  
    191191 
    192192     
    193  Used to pass extra keywords to <a href=".//inquad.html">inquad</a> and 
    194  <proidl>plot</proidl> 
     193 Used to pass extra keywords to <a href="..//Interpolation/inquad.html">inquad</a> and 
     194 <a href="/Applications/rsi/idl_6.3/help/online_help/PLOT.html">PLOT</a> 
    195195 (when /drawcell) 
    196196 
    … …  
    210210     
    211211    <h4>Version</h4> 
    212  $Id: clickincell.pro 242 2007-04-06 08:35:17Z pinsard $ 
     212 $Id: clickincell.pro 260 2007-08-20 15:24:57Z pinsard $ 
    213213 
    214214    <h4>History</h4> 

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

    r249 r290  
    235235     
    236236    <h4>Version</h4> 
    237  $Id: compute_fromirr_bilinear_weigaddr.pro 238 2007-03-27 13:43:18Z pinsard $ 
     237 $Id: compute_fromirr_bilinear_weigaddr.pro 282 2007-09-12 15:43:11Z smasson $ 
    238238 
    239239    <h4>History</h4> 
    … …  
    248248    <h4>Restrictions</h4> 
    249249  -  the input grid must be an "irregular 2D grid", defined as a grid made 
    250   of quadrilateral cells which corners positions are defined with olonin and olat 
     250  of quadrilateral cells 
    251251  -  We supposed the data are located on a sphere, with a periodicity along 
    252252  the longitude 

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

    r249 r290  
    236236     
    237237    <h4>Version</h4> 
    238  $Id: compute_fromreg_bilinear_weigaddr.pro 238 2007-03-27 13:43:18Z pinsard $ 
     238 $Id: compute_fromreg_bilinear_weigaddr.pro 282 2007-09-12 15:43:11Z smasson $ 
    239239 
    240240    <h4>History</h4> 

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

    r249 r290  
    236236     
    237237    <h4>Version</h4> 
    238  $Id: compute_fromreg_imoms3_weigaddr.pro 238 2007-03-27 13:43:18Z pinsard $ 
     238 $Id: compute_fromreg_imoms3_weigaddr.pro 282 2007-09-12 15:43:11Z smasson $ 
    239239 
    240240    <h4>History</h4> 

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

    r249 r290  
    209209     
    210210 1d arrays of p elements, giving the edge positions. 
    211  The edges must be given as in <proidl>plot</proidl> to draw the  
     211 The edges must be given as in <a href="/Applications/rsi/idl_6.3/help/online_help/PLOT.html">PLOT</a> to draw the  
    212212 parallelogram. (see example). 
    213213 
    … …  
    291291     
    292292    <h4>Version</h4> 
    293  $Id: cutpar.pro 242 2007-04-06 08:35:17Z pinsard $ 
     293 $Id: cutpar.pro 260 2007-08-20 15:24:57Z pinsard $ 
    294294 
    295295    <h4>History</h4> 
    … …  
    309309     
    310310    <h4>Uses routines</h4> 
    311  <a href=".//cutsegment.html">cutsegment</a> 
     311 <a href="..//Interpolation/cutsegment.html">cutsegment</a> 
    312312 
    313313     

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

    r249 r290  
    3030        <li><a href="extrapolate.html" target="file_frame">extrapolate.pro</a></li> 
    3131        <li><a href="extrapsmooth.html" target="file_frame">extrapsmooth.pro</a></li> 
     32        <li><a href="file_interp.html" target="file_frame">file_interp.pro</a></li> 
    3233        <li><a href="fromirr.html" target="file_frame">fromirr.pro</a></li> 
    3334        <li><a href="fromreg.html" target="file_frame">fromreg.pro</a></li> 
    … …  
    4748      </ul> 
    4849 
    49       <div id="tagline">24 files</div> 
     50      <div id="tagline">25 files</div> 
    5051       
    5152 

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

    r249 r290  
    7676</font></h2> 
    7777 
    78       <p><font face="Courier"><i>result = </i>extrapolate(<i><a href="#_extrapolate_keyword_zinput">zinput</a>, <a href="#_extrapolate_keyword_maskinput">maskinput</a>[, <a href="#_extrapolate_keyword_nb_iteration">nb_iteration</a>]</i>, <a href="#_extrapolate_keyword_x_periodic">x_periodic</a>=<i>scalar, 0 or 1</i>, <a href="#_extrapolate_keyword_MINVAL">MINVAL</a>=<i>scalar</i>, <a href="#_extrapolate_keyword_MAXVAL">MAXVAL</a>=<i>scalar</i>, <a href="#_extrapolate_keyword_GE0">GE0</a>=<i>scalar 0 or 1</i>)</font></p> 
     78      <p><font face="Courier"><i>result = </i>extrapolate(<i><a href="#_extrapolate_keyword_zinput">zinput</a>, <a href="#_extrapolate_keyword_maskinput">maskinput</a>[, <a href="#_extrapolate_keyword_nb_iteration">nb_iteration</a>]</i>, <a href="#_extrapolate_keyword_X_PERIODIC">X_PERIODIC</a>=<i>scalar, 0 or 1</i>, <a href="#_extrapolate_keyword_MINVAL">MINVAL</a>=<i>scalar</i>, <a href="#_extrapolate_keyword_MAXVAL">MAXVAL</a>=<i>scalar</i>, <a href="#_extrapolate_keyword_GE0">GE0</a>=<i>scalar 0 or 1</i>, <a href="#_extrapolate_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p> 
    7979 
    8080     
    … …  
    131131       
    132132       
    133       <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer scalar</i></font> 
    134       <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>10.E20</i></font> 
     133      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer</i></font> 
     134      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>large enough to fill everything</i></font> 
    135135       
    136136    </h4> 
    … …  
    139139 Maximum number of iterations done in the extrapolation process. If there 
    140140 is no more masked values we exit extrapolate before reaching nb_iteration 
    141  (to be sure to fill everything, you can use a very large value) 
    142141 
    143142     
    … …  
    148147 
    149148     
    150     <a name="#_extrapolate_keyword_x_periodic"></a> 
    151     <h4>x_periodic&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     149    <a name="#_extrapolate_keyword_X_PERIODIC"></a> 
     150    <h4>X_PERIODIC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    152151       
    153152       
    … …  
    210209     
    211210 put 1 to force the extrapolated values to be larger than 0, same as using minval=0. 
     211 
     212     
     213    <a name="#_extrapolate_keyword__EXTRA"></a> 
     214    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     215       
     216       
     217       
     218       
     219       
     220       
     221       
     222       
     223    </h4> 
     224 
     225     to be able to call extrapolate with _extra keyword 
    212226 
    213227     
    … …  
    225239     
    226240    <h4>Version</h4> 
    227  $Id: extrapolate.pro 242 2007-04-06 08:35:17Z pinsard $ 
     241 $Id: extrapolate.pro 271 2007-08-30 12:44:23Z smasson $ 
    228242 
    229243    <h4>History</h4> 

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

    r249 r290  
    5050<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td> 
    5151    <td width="10%" align="right"> 
    52 <a href="fromirr.html"><img src="./../next.gif" border="0" alt="Next"></a></td> 
     52<a href="file_interp.html"><img src="./../next.gif" border="0" alt="Next"></a></td> 
    5353  </tr> 
    5454</table> 
    … …  
    6262 
    6363     
    64  similar to <a href=".//extrapolate.html">extrapolate</a> but could to the job in a better way 
     64 similar to <a href="..//Interpolation/extrapolate.html">extrapolate</a> but could to the job in a better way 
    6565 because the extrapolated values are smoothed... 
    66  takes more time than <a href=".//extrapolate.html">extrapolate</a>. 
     66 takes more time than <a href="..//Interpolation/extrapolate.html">extrapolate</a>. 
    6767 extrapolate data where mskin is equal 0 by filling 
    6868 step by step the coastline points with the mean value of the 8 neighbourgs. 
    … …  
    7878</font></h2> 
    7979 
    80       <p><font face="Courier"><i>result = </i>extrapsmooth(<i><a href="#_extrapsmooth_keyword_in">in</a>, <a href="#_extrapsmooth_keyword_mskin">mskin</a></i>, <a href="#_extrapsmooth_keyword_x_periodic">x_periodic</a>=<i>x_periodic</i>, <a href="#_extrapsmooth_keyword_MINVAL">MINVAL</a>=<i>scalar</i>, <a href="#_extrapsmooth_keyword_MAXVAL">MAXVAL</a>=<i>scalar</i>, <a href="#_extrapsmooth_keyword_GE0">GE0</a>=<i>scalar 0 or 1</i>)</font></p> 
     80      <p><font face="Courier"><i>result = </i>extrapsmooth(<i><a href="#_extrapsmooth_keyword_in">in</a>, <a href="#_extrapsmooth_keyword_mskin">mskin</a></i>, <a href="#_extrapsmooth_keyword_X_PERIODIC">X_PERIODIC</a>=<i>X_PERIODIC</i>, <a href="#_extrapsmooth_keyword_MINVAL">MINVAL</a>=<i>scalar</i>, <a href="#_extrapsmooth_keyword_MAXVAL">MAXVAL</a>=<i>scalar</i>, <a href="#_extrapsmooth_keyword_GE0">GE0</a>=<i>scalar 0 or 1</i>, <a href="#_extrapsmooth_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p> 
    8181 
    8282     
    … …  
    131131 
    132132     
    133     <a name="#_extrapsmooth_keyword_x_periodic"></a> 
    134     <h4>x_periodic&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     133    <a name="#_extrapsmooth_keyword_X_PERIODIC"></a> 
     134    <h4>X_PERIODIC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    135135       
    136136       
    … …  
    191191     
    192192 put 1 to force the extrapolated values to be larger than 0, same as using minval=0. 
     193 
     194     
     195    <a name="#_extrapsmooth_keyword__EXTRA"></a> 
     196    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     197       
     198       
     199       
     200       
     201       
     202       
     203       
     204       
     205    </h4> 
     206 
     207     to be able to call extrapsmooth with _extra keyword 
    193208 
    194209     
    … …  
    205220     
    206221    <h4>Version</h4> 
    207  $Id: extrapsmooth.pro 242 2007-04-06 08:35:17Z pinsard $ 
     222 $Id: extrapsmooth.pro 271 2007-08-30 12:44:23Z smasson $ 
    208223    <h4>History</h4> 
    209224  January 2007: Sebastien Masson (smasson@lodyc.jussieu.fr) 

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

    r249 r290  
    4646  <tr> 
    4747    <td width="10%"> 
    48 <a href="extrapsmooth.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td> 
     48<a href="file_interp.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td> 
    4949    <td width="80%" align="center" valign="center"> 
    5050<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td> 
    … …  
    7575</font></h2> 
    7676 
    77       <p><font face="Courier"><i>result = </i>fromirr(<i><a href="#_fromirr_keyword_method">method</a>, <a href="#_fromirr_keyword_datain">datain</a>, <a href="#_fromirr_keyword_lonin">lonin</a>, <a href="#_fromirr_keyword_latin">latin</a>, <a href="#_fromirr_keyword_mskin">mskin</a>, <a href="#_fromirr_keyword_lonout">lonout</a>, <a href="#_fromirr_keyword_latout">latout</a>, <a href="#_fromirr_keyword_mskout">mskout</a></i>, <a href="#_fromirr_keyword_WEIG">WEIG</a>=<i>2d array</i>, <a href="#_fromirr_keyword_ADDR">ADDR</a>=<i>2d array</i>)</font></p> 
     77      <p><font face="Courier"><i>result = </i>fromirr(<i><a href="#_fromirr_keyword_method">method</a>, <a href="#_fromirr_keyword_datain">datain</a>, <a href="#_fromirr_keyword_lonin">lonin</a>, <a href="#_fromirr_keyword_latin">latin</a>, <a href="#_fromirr_keyword_mskin">mskin</a>, <a href="#_fromirr_keyword_lonout">lonout</a>, <a href="#_fromirr_keyword_latout">latout</a>, <a href="#_fromirr_keyword_mskout">mskout</a></i>, <a href="#_fromirr_keyword_WEIG">WEIG</a>=<i>2d array</i>, <a href="#_fromirr_keyword_ADDR">ADDR</a>=<i>2d array</i>, <a href="#_fromirr_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p> 
    7878 
    7979     
    … …  
    272272 
    273273     
     274    <a name="#_fromirr_keyword__EXTRA"></a> 
     275    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     276       
     277       
     278       
     279       
     280       
     281       
     282       
     283       
     284    </h4> 
     285 
     286     to be able to call fromirr with _extra keyword 
     287 
     288     
    274289     
    275290 
    … …  
    297312     
    298313    <h4>Version</h4> 
    299  $Id: fromirr.pro 238 2007-03-27 13:43:18Z pinsard $ 
     314 $Id: fromirr.pro 271 2007-08-30 12:44:23Z smasson $ 
    300315 
    301316    <h4>History</h4> 

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

    r249 r290  
    7878</font></h2> 
    7979 
    80       <p><font face="Courier"><i>result = </i>fromreg(<i><a href="#_fromreg_keyword_method">method</a>, <a href="#_fromreg_keyword_datain">datain</a>, <a href="#_fromreg_keyword_lonin">lonin</a>, <a href="#_fromreg_keyword_latin">latin</a>, <a href="#_fromreg_keyword_lonout">lonout</a>, <a href="#_fromreg_keyword_latout">latout</a></i>, <a href="#_fromreg_keyword_WEIG">WEIG</a>=<i>2d array or variable name</i>, <a href="#_fromreg_keyword_ADDR">ADDR</a>=<i>2d array or variable name</i>, <a href="#_fromreg_keyword_NONORTHERNLINE">NONORTHERNLINE</a>=<i>NONORTHERNLINE</i>, <a href="#_fromreg_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<i>NOSOUTHERNLINE</i>)</font></p> 
     80      <p><font face="Courier"><i>result = </i>fromreg(<i><a href="#_fromreg_keyword_method">method</a>, <a href="#_fromreg_keyword_datain">datain</a>, <a href="#_fromreg_keyword_lonin">lonin</a>, <a href="#_fromreg_keyword_latin">latin</a>, <a href="#_fromreg_keyword_lonout">lonout</a>, <a href="#_fromreg_keyword_latout">latout</a></i>, <a href="#_fromreg_keyword_WEIG">WEIG</a>=<i>2d array or variable name</i>, <a href="#_fromreg_keyword_ADDR">ADDR</a>=<i>2d array or variable name</i>, <a href="#_fromreg_keyword_NONORTHERNLINE">NONORTHERNLINE</a>=<i>NONORTHERNLINE</i>, <a href="#_fromreg_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<i>NOSOUTHERNLINE</i>, <a href="#_fromreg_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p> 
    8181 
    8282     
    … …  
    274274 
    275275     
     276    <a name="#_fromreg_keyword__EXTRA"></a> 
     277    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     278       
     279       
     280       
     281       
     282       
     283       
     284       
     285       
     286    </h4> 
     287 
     288     to be able to call fromreg with _extra keyword 
     289 
     290     
    276291     
    277292 
    … …  
    298313     
    299314    <h4>Version</h4> 
    300  $Id: fromreg.pro 238 2007-03-27 13:43:18Z pinsard $ 
     315 $Id: fromreg.pro 271 2007-08-30 12:44:23Z smasson $ 
    301316 
    302317    <h4>History</h4> 

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

    r249 r290  
    6262 
    6363     
    64  1) extract from a NetCDF file the longitude, latitude, and their dimensions 
     64 Case 1: extract from a NetCDF file longitude and latitude arrays, their dimensions 
    6565 and make sure it is 1D or 2D arrays 
    6666 
    67  or 
    68  2) given longitude and latitude arrays, get their dimensions and make 
     67 Case 2: given longitude and latitude arrays, get their dimensions and make 
    6968 sure they are 1D or 2D arrays 
    7069 
    … …  
    7978</font></h2> 
    8079 
    81       <p><font face="Courier">get_gridparams<i>, <a href="#_get_gridparams_keyword_in1">in1</a>, <a href="#_get_gridparams_keyword_in2">in2</a>, <a href="#_get_gridparams_keyword_in3">in3</a>, <a href="#_get_gridparams_keyword_in4">in4</a>, <a href="#_get_gridparams_keyword_in5">in5</a>, <a href="#_get_gridparams_keyword_in6">in6</a>, <a href="#_get_gridparams_keyword_in7">in7</a>, <a href="#_get_gridparams_keyword_in8">in8</a></i>, <a href="#_get_gridparams_keyword_DOUBLE">DOUBLE</a>=<i>DOUBLE</i></font></p> 
     80      <p><font face="Courier">get_gridparams<i>, <a href="#_get_gridparams_keyword_in1">in1</a>, <a href="#_get_gridparams_keyword_in2">in2</a>, <a href="#_get_gridparams_keyword_in3">in3</a>, <a href="#_get_gridparams_keyword_in4">in4</a>, <a href="#_get_gridparams_keyword_in5">in5</a>, <a href="#_get_gridparams_keyword_in6">in6</a>, <a href="#_get_gridparams_keyword_in7">in7</a>, <a href="#_get_gridparams_keyword_in8">in8</a></i>, <a href="#_get_gridparams_keyword_DOUBLE">DOUBLE</a>=<i>scalar: 0 or 1</i></font></p> 
    8281 
    8382     
    … …  
    103102 
    104103     
    105  Case 1: the name of the netcdf file 
    106  Case 2: 1d or 2d arrays defining longitudes and latitudes. 
    107  Out: the variable that will contain the longitudes 
     104 Case 1: name or the id (returned by ncdf_open) of the netcdf file 
     105 Case 2: 1D or 2D arrays defining longitudes, will be forced to have 
     106         n_dimensions dimensions when returned 
    108107 
    109108     
    … …  
    122121 
    123122     
    124  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. 
    126          Note that these arrays are also outputs and can therefore be modified. 
    127  Out: the variable that will contain the latitudes 
     123 Case 1: name of the variable containing the longitude in the NetCDF file 
     124 Case 2: 1D or 2D arrays defining latitudes, will be forced to have 
     125         n_dimensions dimensions when returned 
    128126 
    129127     
    … …  
    131129    <a name="#_get_gridparams_keyword_in3"></a> 
    132130    <h4>in3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    133       <font size="-1" color="#006633">in</font> 
    134        
    135        
    136       <font size="-1" color="#006633">required</font> 
    137        
    138        
    139        
    140        
    141     </h4> 
    142  
    143      
    144  Case 1: the name of the variable that contains the latitude in the NetCDF file 
    145  Case 2: the number of points in the longitudinal direction. 
     131       
     132       
     133       
     134       
     135       
     136       
     137       
     138       
     139    </h4> 
     140 
     141      
     142 Case 1: name of the variable containing the latitude in the NetCDF file 
     143 Case 2: returned number of points in longitudinal direction. 
    146144 
    147145     
    … …  
    160158 
    161159     
    162  Case 1: the number of points in the longitudinal direction 
    163  Case 2: the number of points in the latitudinal direction 
     160 Case 1: returned longitudes array, with n_dimensions dimensions 
     161 Case 2: returned number of points in latitudinal direction 
    164162 
    165163     
    … …  
    168166    <h4>in5&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    169167       
    170       <font size="-1" color="#006633">out</font> 
    171        
    172        
    173        
    174        
    175        
    176        
    177     </h4> 
    178  
    179      
    180  Case 1: the number of points in the latitudinal direction 
    181  Case 2: 1 or 2 to specify if lon and lat should be 1D (jpi or jpj) 
    182  arrays or 2D arrays (jpi,jpj). Note that of  n_dimensions = 1, then the 
    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). 
     168       
     169       
     170       
     171       
     172       
     173       
     174       
     175    </h4> 
     176 
     177     
     178 Case 1: returned latitudes array, with n_dimensions dimensions  
     179 Case 2: input scalar (1 or 2) to specify if lon and lat should be returned  
     180         as 1D or 2D arrays. Note that if n_dimensions = 1, the grid must be 
     181         regular (longitude and latitudes can be described as 1D arrays). 
    185182 
    186183     
    … …  
    199196 
    200197     
    201  the variable that will contain the longitudes 
     198 Case 1: returned number of points in longitudinal direction. 
    202199 
    203200     
    … …  
    216213 
    217214     
    218  the variable that will contain the latitudes 
     215 Case 1: returned number of points in latitudinal direction 
    219216 
    220217     
    … …  
    222219    <a name="#_get_gridparams_keyword_in8"></a> 
    223220    <h4>in8&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    224        
    225       <font size="-1" color="#006633">out</font> 
    226        
    227        
    228        
    229        
    230        
    231        
    232     </h4> 
    233  
    234      
    235  1 or 2 to specify if lon and lat should be 1D (jpi or jpj) 
     221      <font size="-1" color="#006633">in</font> 
     222       
     223       
     224       
     225       
     226       
     227       
     228       
     229    </h4> 
     230 
     231     
     232 Case 1: input scalar (1 or 2) to specify if lon and lat should be returned  
     233         as 1D or 2D arrays. Note that if n_dimensions = 1, the grid must be 
     234         regular (longitude and latitudes can be described as 1D arrays). 
    236235 
    237236     
    … …  
    249248       
    250249       
    251        
    252        
    253        
    254     </h4> 
    255  
    256      
    257  use double precision to perform the computation 
     250      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font> 
     251      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> 
     252       
     253    </h4> 
     254 
     255     
     256 activate to force double precision for lon/lat arrays 
    258257 
    259258     
    … …  
    262261    <h3>Examples</h3><pre> 
    263262 
    264  1) 
    265  IDL> get_gridparams, file, lonname, latname, lon, lat, jpi, jpj, n_dimensions 
    266  
    267  or 
    268  
    269  2) 
     263 Case 1: 
     264 IDL> get_gridparams, file name/id, lonname, latname, lon, lat, jpi, jpj, n_dimensions 
     265 
     266 Case 2: 
    270267 IDL> get_gridparams, lon, lat, jpi, jpj, n_dimensions 
    271268 
    … …  
    280277     
    281278    <h4>Version</h4> 
    282  $Id: get_gridparams.pro 242 2007-04-06 08:35:17Z pinsard $ 
     279 $Id: get_gridparams.pro 271 2007-08-30 12:44:23Z smasson $ 
    283280 
    284281    <h4>History</h4> 

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

    r249 r290  
    358358 
    359359 On a sphere see 
    360  <a href=".//clickincell.html">clickincell</a> ... 
     360 <a href="..//Interpolation/clickincell.html">clickincell</a> ... 
    361361 
    362362    </pre><h3>Version history</h3> 

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

    r249 r290  
    7575</font></h2> 
    7676 
    77       <p><font face="Courier"><i>result = </i>lbcorca(<i><a href="#_lbcorca_keyword_arr">arr</a>, <a href="#_lbcorca_keyword_grid">grid</a>[, <a href="#_lbcorca_keyword_psign">psign</a>]</i>[, <a href="#_lbcorca_keyword_verbose">verbose</a>=<i>0 or 1</i>][, <a href="#_lbcorca_keyword_correction">correction</a>=<i>0 or 1</i>])</font></p> 
     77      <p><font face="Courier"><i>result = </i>lbcorca(<i><a href="#_lbcorca_keyword_arr">arr</a>, <a href="#_lbcorca_keyword_grid">grid</a>[, <a href="#_lbcorca_keyword_psign">psign</a>]</i>[, <a href="#_lbcorca_keyword_VERBOSE">VERBOSE</a>=<i>0 or 1</i>][, <a href="#_lbcorca_keyword_CORRECTION">CORRECTION</a>=<i>0 or 1</i>])</font></p> 
    7878 
    7979     
    … …  
    143143 
    144144     
    145     <a name="#_lbcorca_keyword_verbose"></a> 
    146     <h4>verbose&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     145    <a name="#_lbcorca_keyword_VERBOSE"></a> 
     146    <h4>VERBOSE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    147147       
    148148       
    … …  
    159159 
    160160     
    161     <a name="#_lbcorca_keyword_correction"></a> 
    162     <h4>correction&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     161    <a name="#_lbcorca_keyword_CORRECTION"></a> 
     162    <h4>CORRECTION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    163163       
    164164       
    … …  
    178178 
    179179    <h3>Examples</h3><pre> 
     180    IDL> @tst_initorca2 
     181    IDL> a = dist(jpiglo, jpjglo) 
     182    IDL> print, lbcorca(a, 'T') 
     183    IDL> dummy = lbcorca(a, 'T', /correction) 
     184    IDL> print, lbcorca(a, 'T') 
     185 
    180186    </pre><h3>Version history</h3> 
    181187     
    182188    <h4>Version</h4> 
    183  $Id: lbcorca.pro 247 2007-05-29 08:58:52Z smasson $ 
     189 $Id: lbcorca.pro 262 2007-08-21 14:19:32Z pinsard $ 
    184190 
    185191    <h4>History</h4> 
     192    Mai 2007: Creation, smasson@locean-ipsl.upmc.fr 
     193 
    186194     
    187195 

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

    r249 r290  
    6565 a point a given arc distance (-pi <= Arc_Dist <= pi), and azimuth (Az), 
    6666 from a specified location Lon0, Lat0. 
    67  Same as <proidl>LL_ARC_DISTANCE</proidl> but for n points without do loop. 
     67 Same as <a href="/Applications/rsi/idl_6.3/help/online_help/LL_ARC_DISTANCE.html">LL_ARC_DISTANCE</a> but for n points without do loop. 
    6868 
    6969 Formula from Map Projections - a working manual.  USGS paper 

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

    r249 r290  
    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 <proidl>map_2points</proidl> with the meter parameter but for n 
     68 Same as <a href="/Applications/rsi/idl_6.3/help/online_help/MAP_2POINTS.html">MAP_2POINTS</a> with the meter parameter but for n 
    6969 points without do loop. 
    7070 
    … …  
    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 <a href=".//map_npoints.html">map_npoints</a> returns 
     90 If keyword /TWO_BY_TWO is given then <a href="..//Interpolation/map_npoints.html">map_npoints</a> returns 
    9191 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. 
    … …  
    245245 
    246246     
    247  If given, then <a href=".//map_npoints.html">map_npoints</a> returns the distances between  
     247 If given, then <a href="..//Interpolation/map_npoints.html">map_npoints</a> returns the distances between  
    248248 number n of P0 points and number n of P1 pointsi. 
    249249 In that case, np0 and np1 must be equal. 
    … …  
    301301     
    302302    <h4>Version</h4> 
    303  $Id: map_npoints.pro 242 2007-04-06 08:35:17Z pinsard $ 
     303 $Id: map_npoints.pro 260 2007-08-20 15:24:57Z pinsard $ 
    304304 
    305305    <h4>History</h4> 

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

    r249 r290  
    6868       (x2,y2) -> (1,1) 
    6969       (x3,y3) -> (0,1) 
    70  This is the inverse function of <a href=".//square2quadrilateral.html">square2quadrilateral</a>. 
     70 This is the inverse function of <a href="..//Interpolation/square2quadrilateral.html">square2quadrilateral</a>. 
    7171 
    7272 The mapping is done using perspective transformation which preserve 
    … …  
    8484</font></h2> 
    8585 
    86       <p><font face="Courier"><i>result = </i>quadrilateral2square(<i><a href="#_quadrilateral2square_keyword_x0in">x0in</a>, <a href="#_quadrilateral2square_keyword_y0in">y0in</a>, <a href="#_quadrilateral2square_keyword_x1in">x1in</a>, <a href="#_quadrilateral2square_keyword_y1in">y1in</a>, <a href="#_quadrilateral2square_keyword_x2in">x2in</a>, <a href="#_quadrilateral2square_keyword_y2in">y2in</a>, <a href="#_quadrilateral2square_keyword_x3in">x3in</a>, <a href="#_quadrilateral2square_keyword_y3in">y3in</a>, <a href="#_quadrilateral2square_keyword_xxin">xxin</a>, <a href="#_quadrilateral2square_keyword_yyin">yyin</a></i>, <a href="#_quadrilateral2square_keyword_PERF">PERF</a>=<i>PERF</i>)</font></p> 
     86      <p><font face="Courier"><i>result = </i>quadrilateral2square(<i><a href="#_quadrilateral2square_keyword_x0in">x0in</a>, <a href="#_quadrilateral2square_keyword_y0in">y0in</a>, <a href="#_quadrilateral2square_keyword_x1in">x1in</a>, <a href="#_quadrilateral2square_keyword_y1in">y1in</a>, <a href="#_quadrilateral2square_keyword_x2in">x2in</a>, <a href="#_quadrilateral2square_keyword_y2in">y2in</a>, <a href="#_quadrilateral2square_keyword_x3in">x3in</a>, <a href="#_quadrilateral2square_keyword_y3in">y3in</a>, <a href="#_quadrilateral2square_keyword_xxin">xxin</a>, <a href="#_quadrilateral2square_keyword_yyin">yyin</a></i>, <a href="#_quadrilateral2square_keyword_PERF">PERF</a>=<i>salar 0 or 1</i>, <a href="#_quadrilateral2square_keyword_DOUBLE">DOUBLE</a>=<i>salar 0 or 1</i>)</font></p> 
    8787 
    8888     
    … …  
    273273       
    274274       
    275        
    276        
    277        
    278     </h4> 
    279  
    280      
     275      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>salar 0 or 1</i></font> 
     276      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> 
     277       
     278    </h4> 
     279 
     280     
     281 activate to print the elapsed time spent within quadrilateral2square 
     282 
     283     
     284    <a name="#_quadrilateral2square_keyword_DOUBLE"></a> 
     285    <h4>DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     286       
     287       
     288       
     289       
     290       
     291      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>salar 0 or 1</i></font> 
     292      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> 
     293       
     294    </h4> 
     295 
     296     
     297 activate to perform double precision computation 
    281298 
    282299     
    … …  
    298315     
    299316    <h4>Version</h4> 
    300  $Id: quadrilateral2square.pro 242 2007-04-06 08:35:17Z pinsard $ 
     317 $Id: quadrilateral2square.pro 282 2007-09-12 15:43:11Z smasson $ 
    301318 
    302319    <h4>History</h4> 

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

    r249 r290  
    6868 Given the arrays X and Y, which tabulate a function (with the X[i] 
    6969 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 
     70 <a href="..//Interpolation/spl_incr.html">spl_incr</a> function returns an interpolated value for the given 
    7171 values of X2. The interpolation method is based on cubic spline, corrected 
    7272 in a way that interpolated value are also in ascending order. 
    … …  
    142142 
    143143     
    144  The output from <proidl>SPL_INIT</pro> for the specified X and Y. 
     144 The output from <a href="/Applications/rsi/idl_6.3/help/online_help/SPL_INIT.html">SPL_INIT</a> for the specified X and Y. 
    145145 
    146146     
    … …  
    172172     
    173173    <h4>Version</h4> 
    174  $Id: spl_fstdrv.pro 242 2007-04-06 08:35:17Z pinsard $ 
     174 $Id: spl_fstdrv.pro 262 2007-08-21 14:19:32Z pinsard $ 
    175175 
    176176    <h4>History</h4> 

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

    r249 r290  
    6464 Given the arrays X and Y, which tabulate a function (with the X[i] 
    6565 AND Y[i] in ascending order), and given an input value X2, the 
    66  <a href=".//spl_incr.html">spl_incr</a> function returns an interpolated value for the given values 
     66 <a href="..//Interpolation/spl_incr.html">spl_incr</a> function returns an interpolated value for the given values 
    6767 of X2. The interpolation method is based on cubic spline, corrected 
    6868 in a way that integral of the interpolated values is the same as the 

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

    r249 r290  
    8282</font></h2> 
    8383 
    84       <p><font face="Courier"><i>result = </i>square2quadrilateral(<i><a href="#_square2quadrilateral_keyword_x0in">x0in</a>, <a href="#_square2quadrilateral_keyword_y0in">y0in</a>, <a href="#_square2quadrilateral_keyword_x1in">x1in</a>, <a href="#_square2quadrilateral_keyword_y1in">y1in</a>, <a href="#_square2quadrilateral_keyword_x2in">x2in</a>, <a href="#_square2quadrilateral_keyword_y2in">y2in</a>, <a href="#_square2quadrilateral_keyword_x3in">x3in</a>, <a href="#_square2quadrilateral_keyword_y3in">y3in</a>[, <a href="#_square2quadrilateral_keyword_xxin">xxin</a>][, <a href="#_square2quadrilateral_keyword_yyin">yyin</a>]</i>)</font></p> 
     84      <p><font face="Courier"><i>result = </i>square2quadrilateral(<i><a href="#_square2quadrilateral_keyword_x0in">x0in</a>, <a href="#_square2quadrilateral_keyword_y0in">y0in</a>, <a href="#_square2quadrilateral_keyword_x1in">x1in</a>, <a href="#_square2quadrilateral_keyword_y1in">y1in</a>, <a href="#_square2quadrilateral_keyword_x2in">x2in</a>, <a href="#_square2quadrilateral_keyword_y2in">y2in</a>, <a href="#_square2quadrilateral_keyword_x3in">x3in</a>, <a href="#_square2quadrilateral_keyword_y3in">y3in</a>[, <a href="#_square2quadrilateral_keyword_xxin">xxin</a>][, <a href="#_square2quadrilateral_keyword_yyin">yyin</a>]</i>, <a href="#_square2quadrilateral_keyword_DOUBLE">DOUBLE</a>=<i>salar 0 or 1</i>)</font></p> 
    8585 
    8686     
    … …  
    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, <a href=".//square2quadrilateral.html">square2quadrilateral</a> returns the 
     95 If xin and yin are omited, <a href="..//Interpolation/square2quadrilateral.html">square2quadrilateral</a> returns the 
    9696 matrix A which is used for the inverse transformation. 
    9797 
    … …  
    239239 
    240240     
     241 first coordinates of the point(s) for which we want to do the mapping. 
    241242     
    242243 
    … …  
    254255 
    255256     
    256  the coordinates of the point(s) for which we want to do the mapping. 
    257  
    258      
    259      
    260  
     257 second coordinates of the point(s) for which we want to do the mapping. 
     258 
     259     
     260     
     261 
     262     
     263    <h3>Keywords</h3> 
     264 
     265     
     266    <a name="#_square2quadrilateral_keyword_DOUBLE"></a> 
     267    <h4>DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     268       
     269       
     270       
     271       
     272       
     273      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>salar 0 or 1</i></font> 
     274      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> 
     275       
     276    </h4> 
     277 
     278     
     279 activate to perform double precision computation 
     280 
     281     
    261282     
    262283 
    … …  
    273294     
    274295    <h4>Version</h4> 
    275  $Id: square2quadrilateral.pro 242 2007-04-06 08:35:17Z pinsard $ 
     296 $Id: square2quadrilateral.pro 282 2007-09-12 15:43:11Z smasson $ 
    276297 
    277298    <h4>History</h4> 
Note: See TracChangeset for help on using the changeset viewer.