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

Last change on this file since 191 was 191, checked in by pinsard, 18 years ago

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output
File size: 6.1 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 closetest 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"> Maps
108</span></h2>
109       
110          <p class="header">
111            <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>
112       
113          <div class="comments">
114</div>
115
116          <h3>Return value</h3><div class="preformat">
117 index giving the P1[index] point that is the closest point of (P0)
118</div>
119
120         
121            <h3>Parameters</h3>
122       
123           
124            <h4 id="_neighbor_param_p0lon">p0lon&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
125              <span class="attr">in</span>
126             
127             
128              <span class="attr">required</span>
129             
130             
131             
132             
133            </h4>
134       
135          <div class="comments">
136 scalar. longitudes of point P0.
137</div>
138           
139            <h4 id="_neighbor_param_p0lat">p0lat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
140              <span class="attr">in</span>
141             
142             
143              <span class="attr">required</span>
144             
145             
146             
147             
148            </h4>
149       
150          <div class="comments">
151 scalar. latitudes of point P0.
152</div>
153           
154            <h4 id="_neighbor_param_neighlon">neighlon&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
155              <span class="attr">in</span>
156             
157              <span class="attr">optional</span>
158             
159             
160             
161             
162             
163            </h4>
164       
165          <div class="comments">
166</div>
167           
168            <h4 id="_neighbor_param_neighlat">neighlat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
169              <span class="attr">in</span>
170             
171              <span class="attr">optional</span>
172             
173             
174             
175             
176             
177            </h4>
178       
179          <div class="comments">
180</div>
181           
182
183         
184
185         
186
187            <h3>Keywords</h3>
188           
189            <h4 id="_neighbor_keyword_sphere">sphere&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
190             
191             
192             
193             
194             
195             
196             
197             
198            </h4>
199       
200            <div class="comments"> to activate if points are located on a sphere.
201</div>
202           
203            <h4 id="_neighbor_keyword_distance">distance&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
204             
205             
206             
207             
208             
209             
210             
211             
212            </h4>
213       
214            <div class="comments">
215 dis, to get back the distances between P0 and the np1 points P1 in the
216 variable dis.
217</div>
218           
219            <h4 id="_neighbor_keyword_radians">radians&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
220             
221             
222             
223             
224             
225             
226             
227             
228            </h4>
229       
230            <div class="comments">
231 if set, inputs and angular outputs are in radians, otherwise degrees.
232</div>
233           
234         
235
236          <h3>Examples</h3><div class="preformat">
237 IDL> print, neighbor(-105.15,40.02,[-0.07,100,50],[51.30,20,0], $
238 IDL> distance=dis)
239                  0
240 IDL> print, dis
241             105.684      206.125      160.228
242</div>
243          <h3>Version history</h3>
244         
245          <h4>Version</h4><div class="preformat"> $Id: neighbor.pro 136 2006-07-10 15:20:19Z pinsard $
246</div>
247          <h4>History</h4><div class="preformat">
248 Sebastien Masson (smasson@lodyc.jussieu.fr)
249                  October 2003
250</div>
251         
252         
253         
254         
255         
256         
257         
258       
259         
260         
261         
262         
263         
264         
265         
266       
267          <h3>Statistics</h3>
268          <table class="statistics">
269            <tr><td>McCabe cyclic</td><td>           7</td></tr>
270            <tr><td>McCabe essential</td><td>           1</td></tr>
271            <tr><td>McCabe modular design</td><td>           1</td></tr>
272          </table>
273         
274       
275        </div>
276       
277      </div>
278
279     
280
281      <div id="tagline">Produced by IDLdoc 2.0.</div>
282
283    </div>
284
285  </body>
286</html>
Note: See TracBrowser for help on using the repository browser.