source: trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/map_npoints.html @ 163

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

File size: 7.7 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>map_npoints.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="ll_narcs_distances.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="neighbor.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Interpolation/</font></h1>
58    <h2>map_npoints.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Return the distance in meter between all np0 points P0 and all
65 np1 points P1 on a sphere. If keyword /TWO_BY_TWO is given then
66 returns the distances between number n of P0 points and number
67 n of P1 points (in that case, np0 and np1 must be equal).
68 Same as map_2points with the meter parameter but for n points
69 without do loop.
70
71
72   
73
74     
75      <a name="#_map_npoints"></a>
76
77      <h2>map_npoints  <font size="-1" color="#006633"> Maps
78</font></h2>
79
80      <p><font face="Courier"><i>result = </i>map_npoints(<i><a href="#_map_npoints_keyword_lon0">lon0</a>, <a href="#_map_npoints_keyword_lat0">lat0</a>, <a href="#_map_npoints_keyword_lon1">lon1</a>, <a href="#_map_npoints_keyword_lat1">lat1</a></i>, <a href="#_map_npoints_keyword_AZIMUTH">AZIMUTH</a>=<i>AZIMUTH</i>, <a href="#_map_npoints_keyword_RADIANS">RADIANS</a>=<i>RADIANS</i>, <a href="#_map_npoints_keyword_RADIUS">RADIUS</a>=<i>RADIUS</i>, <a href="#_map_npoints_keyword_MIDDLE">MIDDLE</a>=<i>MIDDLE</i>, <a href="#_map_npoints_keyword_TWO_BY_TWO">TWO_BY_TWO</a>=<i>TWO_BY_TWO</i>)</font></p>
81
82   
83
84
85    <h3>Return value</h3>
86 An (np0,np1) array giving the distance in meter between np0
87 points P0 and np1 points P1. Element (i,j) of the output is the
88 distance between element P0[i] and P1[j].
89 If keyword /TWO_BY_TWO is given then Map_nPoints returns
90 an np-element vector giving the distance in meter between P0[i]
91 and P1[i] (in that case, we have np0 = np1 = np) ; if /MIDDLE see this keyword.
92
93   
94    <h3>Parameters</h3>
95   
96
97    <a name="#_map_npoints_keyword_lon0"></a>
98    <h4>lon0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
99      <font size="-1" color="#006633">in</font>
100     
101     
102      <font size="-1" color="#006633">required</font>
103     
104     
105     
106     
107    </h4>
108
109   
110   
111
112    <a name="#_map_npoints_keyword_lat0"></a>
113    <h4>lat0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
114      <font size="-1" color="#006633">in</font>
115     
116     
117      <font size="-1" color="#006633">required</font>
118     
119     
120     
121     
122    </h4>
123
124   
125 np0 elements vector. longitudes and latitudes of np0 points P0
126
127   
128
129    <a name="#_map_npoints_keyword_lon1"></a>
130    <h4>lon1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
131      <font size="-1" color="#006633">in</font>
132     
133     
134      <font size="-1" color="#006633">required</font>
135     
136     
137     
138     
139    </h4>
140
141   
142   
143
144    <a name="#_map_npoints_keyword_lat1"></a>
145    <h4>lat1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
146      <font size="-1" color="#006633">in</font>
147     
148     
149      <font size="-1" color="#006633">required</font>
150     
151     
152     
153     
154    </h4>
155
156   
157 np1 elements vector. longitude and latitude of np1 points P1
158
159   
160   
161
162   
163    <h3>Keywords</h3>
164
165   
166    <a name="#_map_npoints_keyword_AZIMUTH"></a>
167    <h4>AZIMUTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
168     
169     
170     
171     
172     
173     
174     
175     
176    </h4>
177
178   
179 A named variable that will receive the azimuth of the great
180 circle connecting the two points, P0 to P1
181
182   
183    <a name="#_map_npoints_keyword_RADIANS"></a>
184    <h4>RADIANS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
185     
186     
187     
188     
189     
190     
191     
192     
193    </h4>
194
195   
196 if set, inputs and angular outputs are in radians, otherwise degrees.
197
198   
199    <a name="#_map_npoints_keyword_RADIUS"></a>
200    <h4>RADIUS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
201     
202     
203     
204     
205     
206     
207      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>6378206.4d0</i></font>
208     
209    </h4>
210
211   
212 If given, return the distance between the two points calculated using the
213 given radius.
214 Default value is the Earth radius.
215
216   
217    <a name="#_map_npoints_keyword_MIDDLE"></a>
218    <h4>MIDDLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
219     
220     
221     
222     
223     
224     
225     
226     
227    </h4>
228
229   
230 to get the longitude/latitude of the middle point between P0 and P1.
231
232   
233    <a name="#_map_npoints_keyword_TWO_BY_TWO"></a>
234    <h4>TWO_BY_TWO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
235     
236     
237     
238     
239     
240     
241     
242     
243    </h4>
244
245   
246 If given,then Map_nPoints returns the distances between number n of
247 P0 points and number n of P1 points
248 In that case, np0 and np1 must be equal.
249
250   
251   
252
253    <h3>Examples</h3>
254 IDL> print, $
255 IDL> map_npoints([-105.15,1],[40.02,1],[-0.07,100,50],[51.30,20,0])
256 7551369.3 5600334.8
257 12864354. 10921254.
258 14919237. 5455558.8
259
260 IDL> lon0 = [-10, 20, 100]
261 IDL> lat0 = [0, -10, 45]
262 IDL> lon1 = [10, 60, 280]
263 IDL> lat1 = [0, 10, 45]
264 IDL> dist = map_npoints(lon0, lat0, lon1, lat1, AZIMUTH = azi)
265 IDL> help, dist, azi
266 DIST DOUBLE = Array[3, 3]
267 AZI DOUBLE = Array[3, 3]
268 IDL> print, dist[4*lindgen(3)], azi[4*lindgen(3)]
269 2226414.0 4957944.5 10018863.
270 90.000000 64.494450 4.9615627e-15
271 IDL> dist = map_npoints(lon0, lat0, lon1, lat1, AZIMUTH = azi, /TWO_BY_TWO)
272 IDL> help, dist, azi
273 DIST DOUBLE = Array[3]
274 AZI DOUBLE = Array[3]
275 IDL> print, dist, azi
276 2226414.0 4957944.5 10018863.
277 90.000000 64.494450 4.9615627e-15
278 IDL> print, map_2points(lon0[0], lat0[0], lon1[0], lat1[0])
279 20.000000 90.000000
280 IDL> print, map_npoints(lon0[0], lat0[0], lon1[0], lat1[0], AZIMUTH=azi)/6378206.4d0 / !dtor, azi
281 20.000000
282 90.000000
283
284 IDL> lon0 = [-10, 20, 100]
285 IDL> lat0 = [0, -10, 45]
286 IDL> lon1 = [10, 60, 280]
287 IDL> lat1 = [0, 10, 45]
288 IDL> mid = map_npoints(lon0, lat0, lon1, lat1, /MIDDLE, /TWO_BY_TWO)
289 IDL> print, reform(mid[0,*]), reform(mid[1,*])
290 0.0000000 40.000000 190.00000
291 0.0000000 -1.5902773e-15 90.000000
292 IDL> print, (map_2points(lon0[0], lat0[0], lon1[0], lat1[0], npath = 3))[*, 1]
293 0.0000000 0.0000000
294 IDL> print, (map_2points(lon0[1], lat0[1], lon1[1], lat1[1], npath = 3))[*, 1]
295 40.000000 -1.5902773e-15
296 IDL> print, (map_2points(lon0[2], lat0[2], lon1[2], lat1[2], npath = 3))[*, 1]
297 190.00000 90.000000
298
299    <h3>Version history</h3>
300   
301    <h4>Version</h4> $Id: map_npoints.pro 136 2006-07-10 15:20:19Z pinsard $
302
303    <h4>History</h4>
304 Based on the IDL function map_2points.pro,v 1.6 2001/01/15
305 Sebastien Masson (smasson@lodyc.jussieu.fr)
306 October 2003
307
308   
309
310   
311   
312   
313   
314   
315
316   
317   
318   
319   
320   
321   
322   
323
324    <font size="-3"><p>&nbsp;</p></font>
325    <hr size="1" color="#CCCCCC"/>
326     
327
328   
329
330    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:49:19 2006.</font></p>
331
332  </body>
333</html>
Note: See TracBrowser for help on using the repository browser.