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

    r89 r101  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> 
     90find the closetest point of (P0) within a list of np1 points 
     91P1 Which can be on a sphere  
     92</div> 
    9093 
    9194       
     
    102105        <div class="routine_details" id="_neighbor"> 
    103106 
    104           <h2><a class="top" href="#container">top</a>neighbor </h2> 
     107          <h2><a class="top" href="#container">top</a>neighbor <span class="categories"> Maps 
     108</span></h2> 
    105109         
    106110          <p class="header"> 
     
    108112         
    109113          <div class="comments"> 
    110  NAME: 
    111         neighbor 
    112  
    113  PURPOSE: 
    114         find the closetest point of (P0) within a list of np1 points 
    115         P1 Which can be on a sphere  
    116  
    117  CATEGORY: 
    118         Maps. 
    119  
    120  CALLING SEQUENCE: 
    121         Result = neighbor(lon0, lat0, lon1, lat1) 
    122  
    123  INPUTS: 
    124         Lon0, Lat0 = scalar. longitudes and latitudes of point P0.  
    125         Lon1, Lat1 = np1 elements vector. longitude and latitude of 
    126         np1 points P1  
    127  
    128  KEYWORD PARAMETERS: 
    129    RADIANS = if set, inputs and angular outputs are in radians, otherwise 
    130         degrees. 
    131    DISTANCE = dis, to get back the distances between P0 and the np1 
    132    points P1 in the variable dis. 
    133    /SPHERE to activate if points are located on a sphere. 
    134  
    135  OUTPUTS: 
     114</div> 
     115 
     116          <h3>Return value</h3><div class="value"> 
    136117       index giving the P1[index] point that is the closetest point 
    137118       of (P0) 
    138  
    139  EXAMPLES: 
     119</div> 
     120 
     121           
     122            <h3>Parameters</h3> 
     123         
     124             
     125            <h4 id="_neighbor_param_p0lon">p0lon&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">  scalar. longitudes of point P0. </div> 
     137             
     138            <h4 id="_neighbor_param_p0lat">p0lat&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">  scalar. latitudes of point P0.  
     150</div> 
     151             
     152            <h4 id="_neighbor_param_neighlon">neighlon&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     153               
     154               
     155               
     156               
     157               
     158               
     159               
     160               
     161            </h4> 
     162         
     163          <div class="comments"></div> 
     164             
     165            <h4 id="_neighbor_param_neighlat">neighlat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     166               
     167               
     168               
     169               
     170               
     171               
     172               
     173               
     174            </h4> 
     175         
     176          <div class="comments"></div> 
     177             
     178 
     179           
     180 
     181           
     182 
     183            <h3>Keywords</h3> 
     184             
     185            <h4 id="_neighbor_keyword_sphere">sphere&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     186               
     187               
     188               
     189               
     190               
     191               
     192               
     193               
     194            </h4> 
     195         
     196            <div class="comments"> to activate if points are located on a sphere. 
     197</div> 
     198             
     199            <h4 id="_neighbor_keyword_distance">distance&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     200               
     201               
     202               
     203               
     204               
     205               
     206               
     207               
     208            </h4> 
     209         
     210            <div class="comments"> dis, to get back the distances between P0 and the np1 
     211   points P1 in the variable dis.</div> 
     212             
     213            <h4 id="_neighbor_keyword_radians">radians&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     214               
     215               
     216               
     217               
     218               
     219               
     220               
     221               
     222            </h4> 
     223         
     224            <div class="comments"> if set, inputs and angular outputs are in radians, otherwise 
     225degrees.</div> 
     226             
     227           
     228 
     229          <h3>Examples</h3><div class="value">  
     230 IDL> Result = neighbor(lon0, lat0, lon1, lat1) 
     231 
     232 
    140233       IDL> print, neighbor(-105.15,40.02,[-0.07,100,50],[51.30,20,0], $ 
    141234            distance=dis) 
     
    143236       IDL> print, dis 
    144237             105.684      206.125      160.228 
    145  
    146  MODIFICATION HISTORY:</div> 
    147  
    148            
    149  
    150            
    151             <h3>Parameters</h3> 
    152          
    153              
    154             <h4 id="_neighbor_param_p0lon">p0lon&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    155                
    156                
    157                
    158                
    159                
    160                
    161                
    162                
    163             </h4> 
    164          
    165           <div class="comments"></div> 
    166              
    167             <h4 id="_neighbor_param_p0lat">p0lat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    168                
    169                
    170                
    171                
    172                
    173                
    174                
    175                
    176             </h4> 
    177          
    178           <div class="comments"></div> 
    179              
    180             <h4 id="_neighbor_param_neighlon">neighlon&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    181                
    182                
    183                
    184                
    185                
    186                
    187                
    188                
    189             </h4> 
    190          
    191           <div class="comments"></div> 
    192              
    193             <h4 id="_neighbor_param_neighlat">neighlat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    194                
    195                
    196                
    197                
    198                
    199                
    200                
    201                
    202             </h4> 
    203          
    204           <div class="comments"></div> 
    205              
    206  
    207            
    208  
    209            
    210  
    211             <h3>Keywords</h3> 
    212              
    213             <h4 id="_neighbor_keyword_sphere">sphere&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    214                
    215                
    216                
    217                
    218                
    219                
    220                
    221                
    222             </h4> 
    223          
    224             <div class="comments"></div> 
    225              
    226             <h4 id="_neighbor_keyword_distance">distance&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    227                
    228                
    229                
    230                
    231                
    232                
    233                
    234                
    235             </h4> 
    236          
    237             <div class="comments"></div> 
    238              
    239             <h4 id="_neighbor_keyword_radians">radians&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    240                
    241                
    242                
    243                
    244                
    245                
    246                
    247                
    248             </h4> 
    249          
    250             <div class="comments"></div> 
    251              
    252            
    253  
    254            
    255            
    256            
    257            
    258            
     238</div> 
     239          <h3>Version history</h3> 
     240           
     241           
     242          <h4>History</h4><div class="value"> 
     243 Sebastien Masson (smasson@lodyc.jussieu.fr) 
     244                  October 2003</div> 
    259245           
    260246           
Note: See TracChangeset for help on using the changeset viewer.