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/inrecgrid.html

    r89 r101  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> given - a list of points, (x,y) position   
     90                - the x and y limits of a rectangular grid 
     91          find in which cell is located each given point. 
     92</div> 
    9093 
    9194       
     
    102105        <div class="routine_details" id="_inrecgrid"> 
    103106 
    104           <h2><a class="top" href="#container">top</a>inrecgrid </h2> 
     107          <h2><a class="top" href="#container">top</a>inrecgrid <span class="categories"> no DO loop, use the wonderfull value_locate function! 
     108</span></h2> 
    105109         
    106110          <p class="header"> 
     
    108112         
    109113          <div class="comments"> 
    110  NAME: inrecgrid 
    111  
    112  PURPOSE: given - a list of points, (x,y) position   
    113                 - the x and y limits of a rectangular grid 
    114           find in which cell is located each given point. 
    115  
    116  CATEGORY: no DO loop, use the wonderfull value_locate function! 
    117  
    118  CALLING SEQUENCE:res = inrecgrid(xin, yin, left, bottom) 
    119  
    120  INPUTS:  
    121  
    122     x1d: a 1d array, the x position on the points 
    123     y1d: a 1d array, the y position on the points 
    124     left: a 1d, monotonically increasing array, the position of the 
    125     "left" border of each cell. 
    126     bottom: a 1d, monotonically increasing array, the position of the 
     114</div> 
     115 
     116          <h3>Return value</h3><div class="value"> the index on the cell accoring to the 2d array defined by 
     117 left and bottom. 
     118</div> 
     119 
     120           
     121            <h3>Parameters</h3> 
     122         
     123             
     124            <h4 id="_inrecgrid_param_x1d">x1d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     125              <span class="attr">in</span> 
     126               
     127               
     128              <span class="attr">required</span> 
     129               
     130               
     131               
     132               
     133            </h4> 
     134         
     135          <div class="comments">  a 1d array, the x position on the points</div> 
     136             
     137            <h4 id="_inrecgrid_param_y1d">y1d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     138              <span class="attr">in</span> 
     139               
     140               
     141              <span class="attr">required</span> 
     142               
     143               
     144               
     145               
     146            </h4> 
     147         
     148          <div class="comments">  a 1d, monotonically increasing array, the position of the 
     149    "left" border of each cell.</div> 
     150             
     151            <h4 id="_inrecgrid_param_left">left&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     152               
     153               
     154               
     155               
     156               
     157               
     158               
     159               
     160            </h4> 
     161         
     162          <div class="comments"></div> 
     163             
     164            <h4 id="_inrecgrid_param_bottom">bottom&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">  a 1d, monotonically increasing array, the position of the 
    127176    "bottom" border of each cell. 
    128177 
    129  OPTIONAL INPUTS: 
    130  
    131  KEYWORD PARAMETERS:; 
    132  
    133     /output2d: to get the output as a 2d array (2,n_elements(x1d)), 
     178</div> 
     179             
     180 
     181           
     182 
     183           
     184 
     185            <h3>Keywords</h3> 
     186             
     187            <h4 id="_inrecgrid_keyword_output2d">output2d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     188               
     189               
     190               
     191               
     192               
     193               
     194               
     195               
     196            </h4> 
     197         
     198            <div class="comments"> to get the output as a 2d array (2,n_elements(x1d)), 
    134199    with res[0,*] the x index accoring to the 1d array defined by 
    135200    left and res[1,*] the y index accoring to the 1d array defined by 
    136201    bottom. 
    137  
    138     checkout=[rbgrid,ubgrid] specify the right and upper bondaries of 
     202</div> 
     203             
     204            <h4 id="_inrecgrid_keyword_checkout">checkout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     205               
     206               
     207               
     208               
     209               
     210               
     211               
     212               
     213            </h4> 
     214         
     215            <div class="comments">=[rbgrid,ubgrid] specify the right and upper bondaries of 
    139216    the grid and check if some points are out. 
    140  
    141  OUTPUTS:the index on the cell accoring to the 2d array defined by 
    142  left and bottom. 
    143  
    144  OPTIONAL OUTPUTS: 
    145  
    146  COMMON BLOCKS: no 
    147  
    148  SIDE EFFECTS: 
    149  
    150  RESTRICTIONS: 
    151  
    152  PROCEDURE: 
    153  
    154  EXAMPLE: 
     217</div> 
     218             
     219           
     220 
     221          <h3>Examples</h3><div class="value">  
     222 res = inrecgrid(xin, yin, left, bottom) 
     223 
     224  
    155225 
    156226  IDL> a=indgen(5) 
     
    164234        3.00000      2.00000 
    165235        2.00000      1.00000 
    166    
    167  MODIFICATION HISTORY:</div> 
    168  
    169            
    170  
    171            
    172             <h3>Parameters</h3> 
    173          
    174              
    175             <h4 id="_inrecgrid_param_x1d">x1d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    176                
    177                
    178                
    179                
    180                
    181                
    182                
    183                
    184             </h4> 
    185          
    186           <div class="comments"></div> 
    187              
    188             <h4 id="_inrecgrid_param_y1d">y1d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    189                
    190                
    191                
    192                
    193                
    194                
    195                
    196                
    197             </h4> 
    198          
    199           <div class="comments"></div> 
    200              
    201             <h4 id="_inrecgrid_param_left">left&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    202                
    203                
    204                
    205                
    206                
    207                
    208                
    209                
    210             </h4> 
    211          
    212           <div class="comments"></div> 
    213              
    214             <h4 id="_inrecgrid_param_bottom">bottom&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    215                
    216                
    217                
    218                
    219                
    220                
    221                
    222                
    223             </h4> 
    224          
    225           <div class="comments"></div> 
    226              
    227  
    228            
    229  
    230            
    231  
    232             <h3>Keywords</h3> 
    233              
    234             <h4 id="_inrecgrid_keyword_output2d">output2d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    235                
    236                
    237                
    238                
    239                
    240                
    241                
    242                
    243             </h4> 
    244          
    245             <div class="comments"></div> 
    246              
    247             <h4 id="_inrecgrid_keyword_checkout">checkout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    248                
    249                
    250                
    251                
    252                
    253                
    254                
    255                
    256             </h4> 
    257          
    258             <div class="comments"></div> 
    259              
    260            
    261  
    262            
    263            
    264            
    265            
    266            
     236  </div> 
     237          <h3>Version history</h3> 
     238           
     239           
     240          <h4>History</h4><div class="value"> 
     241            S. Masson (smasson@lodyc.jussieu.fr) 
     242                      July 3rd, 2002 
     243                      October 3rd, 2003: use value_locate</div> 
    267244           
    268245           
Note: See TracChangeset for help on using the changeset viewer.