source: trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/neighbor.html @ 402

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

update documentation
File size: 5.0 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>neighbor.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="map_npoints.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="quadrilateral2square.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>neighbor.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 find the closest point of (P0) within a list of np1 points
65 P1 which can be on a sphere
66
67
68   
69
70     
71      <a name="#_neighbor"></a>
72
73      <h2>neighbor  <font size="-1" color="#006633">
74 Maps
75</font></h2>
76
77      <p><font face="Courier"><i>result = </i>neighbor(<i><a href="#_neighbor_keyword_p0lon">p0lon</a>, <a href="#_neighbor_keyword_p0lat">p0lat</a>[, <a href="#_neighbor_keyword_neighlon">neighlon</a>][, <a href="#_neighbor_keyword_neighlat">neighlat</a>]</i>, <a href="#_neighbor_keyword_SPHERE">SPHERE</a>=<i>SPHERE</i>, <a href="#_neighbor_keyword_DISTANCE">DISTANCE</a>=<i>DISTANCE</i>, <a href="#_neighbor_keyword_RADIANS">RADIANS</a>=<i>RADIANS</i>)</font></p>
78
79   
80
81
82    <h3>Return value</h3>
83 index giving the P1[index] point that is the closest point of (P0)
84
85
86   
87    <h3>Parameters</h3>
88   
89
90    <a name="#_neighbor_keyword_p0lon"></a>
91    <h4>p0lon&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
92      <font size="-1" color="#006633">in</font>
93     
94     
95      <font size="-1" color="#006633">required</font>
96     
97      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
98     
99     
100    </h4>
101
102   
103 longitudes of point P0.
104
105   
106
107    <a name="#_neighbor_keyword_p0lat"></a>
108    <h4>p0lat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
109      <font size="-1" color="#006633">in</font>
110     
111     
112      <font size="-1" color="#006633">required</font>
113     
114      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
115     
116     
117    </h4>
118
119   
120 latitudes of point P0.
121
122   
123
124    <a name="#_neighbor_keyword_neighlon"></a>
125    <h4>neighlon&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126      <font size="-1" color="#006633">in</font>
127     
128      <font size="-1" color="#006633">optional</font>
129     
130     
131     
132     
133     
134    </h4>
135
136   
137
138   
139
140    <a name="#_neighbor_keyword_neighlat"></a>
141    <h4>neighlat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
142      <font size="-1" color="#006633">in</font>
143     
144      <font size="-1" color="#006633">optional</font>
145     
146     
147     
148     
149     
150    </h4>
151
152   
153
154   
155   
156
157   
158    <h3>Keywords</h3>
159
160   
161    <a name="#_neighbor_keyword_SPHERE"></a>
162    <h4>SPHERE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
163     
164     
165     
166     
167     
168     
169     
170     
171    </h4>
172
173   
174 to activate if points are located on a sphere.
175
176   
177    <a name="#_neighbor_keyword_DISTANCE"></a>
178    <h4>DISTANCE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
179     
180     
181     
182     
183     
184     
185     
186     
187    </h4>
188
189   
190 dis, to get back the distances between P0 and the np1 points P1 in the
191 variable dis.
192
193   
194    <a name="#_neighbor_keyword_RADIANS"></a>
195    <h4>RADIANS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
196     
197     
198     
199     
200     
201     
202     
203     
204    </h4>
205
206   
207 if set, inputs and angular outputs are in radians, otherwise degrees.
208
209   
210   
211
212    <h3>Examples</h3><pre>
213
214   IDL> print, neighbor(-105.15,40.02,[-0.07,100,50],[51.30,20,0], $
215               distance=dis)
216                  0
217   IDL> print, dis
218             105.684      206.125      160.228
219
220    </pre><h3>Version history</h3>
221   
222    <h4>Version</h4>
223 $Id: neighbor.pro 371 2008-08-07 09:32:02Z pinsard $
224
225    <h4>History</h4>
226 Sebastien Masson (smasson@lodyc.jussieu.fr)
227                  October 2003
228
229   
230
231   
232   
233   
234   
235   
236
237   
238   
239   
240   
241   
242   
243   
244
245    <font size="-3"><p>&nbsp;</p></font>
246    <hr size="1" color="#CCCCCC"/>
247     
248
249   
250
251    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
252
253  </body>
254</html>
Note: See TracBrowser for help on using the repository browser.