Ignore:
Timestamp:
01/12/07 12:42:03 (17 years ago)
Author:
smasson
Message:

update documentation

Location:
trunk/SRC/Documentation/idldoc_assistant_output
Files:
1 added
10 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_assistant_output/Grid/computegrid.html

    r200 r203  
    651651    <h3>Version history</h3> 
    652652     
    653     <h4>Version</h4> $Id: computegrid.pro 192 2006-09-22 09:37:08Z smasson $ 
     653    <h4>Version</h4> $Id: computegrid.pro 202 2007-01-12 11:00:06Z smasson $ 
    654654 
    655655    <h4>History</h4> Sebastien Masson (smasson@lodyc.jussieu.fr) 

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

    r200 r203  
    6464 north stereographic polar projection 
    6565 
    66  Compute angles between grid lines and direction of the North 
     66 Compute angles between grid lines and direction of the North pole 
    6767(fom angle.F,v 2.2 in OPA8.2) 
    6868 
    6969 
    7070     
    71     <h2>Routine summary</h2> 
    72  
    73     <dl> 
    74        
    75       <dt><a href="#_fsnspp"><i>result = </i>fsnspp(<i>plam, pphi</i>, DOUBLE=<i>DOUBLE</i>)</a><dt> 
    76       <dd><font size="-1"></font></dd> 
    77        
    78       <dt><a href="#_angle">angle<i>, fileocemesh, gcosu, gsinu, gcosv, gsinv, gcost, gsint</i>, IODIRECTORY=<i>IODIRECTORY</i>, DOUBLE=<i>DOUBLE</i></a><dt> 
    79       <dd><font size="-1"></font></dd> 
    80        
    81     </dl> 
    82  
    83     <p>&nbsp;</p> 
    84      
    85  
    86        
    87       <a name="#_fsnspp"></a> 
    88  
    89       <h2>fsnspp  <font size="-1" color="#006633">  
     71 
     72       
     73      <a name="#_angle"></a> 
     74 
     75      <h2>angle  <font size="-1" color="#006633">  
    9076 Interpolation 
    9177</font></h2> 
    9278 
    93       <p><font face="Courier"><i>result = </i>fsnspp(<i><a href="#_fsnspp_keyword_plam">plam</a>, <a href="#_fsnspp_keyword_pphi">pphi</a></i>, <a href="#_fsnspp_keyword_DOUBLE">DOUBLE</a>=<i>DOUBLE</i>)</font></p> 
    94  
    95      
    96  
    97     <h3>Return value</h3> 
    98        gsinu,gcosu : sinus and cosinus of the angle 
    99        gsinv,gcosv   between north-south direction 
    100        gsint,gcost   and the j-direction of the mesh 
    101  
     79      <p><font face="Courier">angle<i>, <a href="#_angle_keyword_fileocemesh">fileocemesh</a>, <a href="#_angle_keyword_gcosu">gcosu</a>, <a href="#_angle_keyword_gsinu">gsinu</a>, <a href="#_angle_keyword_gcosv">gcosv</a>, <a href="#_angle_keyword_gsinv">gsinv</a>, <a href="#_angle_keyword_gcost">gcost</a>, <a href="#_angle_keyword_gsint">gsint</a></i>, <a href="#_angle_keyword_IODIRECTORY">IODIRECTORY</a>=<i>scalar string</i>, <a href="#_angle_keyword_DOUBLE">DOUBLE</a>=<i>1 ou 2</i></font></p> 
     80 
     81     
     82 
     83     
    10284 
    10385     
    … …  
    10587     
    10688 
    107     <a name="#_fsnspp_keyword_plam"></a> 
    108     <h4>plam&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     89    <a name="#_angle_keyword_fileocemesh"></a> 
     90    <h4>fileocemesh&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    10991      <font size="-1" color="#006633">in</font> 
    11092       
    … …  
    11294      <font size="-1" color="#006633">required</font> 
    11395       
    114        
    115        
    116        
    117     </h4> 
    118  
    119      
    120  
    121      
    122  
    123     <a name="#_fsnspp_keyword_pphi"></a> 
    124     <h4>pphi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    125       <font size="-1" color="#006633">in</font> 
    126        
    127        
    128       <font size="-1" color="#006633">required</font> 
    129        
    130        
    131        
    132        
    133     </h4> 
    134  
    135      
     96      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font> 
     97       
     98       
     99    </h4> 
     100 
     101     
     102 a netcdf file that contains (at least) the following variables: 
     103        glamu, gphiu: longitudes and latitudes at U-points 
     104        glamv, gphiv: longitudes and latitudes at V-points 
     105        glamf, gphif: longitudes and latitudes at F-points 
     106 
     107     
     108 
     109    <a name="#_angle_keyword_gcosu"></a> 
     110    <h4>gcosu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     111       
     112      <font size="-1" color="#006633">out</font> 
     113       
     114       
     115       
     116      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
     117       
     118       
     119    </h4> 
     120 
     121     
     122 cosinus of the angle between grid lines at U points and direction of the North pole 
     123 
     124     
     125 
     126    <a name="#_angle_keyword_gsinu"></a> 
     127    <h4>gsinu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     128       
     129      <font size="-1" color="#006633">out</font> 
     130       
     131       
     132       
     133      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
     134       
     135       
     136    </h4> 
     137 
     138     
     139 sinus of the angle between grid lines at U points and direction of the North pole 
     140 
     141     
     142 
     143    <a name="#_angle_keyword_gcosv"></a> 
     144    <h4>gcosv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     145       
     146      <font size="-1" color="#006633">out</font> 
     147       
     148       
     149       
     150      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
     151       
     152       
     153    </h4> 
     154 
     155     
     156 cosinus of the angle between grid lines at V points and direction of the North pole 
     157 
     158     
     159 
     160    <a name="#_angle_keyword_gsinv"></a> 
     161    <h4>gsinv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     162       
     163      <font size="-1" color="#006633">out</font> 
     164       
     165       
     166       
     167      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
     168       
     169       
     170    </h4> 
     171 
     172     
     173 sinus of the angle between grid lines at V points and direction of the North pole 
     174 
     175     
     176 
     177    <a name="#_angle_keyword_gcost"></a> 
     178    <h4>gcost&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     179       
     180      <font size="-1" color="#006633">out</font> 
     181       
     182       
     183       
     184      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
     185       
     186       
     187    </h4> 
     188 
     189     
     190 cosinus of the angle between grid lines at T points and direction of the North pole 
     191 
     192     
     193 
     194    <a name="#_angle_keyword_gsint"></a> 
     195    <h4>gsint&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     196       
     197      <font size="-1" color="#006633">out</font> 
     198       
     199       
     200       
     201      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
     202       
     203       
     204    </h4> 
     205 
     206     
     207 sinus of the angle between grid lines at T points and direction of the North pole 
    136208 
    137209     
    … …  
    142214 
    143215     
    144     <a name="#_fsnspp_keyword_DOUBLE"></a> 
     216    <a name="#_angle_keyword_IODIRECTORY"></a> 
     217    <h4>IODIRECTORY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     218       
     219       
     220       
     221       
     222       
     223      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font> 
     224      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>''</i></font> 
     225       
     226    </h4> 
     227 
     228     
     229 the directory path where is located fileocemesh 
     230 
     231     
     232    <a name="#_angle_keyword_DOUBLE"></a> 
    145233    <h4>DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    146234       
    … …  
    149237       
    150238       
    151        
     239      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>1 ou 2</i></font> 
    152240      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> 
    153241       
    … …  
    155243 
    156244     
    157  use double precision (default is float) 
     245 put 1 to use double precision (default is float) 
    158246 
    159247     
    … …  
    163251    <h3>Version history</h3> 
    164252     
    165     <h4>Version</h4> $Id: angle.pro 157 2006-08-21 09:01:50Z navarro $ 
    166  
     253    <h4>Version</h4> $Id: angle.pro 202 2007-01-12 11:00:06Z smasson $ 
    167254    <h4>History</h4> 
    168255       Original :  96-07 (O. Marti) 
    … …  
    187274 
    188275 
    189  
    190276     
    191277     
    … …  
    199285    <hr size="1" color="#CCCCCC"/> 
    200286       
    201       <a name="#_angle"></a> 
    202  
    203       <h2>angle  </h2> 
    204  
    205       <p><font face="Courier">angle<i>, <a href="#_angle_keyword_fileocemesh">fileocemesh</a>, <a href="#_angle_keyword_gcosu">gcosu</a>, <a href="#_angle_keyword_gsinu">gsinu</a>, <a href="#_angle_keyword_gcosv">gcosv</a>, <a href="#_angle_keyword_gsinv">gsinv</a>, <a href="#_angle_keyword_gcost">gcost</a>, <a href="#_angle_keyword_gsint">gsint</a></i>, <a href="#_angle_keyword_IODIRECTORY">IODIRECTORY</a>=<i>IODIRECTORY</i>, <a href="#_angle_keyword_DOUBLE">DOUBLE</a>=<i>DOUBLE</i></font></p> 
    206  
    207      
    208  
    209      
    210  
    211      
    212     <h3>Parameters</h3> 
    213      
    214  
    215     <a name="#_angle_keyword_fileocemesh"></a> 
    216     <h4>fileocemesh&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    217       <font size="-1" color="#006633">in</font> 
    218        
    219        
    220       <font size="-1" color="#006633">required</font> 
    221        
    222        
    223        
    224        
    225     </h4> 
    226  
    227      a netcdf file that contains (at least): 
    228         glamu, gphiu: longitudes and latitudes at U-points 
    229         glamv, gphiv: longitudes and latitudes at V-points 
    230         glamf, gphif: longitudes and latitudes at F-points 
    231  
    232      
    233  
    234     <a name="#_angle_keyword_gcosu"></a> 
    235     <h4>gcosu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    236       <font size="-1" color="#006633">in</font> 
    237        
    238        
    239       <font size="-1" color="#006633">required</font> 
    240        
    241        
    242        
    243        
    244     </h4> 
    245  
    246      
    247      
    248  
    249     <a name="#_angle_keyword_gsinu"></a> 
    250     <h4>gsinu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    251       <font size="-1" color="#006633">in</font> 
    252        
    253        
    254       <font size="-1" color="#006633">required</font> 
    255        
    256        
    257        
    258        
    259     </h4> 
    260  
    261      
    262      
    263  
    264     <a name="#_angle_keyword_gcosv"></a> 
    265     <h4>gcosv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    266       <font size="-1" color="#006633">in</font> 
    267        
    268        
    269       <font size="-1" color="#006633">required</font> 
    270        
    271        
    272        
    273        
    274     </h4> 
    275  
    276      
    277      
    278  
    279     <a name="#_angle_keyword_gsinv"></a> 
    280     <h4>gsinv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    281       <font size="-1" color="#006633">in</font> 
    282        
    283        
    284       <font size="-1" color="#006633">required</font> 
    285        
    286        
    287        
    288        
    289     </h4> 
    290  
    291      
    292      
    293  
    294     <a name="#_angle_keyword_gcost"></a> 
    295     <h4>gcost&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    296       <font size="-1" color="#006633">in</font> 
    297        
    298        
    299       <font size="-1" color="#006633">required</font> 
    300        
    301        
    302        
    303        
    304     </h4> 
    305  
    306      
    307      
    308  
    309     <a name="#_angle_keyword_gsint"></a> 
    310     <h4>gsint&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    311       <font size="-1" color="#006633">in</font> 
    312        
    313        
    314       <font size="-1" color="#006633">required</font> 
    315        
    316        
    317        
    318        
    319     </h4> 
    320  
    321      
    322      
    323      
    324  
    325      
    326     <h3>Keywords</h3> 
    327  
    328      
    329     <a name="#_angle_keyword_IODIRECTORY"></a> 
    330     <h4>IODIRECTORY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    331        
    332        
    333        
    334        
    335        
    336        
    337        
    338        
    339     </h4> 
    340  
    341      the directory path where is located fileocemesh 
    342      
    343     <a name="#_angle_keyword_DOUBLE"></a> 
    344     <h4>DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    345        
    346        
    347        
    348        
    349        
    350        
    351       <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> 
    352        
    353     </h4> 
    354  
    355      use double precision (default is float) 
    356      
    357      
    358  
    359      
    360      
    361      
    362      
    363      
    364      
    365  
    366      
    367      
    368      
    369      
    370      
    371  
    372      
    373      
    374      
    375      
    376      
    377      
    378      
    379  
    380     <font size="-3"><p>&nbsp;</p></font> 
    381     <hr size="1" color="#CCCCCC"/> 
    382        
    383287 
    384288     

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

    r200 r203  
    9393      <font size="-1" color="#006633">required</font> 
    9494       
    95        
     95      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
    9696       
    9797       
    … …  
    110110      <font size="-1" color="#006633">required</font> 
    111111       
    112        
     112      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
    113113       
    114114       
    … …  
    127127      <font size="-1" color="#006633">required</font> 
    128128       
    129        
     129      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array or -1</i></font> 
    130130       
    131131       
    … …  
    134134     
    135135 land/sea mask of the input data 
     136 put -1 if input data are not masked 
    136137 
    137138     
    … …  
    144145      <font size="-1" color="#006633">required</font> 
    145146       
    146        
     147      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
    147148       
    148149       
    … …  
    161162      <font size="-1" color="#006633">required</font> 
    162163       
    163        
     164      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
    164165       
    165166       
    … …  
    178179      <font size="-1" color="#006633">required</font> 
    179180       
    180        
     181      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array or -1</i></font> 
    181182       
    182183       
    … …  
    185186     
    186187 land/sea mask of the output data 
     188 put -1 if output data are not masked 
    187189 
    188190     
    … …  
    195197       
    196198       
    197        
    198        
    199        
    200     </h4> 
    201  
    202      
     199      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
     200       
     201       
     202    </h4> 
     203 
     204     
     205 (see ADDR) 
     206 
    203207     
    204208 
    … …  
    210214       
    211215       
    212        
     216      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
    213217       
    214218       
    … …  
    229233    <h3>Version history</h3> 
    230234     
    231     <h4>Version</h4> $Id: compute_fromirr_bilinear_weigaddr.pro 157 2006-08-21 09:01:50Z navarro $ 
     235    <h4>Version</h4> $Id: compute_fromirr_bilinear_weigaddr.pro 202 2007-01-12 11:00:06Z smasson $ 
    232236 
    233237    <h4>History</h4> 
    … …  
    251255  and the weight is redistributed on the remaining "water" corners 
    252256  -  points located out of the southern and northern boundaries or in cells 
    253   containing only land points are set the the same value as their closest neighbor l 
     257  containing only land points are set the the same value as their closest neighbor 
    254258 
    255259 

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

    r200 r203  
    7575</font></h2> 
    7676 
    77       <p><font face="Courier">compute_fromreg_bilinear_weigaddr<i>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_alonin">alonin</a>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_alatin">alatin</a>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_olonin">olonin</a>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_olat">olat</a>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_weig">weig</a>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_addr">addr</a></i>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_NONORTHERNLINE">NONORTHERNLINE</a>=<i>NONORTHERNLINE</i>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<i>NOSOUTHERNLINE</i></font></p> 
     77      <p><font face="Courier">compute_fromreg_bilinear_weigaddr<i>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_alonin">alonin</a>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_alatin">alatin</a>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_olonin">olonin</a>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_olat">olat</a>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_weig">weig</a>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_addr">addr</a></i>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_NONORTHERNLINE">NONORTHERNLINE</a>=<i>scalar 0 or 1</i>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<i>scalar 0 or 1</i></font></p> 
    7878 
    7979     
    … …  
    9292      <font size="-1" color="#006633">required</font> 
    9393       
    94        
     94      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
    9595       
    9696       
    … …  
    109109      <font size="-1" color="#006633">required</font> 
    110110       
    111        
     111      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
    112112       
    113113       
    … …  
    126126      <font size="-1" color="#006633">required</font> 
    127127       
    128        
     128      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
    129129       
    130130       
    … …  
    143143      <font size="-1" color="#006633">required</font> 
    144144       
    145        
     145      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
    146146       
    147147       
    … …  
    160160       
    161161       
    162        
    163        
    164        
    165     </h4> 
    166  
    167      
     162      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
     163       
     164       
     165    </h4> 
     166 
     167     
     168 (see ADDR) 
     169 
    168170     
    169171 
    … …  
    175177       
    176178       
    177        
     179      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
    178180       
    179181       
    … …  
    200202       
    201203       
    202        
    203        
    204        
    205     </h4> 
    206  
    207      
    208  activate if you don't want to take into 
     204      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar 0 or 1</i></font> 
     205      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> 
     206       
     207    </h4> 
     208 
     209     
     210 put 1 if you don't want to take into 
    209211 account the northen line of the input data when performing the interpolation. 
    210212 
    … …  
    217219       
    218220       
    219        
    220        
    221        
    222     </h4> 
    223  
    224      
    225  activate if you don't want to take into 
     221      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar 0 or 1</i></font> 
     222      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> 
     223       
     224    </h4> 
     225 
     226     
     227 put 1 if you don't want to take into 
    226228 account the southern line of the input data when performing the interpolation. 
    227229 
    … …  
    232234    <h3>Version history</h3> 
    233235     
    234     <h4>Version</h4> $Id: compute_fromreg_bilinear_weigaddr.pro 163 2006-08-29 12:59:46Z navarro $ 
     236    <h4>Version</h4> $Id: compute_fromreg_bilinear_weigaddr.pro 202 2007-01-12 11:00:06Z smasson $ 
    235237 
    236238    <h4>History</h4> 

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

    r200 r203  
    7575</font></h2> 
    7676 
    77       <p><font face="Courier">compute_fromreg_imoms3_weigaddr<i>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_alonin">alonin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_alatin">alatin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_olonin">olonin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_olat">olat</a>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_weig">weig</a>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_addr">addr</a></i>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_NONORTHERNLINE">NONORTHERNLINE</a>=<i>NONORTHERNLINE</i>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<i>NOSOUTHERNLINE</i></font></p> 
     77      <p><font face="Courier">compute_fromreg_imoms3_weigaddr<i>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_alonin">alonin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_alatin">alatin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_olonin">olonin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_olat">olat</a>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_weig">weig</a>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_addr">addr</a></i>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_NONORTHERNLINE">NONORTHERNLINE</a>=<i>scalar 0 or 1</i>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<i>scalar 0 or 1</i></font></p> 
    7878 
    7979     
    … …  
    9393      <font size="-1" color="#006633">required</font> 
    9494       
    95        
     95      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
    9696       
    9797       
    … …  
    110110      <font size="-1" color="#006633">required</font> 
    111111       
    112        
     112      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
    113113       
    114114       
    … …  
    127127      <font size="-1" color="#006633">required</font> 
    128128       
    129        
     129      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
    130130       
    131131       
    … …  
    134134     
    135135 longitude of the output data 
     136 
    136137     
    137138 
    … …  
    143144      <font size="-1" color="#006633">required</font> 
    144145       
    145        
     146      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
    146147       
    147148       
    … …  
    160161       
    161162       
    162        
    163        
    164        
    165     </h4> 
    166  
    167      
     163      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
     164       
     165       
     166    </h4> 
     167 
     168     
     169 (see ADDR) 
     170 
    168171     
    169172 
    … …  
    175178       
    176179       
    177        
     180      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
    178181       
    179182       
    … …  
    200203       
    201204       
    202        
    203        
    204        
    205     </h4> 
    206  
    207      
     205      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar 0 or 1</i></font> 
     206      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> 
     207       
     208    </h4> 
     209 
     210     
     211 put 1 if you don't want to take into 
     212 account the northen line of the input data when performing the interpolation. 
     213 
    208214     
    209215    <a name="#_compute_fromreg_imoms3_weigaddr_keyword_NOSOUTHERNLINE"></a> 
    … …  
    214220       
    215221       
    216        
    217        
    218        
    219     </h4> 
    220  
    221      
    222  activate if you don't want to take into account the northen/southern line 
    223  of the input data when performing the interpolation. 
     222      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar 0 or 1</i></font> 
     223      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> 
     224       
     225    </h4> 
     226 
     227     
     228 put 1 if you don't want to take into 
     229 account the southern line of the input data when performing the interpolation. 
    224230 
    225231     
    … …  
    229235    <h3>Version history</h3> 
    230236     
    231     <h4>Version</h4> $Id: compute_fromreg_imoms3_weigaddr.pro 163 2006-08-29 12:59:46Z navarro $ 
     237    <h4>Version</h4> $Id: compute_fromreg_imoms3_weigaddr.pro 202 2007-01-12 11:00:06Z smasson $ 
    232238 
    233239    <h4>History</h4> 

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

    r200 r203  
    2929        <li><a href="cutsegment.html" target="file_frame">cutsegment.pro</a></li> 
    3030        <li><a href="extrapolate.html" target="file_frame">extrapolate.pro</a></li> 
     31        <li><a href="extrapsmooth.html" target="file_frame">extrapsmooth.pro</a></li> 
    3132        <li><a href="fromirr.html" target="file_frame">fromirr.pro</a></li> 
    3233        <li><a href="fromreg.html" target="file_frame">fromreg.pro</a></li> 
    … …  
    4546      </ul> 
    4647 
    47       <div id="tagline">22 files</div> 
     48      <div id="tagline">23 files</div> 
    4849       
    4950 

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

    r200 r203  
    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="extrapsmooth.html"><img src="./../next.gif" border="0" alt="Next"></a></td> 
    5353  </tr> 
    5454</table> 
    … …  
    6262 
    6363     
    64  extrapolate data (zinput) where maskinput eq 0 by filling 
    65  step by step the coastline points with the mean value of the 8 neighbourgs. 
     64 extrapolate data (zinput) where maskinput eq 0 by filling step by  
     65 step the coastline points with the mean value of the 8 neighbourgs 
     66 (weighted by their mask value). 
    6667 
    6768 
    … …  
    7576</font></h2> 
    7677 
    77       <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>x_periodic</i>, <a href="#_extrapolate_keyword_MINVAL">MINVAL</a>=<i>MINVAL</i>, <a href="#_extrapolate_keyword_MAXVAL">MAXVAL</a>=<i>MAXVAL</i>, <a href="#_extrapolate_keyword_GE0">GE0</a>=<i>GE0</i>)</font></p> 
    78  
    79      
    80  
    81      
     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> 
     79 
     80     
     81 
     82    <h3>Return value</h3> {type=2d array} 
     83 the extrapolated array 
     84 
    8285 
    8386     
    … …  
    9295      <font size="-1" color="#006633">required</font> 
    9396       
    94        
     97      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
    9598       
    9699       
    … …  
    109112      <font size="-1" color="#006633">required</font> 
    110113       
    111        
    112        
    113        
    114     </h4> 
    115  
    116      
     114      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array or -1</i></font> 
     115       
     116       
     117    </h4> 
     118 
     119     
     120 a 2D array, the land-sea mask of the output data (1 on ocean, 0 on land) 
     121 put -1 if input data are not masked 
    117122 
    118123     
    … …  
    125130       
    126131       
    127        
    128        
    129        
    130     </h4> 
    131  
    132      
    133  number of iteration 
     132      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer scalar</i></font> 
     133      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>10.E20</i></font> 
     134       
     135    </h4> 
     136 
     137     
     138 Maximum number if iterations done in the extrapolation process. If there 
     139 is no more masked values we exit extrapolate before reaching nb_iteration 
     140 (to be sure to fill everything, you can use a very large value) 
    134141 
    135142     
    … …  
    147154       
    148155       
    149        
    150        
    151        
    152     </h4> 
    153  
    154      
     156      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar, 0 or 1</i></font> 
     157      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> 
     158       
     159    </h4> 
     160 
     161     
     162 put 1 to specify that the data are periodic along x axis 
     163 
    155164     
    156165    <a name="#_extrapolate_keyword_MINVAL"></a> 
    … …  
    161170       
    162171       
    163        
    164        
    165        
    166     </h4> 
    167  
    168      
     172      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     173      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>not used</i></font> 
     174       
     175    </h4> 
     176 
     177     
     178 to specify a minimum value to the extrapolated values 
     179 
    169180     
    170181    <a name="#_extrapolate_keyword_MAXVAL"></a> 
    … …  
    175186       
    176187       
    177        
    178        
    179        
    180     </h4> 
    181  
    182      
     188      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     189      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>not used</i></font> 
     190       
     191    </h4> 
     192 
     193     
     194 to specify a maximum value to the extrapolated values 
     195 
    183196     
    184197    <a name="#_extrapolate_keyword_GE0"></a> 
    … …  
    189202       
    190203       
    191        
    192        
    193        
    194     </h4> 
    195  
    196      
    197  
    198      
    199      
    200  
    201      
     204      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar 0 or 1</i></font> 
     205      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> 
     206       
     207    </h4> 
     208 
     209     
     210 put 1 to force the extrapolated values to be larger than 0, same as using minval=0. 
     211 
     212     
     213     
     214 
     215    <h3>Examples</h3> 
     216 IDL> a=extrapolate(dist(jpi,jpj),tmask[*,*,0],/x_periodic) 
     217 IDL> tvplus, a 
     218 IDL> tvplus, a*(1-tmask[*,*,0]) 
     219 get the coastline: 
     220 IDL> a=extrapolate(tmask[*,*,0],tmask[*,*,0],1,/x_periodic) 
     221 IDL> tvplus, a-tmask[*,*,0] 
     222 
    202223    <h3>Version history</h3> 
    203224     
    204     <h4>Version</h4> $Id: extrapolate.pro 199 2006-12-13 07:47:14Z smasson $ 
    205  
    206      
     225    <h4>Version</h4> $Id: extrapolate.pro 202 2007-01-12 11:00:06Z smasson $ 
     226 
     227    <h4>History</h4> 
     228  Originaly written by G. Roulet 
     229  Sebastien Masson (smasson@lodyc.jussieu.fr) 
     230 
    207231     
    208232 

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

    r200 r203  
    4646  <tr> 
    4747    <td width="10%"> 
    48 <a href="extrapolate.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td> 
     48<a href="extrapsmooth.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> 
    … …  
    163163       
    164164       
    165       <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
     165      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array or -1</i></font> 
    166166       
    167167       
    … …  
    170170     
    171171 a 2D array, the land-sea mask of the input data (1 on ocean, 0 on land) 
     172 put -1 if input data are not masked 
    172173 
    173174     
    … …  
    214215      <font size="-1" color="#006633">required</font> 
    215216       
    216       <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
     217      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array or -1</i></font> 
    217218       
    218219       
    … …  
    221222     
    222223 a 2D array, the land-sea mask of the output data (1 on ocean, 0 on land) 
     224 put -1 if output data are not masked 
    223225 
    224226     
    … …  
    283285    <h3>Version history</h3> 
    284286     
    285     <h4>Version</h4> $Id: fromirr.pro 163 2006-08-29 12:59:46Z navarro $ 
     287    <h4>Version</h4> $Id: fromirr.pro 202 2007-01-12 11:00:06Z smasson $ 
    286288 
    287289    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/WIDGET/AUTOUR_de_XXX/selectfile.html

    r200 r203  
    129129     
    130130    <h4>Version</h4>  
    131  $Id: selectfile.pro 181 2006-09-15 08:24:36Z smasson $ 
     131 $Id: selectfile.pro 202 2007-01-12 11:00:06Z smasson $ 
    132132  
    133133    <h4>History</h4> 
    … …  
    256256     
    257257    <h4>Version</h4>  
    258  $Id: selectfile.pro 181 2006-09-15 08:24:36Z smasson $ 
     258 $Id: selectfile.pro 202 2007-01-12 11:00:06Z smasson $ 
    259259  
    260260    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/idldoc-lib.adp

    r200 r203  
    230230      <keyword ref="./Interpolation/extrapolate.html#_extrapolate">extrapolate</keyword> 
    231231    </section> 
     232    <section ref="./Interpolation/extrapsmooth.html" title="extrapsmooth.pro"> 
     233      <keyword ref="./Interpolation/extrapsmooth.html#_extrapsmooth">extrapsmooth</keyword> 
     234    </section> 
    232235    <section ref="./Interpolation/fromirr.html" title="fromirr.pro"> 
    233236      <keyword ref="./Interpolation/fromirr.html#_fromirr">fromirr</keyword> 
Note: See TracChangeset for help on using the changeset viewer.