source: trunk/SRC/Documentation/idldoc_html_output/Interpolation/neighbor.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 6.2 KB
Line 
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>
9    <title>neighbor.pro (SAXO Documentation)</title>
10
11   
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" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="neighbor.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../Interpolation//neighbor.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
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
74<a href="map_npoints.html">&lt;&lt;prev file</a> | <a href="quadrilateral2square.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="neighbor.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>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">Interpolation/</a></h1>
82      <h2 class="pro_file">neighbor.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 find the closest point of (P0) within a list of np1 points
91 P1 which can be on a sphere
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_neighbor">
106
107          <h2><a class="top" href="#container">top</a>neighbor <span class="categories">
108 Maps
109</span></h2>
110       
111          <p class="header">
112            <span class="result">result = </span>neighbor(<span class="result"><a href="#_neighbor_param_p0lon">p0lon</a>, <a href="#_neighbor_param_p0lat">p0lat</a>[, <a href="#_neighbor_param_neighlon">neighlon</a>][, <a href="#_neighbor_param_neighlat">neighlat</a>]</span>, <a href="#_neighbor_keyword_SPHERE">SPHERE</a>=<span class="result">SPHERE</span>, <a href="#_neighbor_keyword_DISTANCE">DISTANCE</a>=<span class="result">DISTANCE</span>, <a href="#_neighbor_keyword_RADIANS">RADIANS</a>=<span class="result">RADIANS</span>)</p>
113       
114          <div class="comments">
115</div>
116
117          <h3>Return value</h3><div class="preformat">
118 index giving the P1[index] point that is the closest point of (P0)
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              <span class="attr">type:</span> <span class="value">scalar</span>
132             
133             
134            </h4>
135       
136          <div class="comments">
137 longitudes of point P0.
138</div>
139           
140            <h4 id="_neighbor_param_p0lat">p0lat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
141              <span class="attr">in</span>
142             
143             
144              <span class="attr">required</span>
145             
146              <span class="attr">type:</span> <span class="value">scalar</span>
147             
148             
149            </h4>
150       
151          <div class="comments">
152 latitudes of point P0.
153</div>
154           
155            <h4 id="_neighbor_param_neighlon">neighlon&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
156              <span class="attr">in</span>
157             
158              <span class="attr">optional</span>
159             
160             
161             
162             
163             
164            </h4>
165       
166          <div class="comments">
167</div>
168           
169            <h4 id="_neighbor_param_neighlat">neighlat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
170              <span class="attr">in</span>
171             
172              <span class="attr">optional</span>
173             
174             
175             
176             
177             
178            </h4>
179       
180          <div class="comments">
181</div>
182           
183
184         
185
186         
187
188            <h3>Keywords</h3>
189           
190            <h4 id="_neighbor_keyword_SPHERE">SPHERE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
191             
192             
193             
194             
195             
196             
197             
198             
199            </h4>
200       
201            <div class="comments">
202 to activate if points are located on a sphere.
203</div>
204           
205            <h4 id="_neighbor_keyword_DISTANCE">DISTANCE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
206             
207             
208             
209             
210             
211             
212             
213             
214            </h4>
215       
216            <div class="comments">
217 dis, to get back the distances between P0 and the np1 points P1 in the
218 variable dis.
219</div>
220           
221            <h4 id="_neighbor_keyword_RADIANS">RADIANS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
222             
223             
224             
225             
226             
227             
228             
229             
230            </h4>
231       
232            <div class="comments">
233 if set, inputs and angular outputs are in radians, otherwise degrees.
234</div>
235           
236         
237
238          <h3>Examples</h3><div class="preformat">
239 IDL> print, neighbor(-105.15,40.02,[-0.07,100,50],[51.30,20,0], $
240 IDL> distance=dis)
241                  0
242 IDL> print, dis
243             105.684      206.125      160.228
244</div>
245          <h3>Version history</h3>
246         
247          <h4>Version</h4><div class="preformat">
248 $Id: neighbor.pro 327 2007-12-13 16:22:35Z pinsard $
249</div>
250          <h4>History</h4><div class="preformat">
251 Sebastien Masson (smasson@lodyc.jussieu.fr)
252                  October 2003
253</div>
254         
255         
256         
257         
258         
259         
260         
261       
262         
263         
264         
265         
266         
267         
268         
269       
270          <h3>Statistics</h3>
271          <table class="statistics">
272            <tr><td>McCabe cyclic</td><td>           7</td></tr>
273            <tr><td>McCabe essential</td><td>           1</td></tr>
274            <tr><td>McCabe modular design</td><td>           1</td></tr>
275          </table>
276         
277       
278        </div>
279       
280      </div>
281
282     
283
284      <div id="tagline">Produced by IDLdoc 2.0.</div>
285
286    </div>
287
288  </body>
289</html>
Note: See TracBrowser for help on using the repository browser.