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

update documentation

Location:
trunk/SRC/Documentation/idldoc_html_output/Interpolation
Files:
1 added
8 edited

Legend:

Unmodified
Added
Removed

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

    r200 r203  
    7272<div id="secondary_navbar"> 
    7373 
    74 &lt;&lt; prev file | <a href="clickincell.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="angle.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | <a href="#routine_summary">routine</a>&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a> 
     74&lt;&lt; prev file | <a href="clickincell.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="angle.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a> 
    7575 
    7676</div> 
    … …  
    9090 north stereographic polar projection 
    9191 
    92  Compute angles between grid lines and direction of the North 
     92 Compute angles between grid lines and direction of the North pole 
    9393(fom angle.F,v 2.2 in OPA8.2) 
    9494</div> 
    … …  
    101101 
    102102       
    103       <div id="routine_summary">                 
    104         <h2>Routine summary</h2> 
    105          
    106         <dl> 
    107            
    108           <dt><p><a href="#_fsnspp"><span class="result">result = </span>fsnspp(<span class="result">plam, pphi</span>, DOUBLE=<span class="result">DOUBLE</span>)</a></p><dt> 
    109           <dd></dd>      
    110            
    111           <dt><p><a href="#_angle">angle<span class="result">, fileocemesh, gcosu, gsinu, gcosv, gsinv, gcost, gsint</span>, IODIRECTORY=<span class="result">IODIRECTORY</span>, DOUBLE=<span class="result">DOUBLE</span></a></p><dt> 
    112           <dd></dd>      
    113                  
    114         </dl> 
    115       </div> 
    116        
    117103 
    118104      <div id="routine_details"> 
    119105         
    120106 
    121         <div class="routine_details" id="_fsnspp"> 
    122  
    123           <h2><a class="top" href="#container">top</a>fsnspp <span class="categories">  
     107        <div class="routine_details" id="_angle"> 
     108 
     109          <h2><a class="top" href="#container">top</a>angle <span class="categories">  
    124110 Interpolation 
    125111</span></h2> 
    126112         
    127113          <p class="header"> 
    128             <span class="result">result = </span>fsnspp(<span class="result"><a href="#_fsnspp_param_plam">plam</a>, <a href="#_fsnspp_param_pphi">pphi</a></span>, <a href="#_fsnspp_keyword_DOUBLE">DOUBLE</a>=<span class="result">DOUBLE</span>)</p> 
     114            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> 
    129115         
    130116          <div class="comments"></div> 
    131117 
    132           <h3>Return value</h3><div class="preformat"> 
    133        gsinu,gcosu : sinus and cosinus of the angle 
    134        gsinv,gcosv   between north-south direction 
    135        gsint,gcost   and the j-direction of the mesh 
    136 </div> 
     118           
    137119 
    138120           
    … …  
    140122         
    141123             
    142             <h4 id="_fsnspp_param_plam">plam&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     124            <h4 id="_angle_param_fileocemesh">fileocemesh&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    143125              <span class="attr">in</span> 
    144126               
    … …  
    146128              <span class="attr">required</span> 
    147129               
    148                
    149                
    150                
    151             </h4> 
    152          
    153           <div class="comments"> 
    154 </div> 
    155              
    156             <h4 id="_fsnspp_param_pphi">pphi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    157               <span class="attr">in</span> 
    158                
    159                
    160               <span class="attr">required</span> 
    161                
    162                
    163                
    164                
    165             </h4> 
    166          
    167           <div class="comments"> 
     130              <span class="attr">type:</span> <span class="value">scalar string</span> 
     131               
     132               
     133            </h4> 
     134         
     135          <div class="comments"> 
     136 a netcdf file that contains (at least) the following variables: 
     137        glamu, gphiu: longitudes and latitudes at U-points 
     138        glamv, gphiv: longitudes and latitudes at V-points 
     139        glamf, gphif: longitudes and latitudes at F-points 
     140</div> 
     141             
     142            <h4 id="_angle_param_gcosu">gcosu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     143               
     144              <span class="attr">out</span> 
     145               
     146               
     147               
     148              <span class="attr">type:</span> <span class="value">2d array</span> 
     149               
     150               
     151            </h4> 
     152         
     153          <div class="comments"> 
     154 cosinus of the angle between grid lines at U points and direction of the North pole 
     155</div> 
     156             
     157            <h4 id="_angle_param_gsinu">gsinu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     158               
     159              <span class="attr">out</span> 
     160               
     161               
     162               
     163              <span class="attr">type:</span> <span class="value">2d array</span> 
     164               
     165               
     166            </h4> 
     167         
     168          <div class="comments"> 
     169 sinus of the angle between grid lines at U points and direction of the North pole 
     170</div> 
     171             
     172            <h4 id="_angle_param_gcosv">gcosv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     173               
     174              <span class="attr">out</span> 
     175               
     176               
     177               
     178              <span class="attr">type:</span> <span class="value">2d array</span> 
     179               
     180               
     181            </h4> 
     182         
     183          <div class="comments"> 
     184 cosinus of the angle between grid lines at V points and direction of the North pole 
     185</div> 
     186             
     187            <h4 id="_angle_param_gsinv">gsinv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     188               
     189              <span class="attr">out</span> 
     190               
     191               
     192               
     193              <span class="attr">type:</span> <span class="value">2d array</span> 
     194               
     195               
     196            </h4> 
     197         
     198          <div class="comments"> 
     199 sinus of the angle between grid lines at V points and direction of the North pole 
     200</div> 
     201             
     202            <h4 id="_angle_param_gcost">gcost&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     203               
     204              <span class="attr">out</span> 
     205               
     206               
     207               
     208              <span class="attr">type:</span> <span class="value">2d array</span> 
     209               
     210               
     211            </h4> 
     212         
     213          <div class="comments"> 
     214 cosinus of the angle between grid lines at T points and direction of the North pole 
     215</div> 
     216             
     217            <h4 id="_angle_param_gsint">gsint&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     218               
     219              <span class="attr">out</span> 
     220               
     221               
     222               
     223              <span class="attr">type:</span> <span class="value">2d array</span> 
     224               
     225               
     226            </h4> 
     227         
     228          <div class="comments"> 
     229 sinus of the angle between grid lines at T points and direction of the North pole 
    168230</div> 
    169231             
    … …  
    175237            <h3>Keywords</h3> 
    176238             
    177             <h4 id="_fsnspp_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     239            <h4 id="_angle_keyword_IODIRECTORY">IODIRECTORY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    178240               
    179241               
    … …  
    181243               
    182244               
    183                
     245              <span class="attr">type:</span> <span class="value">scalar string</span> 
     246              <span class="attr">default:</span> <span class="value">''</span> 
     247               
     248            </h4> 
     249         
     250            <div class="comments"> 
     251 the directory path where is located fileocemesh 
     252</div> 
     253             
     254            <h4 id="_angle_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     255               
     256               
     257               
     258               
     259               
     260              <span class="attr">type:</span> <span class="value">1 ou 2</span> 
    184261              <span class="attr">default:</span> <span class="value">0</span> 
    185262               
    … …  
    187264         
    188265            <div class="comments"> 
    189  use double precision (default is float) 
     266 put 1 to use double precision (default is float) 
    190267</div> 
    191268             
    … …  
    195272          <h3>Version history</h3> 
    196273           
    197           <h4>Version</h4><div class="preformat"> $Id: angle.pro 157 2006-08-21 09:01:50Z navarro $ 
    198 </div> 
     274          <h4>Version</h4><div class="preformat"> $Id: angle.pro 202 2007-01-12 11:00:06Z smasson $</div> 
    199275          <h4>History</h4><div class="preformat"> 
    200276       Original :  96-07 (O. Marti) 
    … …  
    217293       =>    gcosv[0, *] = gcosv[jpj-2, *] 
    218294       =>    gsinv[0, *] = gsinv[jpj-2, *] 
    219  
    220 </div> 
    221          
    222            
    223            
    224            
    225            
    226            
    227            
    228            
    229          
    230           <h3>Statistics</h3> 
    231           <table class="statistics"> 
    232             <tr><td>McCabe cyclic</td><td>           2</td></tr> 
    233             <tr><td>McCabe essential</td><td>           1</td></tr> 
    234             <tr><td>McCabe modular design</td><td>           1</td></tr> 
    235           </table> 
    236            
    237          
    238         </div> 
    239          
    240  
    241         <div class="routine_details" id="_angle"> 
    242  
    243           <h2><a class="top" href="#container">top</a>angle </h2> 
    244          
    245           <p class="header"> 
    246             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">IODIRECTORY</span>, <a href="#_angle_keyword_DOUBLE">DOUBLE</a>=<span class="result">DOUBLE</span></p> 
    247          
    248           <div class="comments"></div> 
    249  
    250            
    251  
    252            
    253             <h3>Parameters</h3> 
    254          
    255              
    256             <h4 id="_angle_param_fileocemesh">fileocemesh&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    257               <span class="attr">in</span> 
    258                
    259                
    260               <span class="attr">required</span> 
    261                
    262                
    263                
    264                
    265             </h4> 
    266          
    267           <div class="comments"> a netcdf file that contains (at least): 
    268         glamu, gphiu: longitudes and latitudes at U-points 
    269         glamv, gphiv: longitudes and latitudes at V-points 
    270         glamf, gphif: longitudes and latitudes at F-points 
    271 </div> 
    272              
    273             <h4 id="_angle_param_gcosu">gcosu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    274               <span class="attr">in</span> 
    275                
    276                
    277               <span class="attr">required</span> 
    278                
    279                
    280                
    281                
    282             </h4> 
    283          
    284           <div class="comments"></div> 
    285              
    286             <h4 id="_angle_param_gsinu">gsinu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    287               <span class="attr">in</span> 
    288                
    289                
    290               <span class="attr">required</span> 
    291                
    292                
    293                
    294                
    295             </h4> 
    296          
    297           <div class="comments"></div> 
    298              
    299             <h4 id="_angle_param_gcosv">gcosv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    300               <span class="attr">in</span> 
    301                
    302                
    303               <span class="attr">required</span> 
    304                
    305                
    306                
    307                
    308             </h4> 
    309          
    310           <div class="comments"></div> 
    311              
    312             <h4 id="_angle_param_gsinv">gsinv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    313               <span class="attr">in</span> 
    314                
    315                
    316               <span class="attr">required</span> 
    317                
    318                
    319                
    320                
    321             </h4> 
    322          
    323           <div class="comments"></div> 
    324              
    325             <h4 id="_angle_param_gcost">gcost&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    326               <span class="attr">in</span> 
    327                
    328                
    329               <span class="attr">required</span> 
    330                
    331                
    332                
    333                
    334             </h4> 
    335          
    336           <div class="comments"></div> 
    337              
    338             <h4 id="_angle_param_gsint">gsint&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    339               <span class="attr">in</span> 
    340                
    341                
    342               <span class="attr">required</span> 
    343                
    344                
    345                
    346                
    347             </h4> 
    348          
    349           <div class="comments"></div> 
    350              
    351  
    352            
    353  
    354            
    355  
    356             <h3>Keywords</h3> 
    357              
    358             <h4 id="_angle_keyword_IODIRECTORY">IODIRECTORY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    359                
    360                
    361                
    362                
    363                
    364                
    365                
    366                
    367             </h4> 
    368          
    369             <div class="comments"> the directory path where is located fileocemesh</div> 
    370              
    371             <h4 id="_angle_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    372                
    373                
    374                
    375                
    376                
    377                
    378               <span class="attr">default:</span> <span class="value">0</span> 
    379                
    380             </h4> 
    381          
    382             <div class="comments"> use double precision (default is float)</div> 
    383              
    384            
    385  
    386            
    387            
    388            
    389            
    390            
    391            
    392            
    393            
    394            
    395            
    396            
    397            
     295</div> 
    398296         
    399297           

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

    r200 r203  
    127127              <span class="attr">required</span> 
    128128               
    129                
     129              <span class="attr">type:</span> <span class="value">2d array</span> 
    130130               
    131131               
    … …  
    142142              <span class="attr">required</span> 
    143143               
    144                
     144              <span class="attr">type:</span> <span class="value">2d array</span> 
    145145               
    146146               
    … …  
    157157              <span class="attr">required</span> 
    158158               
    159                
     159              <span class="attr">type:</span> <span class="value">2d array or -1</span> 
    160160               
    161161               
    … …  
    164164          <div class="comments"> 
    165165 land/sea mask of the input data 
     166 put -1 if input data are not masked 
    166167</div> 
    167168             
    … …  
    172173              <span class="attr">required</span> 
    173174               
    174                
     175              <span class="attr">type:</span> <span class="value">2d array</span> 
    175176               
    176177               
    … …  
    187188              <span class="attr">required</span> 
    188189               
    189                
     190              <span class="attr">type:</span> <span class="value">2d array</span> 
    190191               
    191192               
    … …  
    202203              <span class="attr">required</span> 
    203204               
    204                
     205              <span class="attr">type:</span> <span class="value">2d array or -1</span> 
    205206               
    206207               
    … …  
    209210          <div class="comments"> 
    210211 land/sea mask of the output data 
     212 put -1 if output data are not masked 
    211213</div> 
    212214             
    … …  
    217219               
    218220               
    219                
    220                
    221                
    222             </h4> 
    223          
    224           <div class="comments"></div> 
     221              <span class="attr">type:</span> <span class="value">2d array</span> 
     222               
     223               
     224            </h4> 
     225         
     226          <div class="comments"> 
     227 (see ADDR) 
     228</div> 
    225229             
    226230            <h4 id="_compute_fromirr_bilinear_weigaddr_param_addr">addr&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    230234               
    231235               
    232                
     236              <span class="attr">type:</span> <span class="value">2d array</span> 
    233237               
    234238               
    … …  
    250254          <h3>Version history</h3> 
    251255           
    252           <h4>Version</h4><div class="preformat"> $Id: compute_fromirr_bilinear_weigaddr.pro 157 2006-08-21 09:01:50Z navarro $ 
     256          <h4>Version</h4><div class="preformat"> $Id: compute_fromirr_bilinear_weigaddr.pro 202 2007-01-12 11:00:06Z smasson $ 
    253257</div> 
    254258          <h4>History</h4><div class="preformat"> 
    … …  
    272276  and the weight is redistributed on the remaining "water" corners 
    273277  -  points located out of the southern and northern boundaries or in cells 
    274   containing only land points are set the the same value as their closest neighbor l 
     278  containing only land points are set the the same value as their closest neighbor 
    275279</div> 
    276280         
    … …  
    285289          <h3>Statistics</h3> 
    286290          <table class="statistics"> 
    287             <tr><td>McCabe cyclic</td><td>          22</td></tr> 
     291            <tr><td>McCabe cyclic</td><td>          37</td></tr> 
    288292            <tr><td>McCabe essential</td><td>           1</td></tr> 
    289293            <tr><td>McCabe modular design</td><td>           1</td></tr> 

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

    r200 r203  
    110110         
    111111          <p class="header"> 
    112             compute_fromreg_bilinear_weigaddr<span class="result">, <a href="#_compute_fromreg_bilinear_weigaddr_param_alonin">alonin</a>, <a href="#_compute_fromreg_bilinear_weigaddr_param_alatin">alatin</a>, <a href="#_compute_fromreg_bilinear_weigaddr_param_olonin">olonin</a>, <a href="#_compute_fromreg_bilinear_weigaddr_param_olat">olat</a>, <a href="#_compute_fromreg_bilinear_weigaddr_param_weig">weig</a>, <a href="#_compute_fromreg_bilinear_weigaddr_param_addr">addr</a></span>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_NONORTHERNLINE">NONORTHERNLINE</a>=<span class="result">NONORTHERNLINE</span>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<span class="result">NOSOUTHERNLINE</span></p> 
     112            compute_fromreg_bilinear_weigaddr<span class="result">, <a href="#_compute_fromreg_bilinear_weigaddr_param_alonin">alonin</a>, <a href="#_compute_fromreg_bilinear_weigaddr_param_alatin">alatin</a>, <a href="#_compute_fromreg_bilinear_weigaddr_param_olonin">olonin</a>, <a href="#_compute_fromreg_bilinear_weigaddr_param_olat">olat</a>, <a href="#_compute_fromreg_bilinear_weigaddr_param_weig">weig</a>, <a href="#_compute_fromreg_bilinear_weigaddr_param_addr">addr</a></span>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_NONORTHERNLINE">NONORTHERNLINE</a>=<span class="result">scalar 0 or 1</span>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<span class="result">scalar 0 or 1</span></p> 
    113113         
    114114          <div class="comments"></div> 
    … …  
    126126              <span class="attr">required</span> 
    127127               
    128                
     128              <span class="attr">type:</span> <span class="value">2d array</span> 
    129129               
    130130               
    … …  
    141141              <span class="attr">required</span> 
    142142               
    143                
     143              <span class="attr">type:</span> <span class="value">2d array</span> 
    144144               
    145145               
    … …  
    156156              <span class="attr">required</span> 
    157157               
    158                
     158              <span class="attr">type:</span> <span class="value">2d array</span> 
    159159               
    160160               
    … …  
    171171              <span class="attr">required</span> 
    172172               
    173                
     173              <span class="attr">type:</span> <span class="value">2d array</span> 
    174174               
    175175               
    … …  
    186186               
    187187               
    188                
    189                
    190                
    191             </h4> 
    192          
    193           <div class="comments"></div> 
     188              <span class="attr">type:</span> <span class="value">2d array</span> 
     189               
     190               
     191            </h4> 
     192         
     193          <div class="comments"> 
     194 (see ADDR) 
     195</div> 
    194196             
    195197            <h4 id="_compute_fromreg_bilinear_weigaddr_param_addr">addr&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    199201               
    200202               
    201                
     203              <span class="attr">type:</span> <span class="value">2d array</span> 
    202204               
    203205               
    … …  
    224226               
    225227               
    226                
    227                
     228              <span class="attr">type:</span> <span class="value">scalar 0 or 1</span> 
     229              <span class="attr">default:</span> <span class="value">0</span> 
    228230               
    229231            </h4> 
    230232         
    231233            <div class="comments"> 
    232  activate if you don't want to take into 
     234 put 1 if you don't want to take into 
    233235 account the northen line of the input data when performing the interpolation. 
    234236</div> 
    … …  
    240242               
    241243               
    242                
    243                
     244              <span class="attr">type:</span> <span class="value">scalar 0 or 1</span> 
     245              <span class="attr">default:</span> <span class="value">0</span> 
    244246               
    245247            </h4> 
    246248         
    247249            <div class="comments"> 
    248  activate if you don't want to take into 
     250 put 1 if you don't want to take into 
    249251 account the southern line of the input data when performing the interpolation. 
    250252</div> 
    … …  
    255257          <h3>Version history</h3> 
    256258           
    257           <h4>Version</h4><div class="preformat"> $Id: compute_fromreg_bilinear_weigaddr.pro 163 2006-08-29 12:59:46Z navarro $ 
     259          <h4>Version</h4><div class="preformat"> $Id: compute_fromreg_bilinear_weigaddr.pro 202 2007-01-12 11:00:06Z smasson $ 
    258260</div> 
    259261          <h4>History</h4><div class="preformat"> 

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

    r200 r203  
    110110         
    111111          <p class="header"> 
    112             compute_fromreg_imoms3_weigaddr<span class="result">, <a href="#_compute_fromreg_imoms3_weigaddr_param_alonin">alonin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_alatin">alatin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_olonin">olonin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_olat">olat</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_weig">weig</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_addr">addr</a></span>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_NONORTHERNLINE">NONORTHERNLINE</a>=<span class="result">NONORTHERNLINE</span>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<span class="result">NOSOUTHERNLINE</span></p> 
     112            compute_fromreg_imoms3_weigaddr<span class="result">, <a href="#_compute_fromreg_imoms3_weigaddr_param_alonin">alonin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_alatin">alatin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_olonin">olonin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_olat">olat</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_weig">weig</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_addr">addr</a></span>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_NONORTHERNLINE">NONORTHERNLINE</a>=<span class="result">scalar 0 or 1</span>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<span class="result">scalar 0 or 1</span></p> 
    113113         
    114114          <div class="comments"> 
    … …  
    127127              <span class="attr">required</span> 
    128128               
    129                
     129              <span class="attr">type:</span> <span class="value">2d array</span> 
    130130               
    131131               
    … …  
    142142              <span class="attr">required</span> 
    143143               
    144                
     144              <span class="attr">type:</span> <span class="value">2d array</span> 
    145145               
    146146               
    … …  
    157157              <span class="attr">required</span> 
    158158               
    159                
    160                
    161                
    162             </h4> 
    163          
    164           <div class="comments"> 
    165  longitude of the output data</div> 
     159              <span class="attr">type:</span> <span class="value">2d array</span> 
     160               
     161               
     162            </h4> 
     163         
     164          <div class="comments"> 
     165 longitude of the output data 
     166</div> 
    166167             
    167168            <h4 id="_compute_fromreg_imoms3_weigaddr_param_olat">olat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    171172              <span class="attr">required</span> 
    172173               
    173                
     174              <span class="attr">type:</span> <span class="value">2d array</span> 
    174175               
    175176               
    … …  
    186187               
    187188               
    188                
    189                
    190                
    191             </h4> 
    192          
    193           <div class="comments"></div> 
     189              <span class="attr">type:</span> <span class="value">2d array</span> 
     190               
     191               
     192            </h4> 
     193         
     194          <div class="comments"> 
     195 (see ADDR) 
     196</div> 
    194197             
    195198            <h4 id="_compute_fromreg_imoms3_weigaddr_param_addr">addr&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    199202               
    200203               
    201                
     204              <span class="attr">type:</span> <span class="value">2d array</span> 
    202205               
    203206               
    … …  
    224227               
    225228               
    226                
    227                
    228                
    229             </h4> 
    230          
    231             <div class="comments"></div> 
     229              <span class="attr">type:</span> <span class="value">scalar 0 or 1</span> 
     230              <span class="attr">default:</span> <span class="value">0</span> 
     231               
     232            </h4> 
     233         
     234            <div class="comments"> 
     235 put 1 if you don't want to take into 
     236 account the northen line of the input data when performing the interpolation. 
     237</div> 
    232238             
    233239            <h4 id="_compute_fromreg_imoms3_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    237243               
    238244               
    239                
    240                
     245              <span class="attr">type:</span> <span class="value">scalar 0 or 1</span> 
     246              <span class="attr">default:</span> <span class="value">0</span> 
    241247               
    242248            </h4> 
    243249         
    244250            <div class="comments"> 
    245  activate if you don't want to take into account the northen/southern line 
    246  of the input data when performing the interpolation. 
     251 put 1 if you don't want to take into 
     252 account the southern line of the input data when performing the interpolation. 
    247253</div> 
    248254             
    … …  
    252258          <h3>Version history</h3> 
    253259           
    254           <h4>Version</h4><div class="preformat"> $Id: compute_fromreg_imoms3_weigaddr.pro 163 2006-08-29 12:59:46Z navarro $ 
     260          <h4>Version</h4><div class="preformat"> $Id: compute_fromreg_imoms3_weigaddr.pro 202 2007-01-12 11:00:06Z smasson $ 
    255261</div> 
    256262          <h4>History</h4><div class="preformat"> 

  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/dir-files.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_html_output/Interpolation/directory-overview.html

    r200 r203  
    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 (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.</dd> 
     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> 
     114       
     115        <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> 
    114117       
    115118        <dt><a href="fromirr.html">fromirr.pro</a></dt> 

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

    r200 r203  
    7272<div id="secondary_navbar"> 
    7373 
    74 <a href="cutsegment.html">&lt;&lt;prev file</a> | <a href="fromirr.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="extrapolate.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a> 
     74<a href="cutsegment.html">&lt;&lt;prev file</a> | <a href="extrapsmooth.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="extrapolate.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a> 
    7575 
    7676</div> 
    … …  
    8888 
    8989      <div id="file_comments"> 
    90  extrapolate data (zinput) where maskinput eq 0 by filling 
    91  step by step the coastline points with the mean value of the 8 neighbourgs. 
     90 extrapolate data (zinput) where maskinput eq 0 by filling step by  
     91 step the coastline points with the mean value of the 8 neighbourgs 
     92 (weighted by their mask value). 
    9293</div> 
    9394 
    … …  
    110111         
    111112          <p class="header"> 
    112             <span class="result">result = </span>extrapolate(<span class="result"><a href="#_extrapolate_param_zinput">zinput</a>, <a href="#_extrapolate_param_maskinput">maskinput</a>[, <a href="#_extrapolate_param_nb_iteration">nb_iteration</a>]</span>, <a href="#_extrapolate_keyword_x_periodic">x_periodic</a>=<span class="result">x_periodic</span>, <a href="#_extrapolate_keyword_MINVAL">MINVAL</a>=<span class="result">MINVAL</span>, <a href="#_extrapolate_keyword_MAXVAL">MAXVAL</a>=<span class="result">MAXVAL</span>, <a href="#_extrapolate_keyword_GE0">GE0</a>=<span class="result">GE0</span>)</p> 
     113            <span class="result">result = </span>extrapolate(<span class="result"><a href="#_extrapolate_param_zinput">zinput</a>, <a href="#_extrapolate_param_maskinput">maskinput</a>[, <a href="#_extrapolate_param_nb_iteration">nb_iteration</a>]</span>, <a href="#_extrapolate_keyword_x_periodic">x_periodic</a>=<span class="result">scalar, 0 or 1</span>, <a href="#_extrapolate_keyword_MINVAL">MINVAL</a>=<span class="result">scalar</span>, <a href="#_extrapolate_keyword_MAXVAL">MAXVAL</a>=<span class="result">scalar</span>, <a href="#_extrapolate_keyword_GE0">GE0</a>=<span class="result">scalar 0 or 1</span>)</p> 
    113114         
    114115          <div class="comments"></div> 
    115116 
    116            
     117          <h3>Return value</h3><div class="preformat"> {type=2d array} 
     118 the extrapolated array 
     119</div> 
    117120 
    118121           
    … …  
    126129              <span class="attr">required</span> 
    127130               
    128                
     131              <span class="attr">type:</span> <span class="value">2d array</span> 
    129132               
    130133               
    … …  
    141144              <span class="attr">required</span> 
    142145               
    143                
     146              <span class="attr">type:</span> <span class="value">2d array or -1</span> 
    144147               
    145148               
    … …  
    147150         
    148151          <div class="comments"> 
     152 a 2D array, the land-sea mask of the output data (1 on ocean, 0 on land) 
     153 put -1 if input data are not masked 
    149154</div> 
    150155             
    … …  
    155160               
    156161               
    157                
    158                
     162              <span class="attr">type:</span> <span class="value">integer scalar</span> 
     163              <span class="attr">default:</span> <span class="value">10.E20</span> 
    159164               
    160165            </h4> 
    161166         
    162167          <div class="comments"> 
    163  number of iteration 
     168 Maximum number if iterations done in the extrapolation process. If there 
     169 is no more masked values we exit extrapolate before reaching nb_iteration 
     170 (to be sure to fill everything, you can use a very large value) 
    164171</div> 
    165172             
    … …  
    177184               
    178185               
    179                
    180                
    181                
    182             </h4> 
    183          
    184             <div class="comments"></div> 
     186              <span class="attr">type:</span> <span class="value">scalar, 0 or 1</span> 
     187              <span class="attr">default:</span> <span class="value">0</span> 
     188               
     189            </h4> 
     190         
     191            <div class="comments"> 
     192 put 1 to specify that the data are periodic along x axis 
     193</div> 
    185194             
    186195            <h4 id="_extrapolate_keyword_MINVAL">MINVAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    190199               
    191200               
    192                
    193                
    194                
    195             </h4> 
    196          
    197             <div class="comments"></div> 
     201              <span class="attr">type:</span> <span class="value">scalar</span> 
     202              <span class="attr">default:</span> <span class="value">not used</span> 
     203               
     204            </h4> 
     205         
     206            <div class="comments"> 
     207 to specify a minimum value to the extrapolated values 
     208</div> 
    198209             
    199210            <h4 id="_extrapolate_keyword_MAXVAL">MAXVAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    203214               
    204215               
    205                
    206                
    207                
    208             </h4> 
    209          
    210             <div class="comments"></div> 
     216              <span class="attr">type:</span> <span class="value">scalar</span> 
     217              <span class="attr">default:</span> <span class="value">not used</span> 
     218               
     219            </h4> 
     220         
     221            <div class="comments"> 
     222 to specify a maximum value to the extrapolated values 
     223</div> 
    211224             
    212225            <h4 id="_extrapolate_keyword_GE0">GE0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    216229               
    217230               
    218                
    219                
    220                
    221             </h4> 
    222          
    223             <div class="comments"> 
    224 </div> 
    225              
    226            
    227  
    228            
     231              <span class="attr">type:</span> <span class="value">scalar 0 or 1</span> 
     232              <span class="attr">default:</span> <span class="value">0</span> 
     233               
     234            </h4> 
     235         
     236            <div class="comments"> 
     237 put 1 to force the extrapolated values to be larger than 0, same as using minval=0. 
     238</div> 
     239             
     240           
     241 
     242          <h3>Examples</h3><div class="preformat"> 
     243 IDL> a=extrapolate(dist(jpi,jpj),tmask[*,*,0],/x_periodic) 
     244 IDL> tvplus, a 
     245 IDL> tvplus, a*(1-tmask[*,*,0]) 
     246 get the coastline: 
     247 IDL> a=extrapolate(tmask[*,*,0],tmask[*,*,0],1,/x_periodic) 
     248 IDL> tvplus, a-tmask[*,*,0] 
     249</div> 
    229250          <h3>Version history</h3> 
    230251           
    231           <h4>Version</h4><div class="preformat"> $Id: extrapolate.pro 199 2006-12-13 07:47:14Z smasson $ 
    232 </div> 
    233            
     252          <h4>Version</h4><div class="preformat"> $Id: extrapolate.pro 202 2007-01-12 11:00:06Z smasson $ 
     253</div> 
     254          <h4>History</h4><div class="preformat"> 
     255  Originaly written by G. Roulet 
     256  Sebastien Masson (smasson@lodyc.jussieu.fr) 
     257</div> 
    234258           
    235259           
    … …  
    250274          <h3>Statistics</h3> 
    251275          <table class="statistics"> 
    252             <tr><td>McCabe cyclic</td><td>          11</td></tr> 
     276            <tr><td>McCabe cyclic</td><td>          13</td></tr> 
    253277            <tr><td>McCabe essential</td><td>           1</td></tr> 
    254278            <tr><td>McCabe modular design</td><td>           1</td></tr> 

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

    r200 r203  
    7272<div id="secondary_navbar"> 
    7373 
    74 <a href="extrapolate.html">&lt;&lt;prev file</a> | <a href="fromreg.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="fromirr.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a> 
     74<a href="extrapsmooth.html">&lt;&lt;prev file</a> | <a href="fromreg.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="fromirr.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a> 
    7575 
    7676</div> 
    … …  
    189189               
    190190               
    191               <span class="attr">type:</span> <span class="value">2d array</span> 
     191              <span class="attr">type:</span> <span class="value">2d array or -1</span> 
    192192               
    193193               
    … …  
    196196          <div class="comments"> 
    197197 a 2D array, the land-sea mask of the input data (1 on ocean, 0 on land) 
     198 put -1 if input data are not masked 
    198199</div> 
    199200             
    … …  
    234235              <span class="attr">required</span> 
    235236               
    236               <span class="attr">type:</span> <span class="value">2d array</span> 
     237              <span class="attr">type:</span> <span class="value">2d array or -1</span> 
    237238               
    238239               
    … …  
    241242          <div class="comments"> 
    242243 a 2D array, the land-sea mask of the output data (1 on ocean, 0 on land) 
     244 put -1 if output data are not masked 
    243245</div> 
    244246             
    … …  
    302304          <h3>Version history</h3> 
    303305           
    304           <h4>Version</h4><div class="preformat"> $Id: fromirr.pro 163 2006-08-29 12:59:46Z navarro $ 
     306          <h4>Version</h4><div class="preformat"> $Id: fromirr.pro 202 2007-01-12 11:00:06Z smasson $ 
    305307</div> 
    306308          <h4>History</h4><div class="preformat"> 
Note: See TracChangeset for help on using the changeset viewer.