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

    r89 r101  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
    90  
    91        
    92  
    93        
    94  
    95        
    96  
    97        
    98  
    99       <div id="routine_details"> 
    100          
    101  
    102         <div class="routine_details" id="_Map_npoints"> 
    103  
    104           <h2><a class="top" href="#container">top</a>Map_npoints </h2> 
    105          
    106           <p class="header"> 
    107             <span class="result">result = </span>Map_npoints(<span class="result"><a href="#_Map_npoints_param_lon0">lon0</a>, <a href="#_Map_npoints_param_lat0">lat0</a>, <a href="#_Map_npoints_param_lon1">lon1</a>, <a href="#_Map_npoints_param_lat1">lat1</a></span>, <a href="#_Map_npoints_keyword_azimuth">azimuth</a>=<span class="result">azimuth</span>, <a href="#_Map_npoints_keyword_RADIANS">RADIANS</a>=<span class="result">RADIANS</span>, <a href="#_Map_npoints_keyword_RADIUS">RADIUS</a>=<span class="result">RADIUS</span>, <a href="#_Map_npoints_keyword_MIDDLE">MIDDLE</a>=<span class="result">MIDDLE</span>, <a href="#_Map_npoints_keyword_TWO_BY_TWO">TWO_BY_TWO</a>=<span class="result">TWO_BY_TWO</span>)</p> 
    108          
    109           <div class="comments"> 
    110  NAME: 
    111         Map_nPoints 
    112  
    113  PURPOSE: 
    114         Return the distance in meter between all np0 points P0 and all 
     89      <div id="file_comments"> 
     90Return the distance in meter between all np0 points P0 and all 
    11591       np1 points P1 on a sphere. If keyword /TWO_BY_TWO is given then 
    11692       returns the distances between number n of P0 points and number 
     
    11894       Same as map_2points with the meter parameter but for n points 
    11995       without do loop. 
    120  
    121  CATEGORY: 
    122         Maps. 
    123  
    124  CALLING SEQUENCE: 
    125         Result = Map_nPoints(lon0, lat0, lon1, lat1) 
    126  
    127  INPUTS: 
    128         Lon0, Lat0 = np0 elements vector. longitudes and latitudes of 
    129         np0 points P0  
    130         Lon1, Lat1 = np1 elements vector. longitude and latitude of 
    131         np1 points P1  
    132  
    133  KEYWORD PARAMETERS: 
    134  
    135    AZIMUTH: A named variable that will receive the azimuth of the great 
    136        circle  connecting the two points, P0 to P1 
    137    /MIDDLE: to get the longitude/latitude of the middle point betwen P0 and P1. 
    138    RADIANS = if set, inputs and angular outputs are in radians, otherwise 
    139         degrees. 
    140    RADIUS: If given, return the distance between the two points 
    141         calculated using the given radius. 
    142        Default value is the earth radius : 6378206.4d0 
    143    TWO_BY_TWO:If given,then Map_nPoints returns the distances between 
    144        number n of P0 points and number n of P1 points (in that case, 
    145        np0 and np1 must be equal). 
    146  
    147  OUTPUTS: 
     96</div> 
     97 
     98       
     99 
     100       
     101 
     102       
     103 
     104       
     105 
     106      <div id="routine_details"> 
     107         
     108 
     109        <div class="routine_details" id="_Map_npoints"> 
     110 
     111          <h2><a class="top" href="#container">top</a>Map_npoints <span class="categories"> Maps 
     112</span></h2> 
     113         
     114          <p class="header"> 
     115            <span class="result">result = </span>Map_npoints(<span class="result"><a href="#_Map_npoints_param_lon0">lon0</a>, <a href="#_Map_npoints_param_lat0">lat0</a>, <a href="#_Map_npoints_param_lon1">lon1</a>, <a href="#_Map_npoints_param_lat1">lat1</a></span>, <a href="#_Map_npoints_keyword_azimuth">azimuth</a>=<span class="result">azimuth</span>, <a href="#_Map_npoints_keyword_RADIANS">RADIANS</a>=<span class="result">RADIANS</span>, <a href="#_Map_npoints_keyword_RADIUS">RADIUS</a>=<span class="result">RADIUS</span>, <a href="#_Map_npoints_keyword_MIDDLE">MIDDLE</a>=<span class="result">MIDDLE</span>, <a href="#_Map_npoints_keyword_TWO_BY_TWO">TWO_BY_TWO</a>=<span class="result">TWO_BY_TWO</span>)</p> 
     116         
     117          <div class="comments"> 
     118</div> 
     119 
     120          <h3>Return value</h3><div class="value"> 
    148121       An (np0,np1) array giving the distance in meter between np0 
    149122       points P0 and np1 points P1. Element (i,j) of the ouput is the 
     
    153126       and P1[i] (in that case, we have np0 = np1 = np) 
    154127       if /MIDDLE see this keyword. 
    155  
    156  EXAMPLES: 
    157         IDL> print, $ 
    158         map_npoints([-105.15,1],[40.02,1],[-0.07,100,50],[51.30,20,0]) 
    159                7551369.3       5600334.8 
    160                12864354.       10921254. 
    161                14919237.       5455558.8 
    162          
    163         IDL> lon0 = [-10, 20, 100] 
    164         IDL> lat0 = [0, -10, 45] 
    165         IDL> lon1 = [10, 60, 280] 
    166         IDL> lat1 = [0, 10, 45] 
    167         IDL> dist = map_npoints(lon0, lat0, lon1, lat1, azimuth = azi) 
    168         IDL> help, dist, azi 
    169         DIST            DOUBLE    = Array[3, 3] 
    170         AZI             DOUBLE    = Array[3, 3] 
    171         IDL> print, dist[4*lindgen(3)], azi[4*lindgen(3)] 
    172                2226414.0       4957944.5       10018863. 
    173                90.000000       64.494450   4.9615627e-15 
    174         IDL> dist = map_npoints(lon0, lat0, lon1, lat1, azimuth = azi, /two_by_two) 
    175         IDL> help, dist, azi 
    176         DIST            DOUBLE    = Array[3] 
    177         AZI             DOUBLE    = Array[3] 
    178         IDL> print, dist, azi 
    179                2226414.0       4957944.5       10018863. 
    180                90.000000       64.494450   4.9615627e-15 
    181         IDL> print, map_2points(lon0[0], lat0[0], lon1[0], lat1[0]) 
    182                20.000000       90.000000 
    183         IDL> print, map_npoints(lon0[0], lat0[0], lon1[0], lat1[0], azi=azi)/6378206.4d0 / !dtor, azi 
    184                20.000000 
    185                90.000000 
    186  
    187         IDL> lon0 = [-10, 20, 100] 
    188         IDL> lat0 = [0, -10, 45] 
    189         IDL> lon1 = [10, 60, 280] 
    190         IDL> lat1 = [0, 10, 45] 
    191         IDL> mid = map_npoints(lon0, lat0, lon1, lat1, /middle, /two_by_two) 
    192         IDL> print, reform(mid[0,*]), reform(mid[1,*]) 
    193                0.0000000       40.000000       190.00000 
    194                0.0000000  -1.5902773e-15       90.000000 
    195         IDL> print, (map_2points(lon0[0], lat0[0], lon1[0], lat1[0], npath = 3))[*, 1] 
    196                0.0000000       0.0000000 
    197         IDL> print, (map_2points(lon0[1], lat0[1], lon1[1], lat1[1], npath = 3))[*, 1] 
    198                40.000000  -1.5902773e-15 
    199         IDL> print, (map_2points(lon0[2], lat0[2], lon1[2], lat1[2], npath = 3))[*, 1] 
    200                190.00000       90.000000 
    201          
    202  MODIFICATION HISTORY: 
    203        Based on the IDL function map_2points.pro,v 1.6 2001/01/15</div> 
    204  
    205            
     128</div> 
    206129 
    207130           
     
    210133             
    211134            <h4 id="_Map_npoints_param_lon0">lon0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     135              <span class="attr">in</span> 
     136               
     137               
     138              <span class="attr">required</span> 
     139               
     140               
     141               
     142               
     143            </h4> 
     144         
     145          <div class="comments"> np0 elements vector. longitudes and latitudes of np0 points P0 </div> 
     146             
     147            <h4 id="_Map_npoints_param_lat0">lat0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    212148               
    213149               
     
    222158          <div class="comments"></div> 
    223159             
    224             <h4 id="_Map_npoints_param_lat0">lat0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     160            <h4 id="_Map_npoints_param_lon1">lon1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     161              <span class="attr">in</span> 
     162               
     163               
     164              <span class="attr">required</span> 
     165               
     166               
     167               
     168               
     169            </h4> 
     170         
     171          <div class="comments">  np1 elements vector. longitude and latitude of np1 points P1  
     172</div> 
     173             
     174            <h4 id="_Map_npoints_param_lat1">lat1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    225175               
    226176               
     
    235185          <div class="comments"></div> 
    236186             
    237             <h4 id="_Map_npoints_param_lon1">lon1&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="_Map_npoints_param_lat1">lat1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    251                
    252                
    253                
    254                
    255                
    256                
    257                
    258                
    259             </h4> 
    260          
    261           <div class="comments"></div> 
    262              
    263187 
    264188           
     
    279203            </h4> 
    280204         
    281             <div class="comments"></div> 
     205            <div class="comments"> A named variable that will receive the azimuth of the great 
     206       circle  connecting the two points, P0 to P1</div> 
    282207             
    283208            <h4 id="_Map_npoints_keyword_RADIANS">RADIANS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    292217            </h4> 
    293218         
    294             <div class="comments"></div> 
     219            <div class="comments"> = if set, inputs and angular outputs are in radians, otherwise 
     220degrees.</div> 
    295221             
    296222            <h4 id="_Map_npoints_keyword_RADIUS">RADIUS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    305231            </h4> 
    306232         
    307             <div class="comments"></div> 
     233            <div class="comments"> If given, return the distance between the two points 
     234calculated using the given radius. 
     235       Default value is the earth radius : 6378206.4d0</div> 
    308236             
    309237            <h4 id="_Map_npoints_keyword_MIDDLE">MIDDLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    318246            </h4> 
    319247         
    320             <div class="comments"></div> 
     248            <div class="comments"> to get the longitude/latitude of the middle point betwen P0 and P1.</div> 
    321249             
    322250            <h4 id="_Map_npoints_keyword_TWO_BY_TWO">TWO_BY_TWO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    331259            </h4> 
    332260         
    333             <div class="comments"></div> 
    334              
    335            
    336  
    337            
    338            
    339            
    340            
    341            
     261            <div class="comments">:If given,then Map_nPoints returns the distances between 
     262       number n of P0 points and number n of P1 points (in that case, 
     263       np0 and np1 must be equal). 
     264</div> 
     265             
     266           
     267 
     268          <h3>Examples</h3><div class="value">  
     269Result = Map_nPoints(lon0, lat0, lon1, lat1) 
     270 
     271 
     272IDL> print, $ 
     273map_npoints([-105.15,1],[40.02,1],[-0.07,100,50],[51.30,20,0]) 
     274       7551369.3       5600334.8 
     275       12864354.       10921254. 
     276       14919237.       5455558.8 
     277 
     278IDL> lon0 = [-10, 20, 100] 
     279IDL> lat0 = [0, -10, 45] 
     280IDL> lon1 = [10, 60, 280] 
     281IDL> lat1 = [0, 10, 45] 
     282IDL> dist = map_npoints(lon0, lat0, lon1, lat1, azimuth = azi) 
     283IDL> help, dist, azi 
     284DIST            DOUBLE    = Array[3, 3] 
     285AZI             DOUBLE    = Array[3, 3] 
     286IDL> print, dist[4*lindgen(3)], azi[4*lindgen(3)] 
     287       2226414.0       4957944.5       10018863. 
     288       90.000000       64.494450   4.9615627e-15 
     289IDL> dist = map_npoints(lon0, lat0, lon1, lat1, azimuth = azi, /two_by_two) 
     290IDL> help, dist, azi 
     291DIST            DOUBLE    = Array[3] 
     292AZI             DOUBLE    = Array[3] 
     293IDL> print, dist, azi 
     294       2226414.0       4957944.5       10018863. 
     295       90.000000       64.494450   4.9615627e-15 
     296IDL> print, map_2points(lon0[0], lat0[0], lon1[0], lat1[0]) 
     297       20.000000       90.000000 
     298IDL> print, map_npoints(lon0[0], lat0[0], lon1[0], lat1[0], azi=azi)/6378206.4d0 / !dtor, azi 
     299       20.000000 
     300       90.000000 
     301 
     302IDL> lon0 = [-10, 20, 100] 
     303IDL> lat0 = [0, -10, 45] 
     304IDL> lon1 = [10, 60, 280] 
     305IDL> lat1 = [0, 10, 45] 
     306IDL> mid = map_npoints(lon0, lat0, lon1, lat1, /middle, /two_by_two) 
     307IDL> print, reform(mid[0,*]), reform(mid[1,*]) 
     308       0.0000000       40.000000       190.00000 
     309       0.0000000  -1.5902773e-15       90.000000 
     310IDL> print, (map_2points(lon0[0], lat0[0], lon1[0], lat1[0], npath = 3))[*, 1] 
     311       0.0000000       0.0000000 
     312IDL> print, (map_2points(lon0[1], lat0[1], lon1[1], lat1[1], npath = 3))[*, 1] 
     313       40.000000  -1.5902773e-15 
     314IDL> print, (map_2points(lon0[2], lat0[2], lon1[2], lat1[2], npath = 3))[*, 1] 
     315       190.00000       90.000000 
     316</div> 
     317          <h3>Version history</h3> 
     318           
     319           
     320          <h4>History</h4><div class="value"> 
     321       Based on the IDL function map_2points.pro,v 1.6 2001/01/15 
     322 Sebastien Masson (smasson@lodyc.jussieu.fr) 
     323                  October 2003</div> 
    342324           
    343325           
Note: See TracChangeset for help on using the changeset viewer.