Ignore:
Timestamp:
06/12/06 16:49:30 (18 years ago)
Author:
pinsard
Message:

start to modify headers of ReadWrite? *.pro files for better idldoc output

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/compute_fromreg_imoms3_weigaddr.html

    r104 r106  
    104104        <div class="routine_details" id="_compute_fromreg_imoms3_weigaddr"> 
    105105 
    106           <h2><a class="top" href="#container">top</a>compute_fromreg_imoms3_weigaddr <span class="categories"> interpolation</span></h2> 
     106          <h2><a class="top" href="#container">top</a>compute_fromreg_imoms3_weigaddr <span class="categories"> interpolation 
     107</span></h2> 
    107108         
    108109          <p class="header"> 
    109             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  PRO compute_fromreg_imoms3_weigaddr">addr  PRO compute_fromreg_imoms3_weigaddr</a>, <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> 
     110            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> 
    110111         
    111112          <div class="comments"> 
    112113</div> 
    113114 
    114            
     115          <h3>Return value</h3><div class="value">  
     116     weig, addr: 2D arrays, weig and addr are the weight and addresses used to 
     117     perform the interpolation: 
     118          dataout = total(weig*datain[addr], 1) 
     119          dataout = reform(dataout, jpio, jpjo, /over) 
     120</div> 
    115121 
    116122           
     
    119125             
    120126            <h4 id="_compute_fromreg_imoms3_weigaddr_param_alonin">alonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     127              <span class="attr">in</span> 
     128               
     129               
     130              <span class="attr">required</span> 
     131               
     132               
     133               
     134               
     135            </h4> 
     136         
     137          <div class="comments"> longitude of the input data </div> 
     138             
     139            <h4 id="_compute_fromreg_imoms3_weigaddr_param_alatin">alatin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     140              <span class="attr">in</span> 
     141               
     142               
     143              <span class="attr">required</span> 
     144               
     145               
     146               
     147               
     148            </h4> 
     149         
     150          <div class="comments"> latitude of the input data </div> 
     151             
     152            <h4 id="_compute_fromreg_imoms3_weigaddr_param_olonin">olonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     153              <span class="attr">in</span> 
     154               
     155               
     156              <span class="attr">required</span> 
     157               
     158               
     159               
     160               
     161            </h4> 
     162         
     163          <div class="comments"> longitude of the output data </div> 
     164             
     165            <h4 id="_compute_fromreg_imoms3_weigaddr_param_olat">olat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     166              <span class="attr">in</span> 
     167               
     168               
     169              <span class="attr">required</span> 
     170               
     171               
     172               
     173               
     174            </h4> 
     175         
     176          <div class="comments"> latitude of the output data  
     177</div> 
     178             
     179            <h4 id="_compute_fromreg_imoms3_weigaddr_param_weig">weig&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    121180               
    122181               
     
    131190          <div class="comments"></div> 
    132191             
    133             <h4 id="_compute_fromreg_imoms3_weigaddr_param_alatin">alatin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     192            <h4 id="_compute_fromreg_imoms3_weigaddr_param_addr">addr&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    134193               
    135194               
     
    144203          <div class="comments"></div> 
    145204             
    146             <h4 id="_compute_fromreg_imoms3_weigaddr_param_olonin">olonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    147                
    148                
    149                
    150                
    151                
    152                
    153                
    154                
    155             </h4> 
    156          
    157           <div class="comments"></div> 
    158              
    159             <h4 id="_compute_fromreg_imoms3_weigaddr_param_olat">olat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    160                
    161                
    162                
    163                
    164                
    165                
    166                
    167                
    168             </h4> 
    169          
    170           <div class="comments"></div> 
    171              
    172             <h4 id="_compute_fromreg_imoms3_weigaddr_param_weig">weig&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    173                
    174                
    175                
    176                
    177                
    178                
    179                
    180                
    181             </h4> 
    182          
    183           <div class="comments"></div> 
    184              
    185             <h4 id="_compute_fromreg_imoms3_weigaddr_param_addr  PRO compute_fromreg_imoms3_weigaddr">addr  PRO compute_fromreg_imoms3_weigaddr&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    186                
    187                
    188                
    189                
    190                
    191                
    192                
    193                
    194             </h4> 
    195          
    196           <div class="comments"></div> 
    197              
    198             <h4 id="_compute_fromreg_imoms3_weigaddr_param_alonin">alonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    199                
    200                
    201                
    202                
    203                
    204                
    205                
    206                
    207             </h4> 
    208          
    209           <div class="comments"></div> 
    210              
    211             <h4 id="_compute_fromreg_imoms3_weigaddr_param_alatin">alatin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    212                
    213                
    214                
    215                
    216                
    217                
    218                
    219                
    220             </h4> 
    221          
    222           <div class="comments"></div> 
    223              
    224             <h4 id="_compute_fromreg_imoms3_weigaddr_param_olonin">olonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    225                
    226                
    227                
    228                
    229                
    230                
    231                
    232                
    233             </h4> 
    234          
    235           <div class="comments"></div> 
    236              
    237             <h4 id="_compute_fromreg_imoms3_weigaddr_param_olat">olat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    238                
    239                
    240                
    241                
    242                
    243                
    244                
    245                
    246             </h4> 
    247          
    248           <div class="comments"></div> 
    249              
    250             <h4 id="_compute_fromreg_imoms3_weigaddr_param_weig">weig&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    251                
    252                
    253                
    254                
    255                
    256                
    257                
    258                
    259             </h4> 
    260          
    261           <div class="comments"></div> 
    262              
    263             <h4 id="_compute_fromreg_imoms3_weigaddr_param_addr">addr&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    264                
    265                
    266                
    267                
    268                
    269                
    270                
    271                
    272             </h4> 
    273          
    274           <div class="comments"></div> 
    275              
    276205 
    277206           
     
    292221            </h4> 
    293222         
     223            <div class="comments"> and /NOSOUTHERNLINE activate if you don't whant to take into 
     224          account the northen/southern line of the input data when perfoming the 
     225          interpolation. 
     226</div> 
     227             
     228            <h4 id="_compute_fromreg_imoms3_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     229               
     230               
     231               
     232               
     233               
     234               
     235               
     236               
     237            </h4> 
     238         
    294239            <div class="comments"></div> 
    295240             
    296             <h4 id="_compute_fromreg_imoms3_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    297                
    298                
    299                
    300                
    301                
    302                
    303                
    304                
    305             </h4> 
    306          
    307             <div class="comments"></div> 
    308              
    309            
    310  
    311            
    312            
    313            
    314            
    315            
    316            
    317            
    318            
    319            
    320            
    321            
    322            
     241           
     242 
     243           
     244          <h3>Version history</h3> 
     245           
     246           
     247          <h4>History</h4><div class="value"> 
     248  November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr)  
     249  March 2006: works for rectangular grids</div> 
     250           
     251           
     252          <h3>Known issues</h3> 
     253           
     254           
     255           
     256          <h4>Restrictions</h4><div class="value"> 
     257  -  the input grid must be a "regular/rectangular grid", defined as a grid for 
     258     which each lontitudes lines have the same latitude and each latitudes columns 
     259     have the same longitude. 
     260  -  We supposed the data are located on a sphere, with a periodicity along 
     261     the longitude. 
     262  -  points located between the first/last 2 lines are interpolated 
     263     using a imoms3 interpolation along the longitudinal direction and linear 
     264     interpolation along the latitudinal direction 
     265  -  points located out of the southern and northern boundaries are interpolated 
     266     using a imoms3 interpolation only along the longitudinal direction. 
     267 </div> 
    323268         
    324269           
Note: See TracChangeset for help on using the changeset viewer.