source: trunk/SRC/Documentation/idldoc_html_output/Interpolation/map_npoints.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
File size: 9.3 KB
RevLine 
[89]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
[104]9    <title>map_npoints.pro (SAXO Documentation)</title>
[89]10
11   
[191]12    <link rel="stylesheet" type="text/css" media="all" href="./../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../main_files_print.css" />
[89]14   
15
16    <script type="text/javascript">
17      function setTitle() {
[104]18        parent.document.title="map_npoints.pro (SAXO Documentation)";
[89]19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
[104]26  <h1>SAXO Documentation</h1>
[89]27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
[189]35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
[89]36     
37
38     
39      <td >Directory</td>
40     
41
42     
[189]43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]44     
45
46     
[189]47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]48     
49
50     
[189]51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
[89]52     
53
54      <td id="selected">File</td>
55
56     
[189]57      <td><a href="../../../Interpolation//map_npoints.pro" title="Source code of a file">Source</a></td>
[89]58     
59
60     
[189]61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
[189]74<a href="ll_narcs_distances.html">&lt;&lt;prev file</a> | <a href="neighbor.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="map_npoints.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
[89]75
76</div>
77
78
79    <div id="container">
80
[189]81      <h1 class="directory"><a href="directory-overview.html">Interpolation/</a></h1>
[89]82      <h2 class="pro_file">map_npoints.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[101]89      <div id="file_comments">
[138]90 Return the distance in meter between all np0 points P0 and all
91 np1 points P1 on a sphere. If keyword /TWO_BY_TWO is given then
92 returns the distances between number n of P0 points and number
93 n of P1 points (in that case, np0 and np1 must be equal).
[338]94 Same as <a href="/Applications/itt/idl64/help/online_help/MAP_2POINTS.html">MAP_2POINTS</a> with the meter parameter but for n
[242]95 points without do loop.
[101]96</div>
[89]97
98     
99
100     
101
102     
103
104     
105
106      <div id="routine_details">
107       
108
[163]109        <div class="routine_details" id="_map_npoints">
[89]110
[234]111          <h2><a class="top" href="#container">top</a>map_npoints <span class="categories">
112 Maps
[101]113</span></h2>
[89]114       
115          <p class="header">
[163]116            <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>
[89]117       
118          <div class="comments">
[101]119</div>
[89]120
[138]121          <h3>Return value</h3><div class="preformat">
122 An (np0,np1) array giving the distance in meter between np0
[163]123 points P0 and np1 points P1. Element (i,j) of the output is the
[138]124 distance between element P0[i] and P1[j].
[290]125 If keyword /TWO_BY_TWO is given then <a href="..//Interpolation/map_npoints.html">map_npoints</a> returns
[242]126 an np-elements vector giving the distance in meter between P0[i]
[138]127 and P1[i] (in that case, we have np0 = np1 = np) ; if /MIDDLE see this keyword.</div>
[89]128
129         
130            <h3>Parameters</h3>
131       
132           
[163]133            <h4 id="_map_npoints_param_lon0">lon0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[101]134              <span class="attr">in</span>
[89]135             
136             
[101]137              <span class="attr">required</span>
[89]138             
139             
140             
141             
142            </h4>
143       
[118]144          <div class="comments"></div>
[89]145           
[163]146            <h4 id="_map_npoints_param_lat0">lat0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[118]147              <span class="attr">in</span>
[89]148             
149             
[118]150              <span class="attr">required</span>
[89]151             
152             
153             
154             
155            </h4>
156       
[138]157          <div class="comments">
158 np0 elements vector. longitudes and latitudes of np0 points P0
[118]159</div>
[89]160           
[163]161            <h4 id="_map_npoints_param_lon1">lon1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[101]162              <span class="attr">in</span>
[89]163             
164             
[101]165              <span class="attr">required</span>
[89]166             
167             
168             
169             
170            </h4>
171       
[118]172          <div class="comments"></div>
[89]173           
[163]174            <h4 id="_map_npoints_param_lat1">lat1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[118]175              <span class="attr">in</span>
[89]176             
177             
[118]178              <span class="attr">required</span>
[89]179             
180             
181             
182             
183            </h4>
184       
[138]185          <div class="comments">
186 np1 elements vector. longitude and latitude of np1 points P1
[118]187</div>
[89]188           
189
190         
191
192         
193
194            <h3>Keywords</h3>
195           
[163]196            <h4 id="_map_npoints_keyword_AZIMUTH">AZIMUTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]197             
198             
199             
200             
201             
202             
203             
204             
205            </h4>
206       
[138]207            <div class="comments">
208 A named variable that will receive the azimuth of the great
209 circle connecting the two points, P0 to P1
210</div>
[89]211           
[163]212            <h4 id="_map_npoints_keyword_RADIANS">RADIANS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]213             
214             
215             
216             
217             
218             
219             
220             
221            </h4>
222       
[138]223            <div class="comments">
224 if set, inputs and angular outputs are in radians, otherwise degrees.
225</div>
[89]226           
[163]227            <h4 id="_map_npoints_keyword_RADIUS">RADIUS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]228             
229             
230             
231             
232             
233             
[121]234              <span class="attr">default:</span> <span class="value">6378206.4d0</span>
[89]235             
236            </h4>
237       
[138]238            <div class="comments">
239 If given, return the distance between the two points calculated using the
[121]240 given radius.
241 Default value is the Earth radius.
[118]242</div>
[89]243           
[163]244            <h4 id="_map_npoints_keyword_MIDDLE">MIDDLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]245             
246             
247             
248             
249             
250             
251             
252             
253            </h4>
254       
[138]255            <div class="comments">
[163]256 to get the longitude/latitude of the middle point between P0 and P1.
[138]257</div>
[89]258           
[163]259            <h4 id="_map_npoints_keyword_TWO_BY_TWO">TWO_BY_TWO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]260             
261             
262             
263             
264             
265             
266             
267             
268            </h4>
269       
[138]270            <div class="comments">
[290]271 If given, then <a href="..//Interpolation/map_npoints.html">map_npoints</a> returns the distances between
[242]272 number n of P0 points and number n of P1 pointsi.
[138]273 In that case, np0 and np1 must be equal.
[101]274</div>
[89]275           
276         
277
[138]278          <h3>Examples</h3><div class="preformat">
[402]279   IDL> print, $
280   IDL> map_npoints([-105.15,1],[40.02,1],[-0.07,100,50],[51.30,20,0])
[138]281 7551369.3 5600334.8
282 12864354. 10921254.
283 14919237. 5455558.8
[101]284
[402]285   IDL> lon0 = [-10, 20, 100]
286   IDL> lat0 = [0, -10, 45]
287   IDL> lon1 = [10, 60, 280]
288   IDL> lat1 = [0, 10, 45]
289   IDL> dist = map_npoints(lon0, lat0, lon1, lat1, AZIMUTH = azi)
290   IDL> help, dist, azi
[138]291 DIST DOUBLE = Array[3, 3]
292 AZI DOUBLE = Array[3, 3]
[402]293   IDL> print, dist[4*lindgen(3)], azi[4*lindgen(3)]
[138]294 2226414.0 4957944.5 10018863.
295 90.000000 64.494450 4.9615627e-15
[402]296   IDL> dist = map_npoints(lon0, lat0, lon1, lat1, AZIMUTH = azi, /TWO_BY_TWO)
297   IDL> help, dist, azi
[138]298 DIST DOUBLE = Array[3]
299 AZI DOUBLE = Array[3]
[402]300   IDL> print, dist, azi
[138]301 2226414.0 4957944.5 10018863.
302 90.000000 64.494450 4.9615627e-15
[402]303   IDL> print, map_2points(lon0[0], lat0[0], lon1[0], lat1[0])
[138]304 20.000000 90.000000
[402]305   IDL> print, map_npoints(lon0[0], lat0[0], lon1[0], lat1[0], AZIMUTH=azi)/6378206.4d0 / !dtor, azi
[138]306 20.000000
307 90.000000
[101]308
[402]309   IDL> lon0 = [-10, 20, 100]
310   IDL> lat0 = [0, -10, 45]
311   IDL> lon1 = [10, 60, 280]
312   IDL> lat1 = [0, 10, 45]
313   IDL> mid = map_npoints(lon0, lat0, lon1, lat1, /MIDDLE, /TWO_BY_TWO)
314   IDL> print, reform(mid[0,*]), reform(mid[1,*])
[138]315 0.0000000 40.000000 190.00000
316 0.0000000 -1.5902773e-15 90.000000
[402]317   IDL> print, (map_2points(lon0[0], lat0[0], lon1[0], lat1[0], npath = 3))[*, 1]
[138]318 0.0000000 0.0000000
[402]319   IDL> print, (map_2points(lon0[1], lat0[1], lon1[1], lat1[1], npath = 3))[*, 1]
[138]320 40.000000 -1.5902773e-15
[402]321   IDL> print, (map_2points(lon0[2], lat0[2], lon1[2], lat1[2], npath = 3))[*, 1]
[138]322 190.00000 90.000000
[101]323</div>
324          <h3>Version history</h3>
[89]325         
[234]326          <h4>Version</h4><div class="preformat">
[402]327 $Id: map_npoints.pro 371 2008-08-07 09:32:02Z pinsard $
[118]328</div>
[138]329          <h4>History</h4><div class="preformat">
330 Based on the IDL function map_2points.pro,v 1.6 2001/01/15
[101]331 Sebastien Masson (smasson@lodyc.jussieu.fr)
[138]332 October 2003
[118]333</div>
[89]334         
335         
336         
337         
338         
339         
340         
341       
342         
343         
344         
345         
346         
347         
348         
349       
[163]350          <h3>Statistics</h3>
351          <table class="statistics">
352            <tr><td>McCabe cyclic</td><td>          16</td></tr>
353            <tr><td>McCabe essential</td><td>           1</td></tr>
354            <tr><td>McCabe modular design</td><td>           1</td></tr>
355          </table>
[89]356         
357       
358        </div>
359       
360      </div>
361
362     
363
364      <div id="tagline">Produced by IDLdoc 2.0.</div>
365
366    </div>
367
368  </body>
[249]369</html>
Note: See TracBrowser for help on using the repository browser.