Ignore:
Timestamp:
06/12/06 10:29:56 (18 years ago)
Author:
pinsard
Message:

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

File:
1 edited

Legend:

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

    r89 r101  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> compute the weight and address neede to interpolate data from a 
     90          "regular grid" to any grid using the bilinear method 
     91   </div> 
    9092 
    9193       
     
    102104        <div class="routine_details" id="_compute_fromreg_bilinear_weigaddr"> 
    103105 
    104           <h2><a class="top" href="#container">top</a>compute_fromreg_bilinear_weigaddr </h2> 
     106          <h2><a class="top" href="#container">top</a>compute_fromreg_bilinear_weigaddr <span class="categories"> interpolation 
     107</span></h2> 
    105108         
    106109          <p class="header"> 
    107110            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> 
    108111         
    109           <div class="comments"> 
    110  NAME: compute_fromreg_bilinear_weigaddr 
    111  
    112  PURPOSE: compute the weight and address neede to interpolate data from a 
    113           "regular grid" to any grid using the bilinear method 
    114     
    115  CATEGORY:interpolation 
    116  
    117  CALLING SEQUENCE:  
    118      compute_fromreg_bilinear_weigaddr, alon, alat, olon, olat, weig, addr 
    119  
    120  INPUTS: 
    121      lonin and latin: longitude/latitude of the input data  
    122      lonout and latout: longitude/latitude of the output data  
    123  
    124  KEYWORD PARAMETERS:  
    125  
    126      /NONORTHERNLINE and /NOSOUTHERNLINE: activate if you don't whant to take into 
    127           account the northen/southern line of the input data when perfoming the 
    128           interpolation. 
    129  
    130  OUTPUTS:  
     112          <div class="comments"></div> 
     113 
     114          <h3>Return value</h3><div class="value">  
    131115     weig, addr: 2D arrays, weig and addr are the weight and addresses used to 
    132116     perform the interpolation: 
    133117          dataout = total(weig*datain[addr], 1) 
    134118          dataout = reform(dataout, jpio, jpjo, /over) 
    135  
    136  COMMON BLOCKS: none 
    137  
    138  SIDE EFFECTS: ? 
    139  
    140  RESTRICTIONS: 
     119</div> 
     120 
     121           
     122            <h3>Parameters</h3> 
     123         
     124             
     125            <h4 id="_compute_fromreg_bilinear_weigaddr_param_alonin">alonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     126              <span class="attr">in</span> 
     127               
     128               
     129              <span class="attr">required</span> 
     130               
     131               
     132               
     133               
     134            </h4> 
     135         
     136          <div class="comments"> longitudeof the input data </div> 
     137             
     138            <h4 id="_compute_fromreg_bilinear_weigaddr_param_alatin">alatin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     139              <span class="attr">in</span> 
     140               
     141               
     142              <span class="attr">required</span> 
     143               
     144               
     145               
     146               
     147            </h4> 
     148         
     149          <div class="comments"> latitude of the input data </div> 
     150             
     151            <h4 id="_compute_fromreg_bilinear_weigaddr_param_olonin">olonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     152              <span class="attr">in</span> 
     153               
     154               
     155              <span class="attr">required</span> 
     156               
     157               
     158               
     159               
     160            </h4> 
     161         
     162          <div class="comments"> longitude of the output data </div> 
     163             
     164            <h4 id="_compute_fromreg_bilinear_weigaddr_param_olat">olat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     165              <span class="attr">in</span> 
     166               
     167               
     168              <span class="attr">required</span> 
     169               
     170               
     171               
     172               
     173            </h4> 
     174         
     175          <div class="comments"> latitude of the output data  
     176</div> 
     177             
     178            <h4 id="_compute_fromreg_bilinear_weigaddr_param_weig">weig&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     179               
     180               
     181               
     182               
     183               
     184               
     185               
     186               
     187            </h4> 
     188         
     189          <div class="comments"></div> 
     190             
     191            <h4 id="_compute_fromreg_bilinear_weigaddr_param_addr">addr&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     192               
     193               
     194               
     195               
     196               
     197               
     198               
     199               
     200            </h4> 
     201         
     202          <div class="comments"></div> 
     203             
     204 
     205           
     206 
     207           
     208 
     209            <h3>Keywords</h3> 
     210             
     211            <h4 id="_compute_fromreg_bilinear_weigaddr_keyword_NONORTHERNLINE">NONORTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     212               
     213               
     214               
     215               
     216               
     217               
     218               
     219               
     220            </h4> 
     221         
     222            <div class="comments"> activate if you don't whant to take into 
     223          account the northen line of the input data when perfoming the</div> 
     224             
     225            <h4 id="_compute_fromreg_bilinear_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     226               
     227               
     228               
     229               
     230               
     231               
     232               
     233               
     234            </h4> 
     235         
     236            <div class="comments"> activate if you don't whant to take into 
     237          account the southern line of the input data when perfoming the 
     238          interpolation. 
     239</div> 
     240             
     241           
     242 
     243           
     244          <h3>Version history</h3> 
     245           
     246           
     247          <h4>History</h4><div class="value"></div> 
     248           
     249           
     250          <h3>Known issues</h3> 
     251           
     252           
     253           
     254          <h4>Restrictions</h4><div class="value"> 
    141255  -  the input grid must be a "regular grid", defined as a grid for which each 
    142256     lontitudes lines have the same latitude and each latitudes columns have the 
     
    146260  -  points located out of the southern and northern boundaries are interpolated 
    147261     using a linear interpolation only along the longitudinal direction. 
    148   
    149  EXAMPLE:  
    150  
    151  MODIFICATION HISTORY:</div> 
    152  
    153            
    154  
    155            
    156             <h3>Parameters</h3> 
    157          
    158              
    159             <h4 id="_compute_fromreg_bilinear_weigaddr_param_alonin">alonin&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_bilinear_weigaddr_param_alatin">alatin&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_bilinear_weigaddr_param_olonin">olonin&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_bilinear_weigaddr_param_olat">olat&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_bilinear_weigaddr_param_weig">weig&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_bilinear_weigaddr_param_addr">addr&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  
    238            
    239  
    240            
    241  
    242             <h3>Keywords</h3> 
    243              
    244             <h4 id="_compute_fromreg_bilinear_weigaddr_keyword_NONORTHERNLINE">NONORTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    245                
    246                
    247                
    248                
    249                
    250                
    251                
    252                
    253             </h4> 
    254          
    255             <div class="comments"></div> 
    256              
    257             <h4 id="_compute_fromreg_bilinear_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    258                
    259                
    260                
    261                
    262                
    263                
    264                
    265                
    266             </h4> 
    267          
    268             <div class="comments"></div> 
    269              
    270            
    271  
    272            
    273            
    274            
    275            
    276            
    277            
    278            
    279            
    280            
    281            
    282            
    283            
     262 </div> 
    284263         
    285264           
Note: See TracChangeset for help on using the changeset viewer.