source: trunk/SRC/Documentation/idldoc_html_output/Interpolation/inquad.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: 9.6 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>inquad.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="inquad.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//inquad.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="imoms3.html">&lt;&lt;prev file</a> | <a href="inrecgrid.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="inquad.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">inquad.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 to find if an (x,y) point is in a quadrilateral (x1,x2,x3,x4)
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_inquad">
105
106          <h2><a class="top" href="#container">top</a>inquad <span class="categories"> 
107 Grid
108</span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>inquad(<span class="result"><a href="#_inquad_param_x">x</a>, <a href="#_inquad_param_y">y</a>, <a href="#_inquad_param_x1">x1</a>, <a href="#_inquad_param_y1">y1</a>, <a href="#_inquad_param_x2">x2</a>, <a href="#_inquad_param_y2">y2</a>, <a href="#_inquad_param_x3">x3</a>, <a href="#_inquad_param_y3">y3</a>, <a href="#_inquad_param_x4">x4</a>, <a href="#_inquad_param_y4">y4</a></span>, <a href="#_inquad_keyword_ONSPHERE">ONSPHERE</a>=<span class="result">ONSPHERE</span>, <a href="#_inquad_keyword_DOUBLE">DOUBLE</a>=<span class="result">DOUBLE</span>, <a href="#_inquad_keyword_ZOOMRADIUS">ZOOMRADIUS</a>=<span class="result">ZOOMRADIUS</span>, <a href="#_inquad_keyword_NOPRINT">NOPRINT</a>=<span class="result">NOPRINT</span>, <a href="#_inquad_keyword_NEWCOORD">NEWCOORD</a>=<span class="result">NEWCOORD</span>)</p>
112       
113          <div class="comments"></div>
114
115          <h3>Return value</h3><div class="preformat">
116 a n element vector. Where n is the number of elements of
117 x. res[i]=j means that the point number i is located in the
118 quadrilateral number j with (0 <= j <= n_elements(x0)-1)
119</div>
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_inquad_param_x">x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126              <span class="attr">in</span>
127             
128             
129              <span class="attr">required</span>
130             
131             
132             
133             
134            </h4>
135       
136          <div class="comments"></div>
137           
138            <h4 id="_inquad_param_y">y&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
139              <span class="attr">in</span>
140             
141             
142              <span class="attr">required</span>
143             
144             
145             
146             
147            </h4>
148       
149          <div class="comments">
150 the coordinates of the point we want to know where it is.
151 Must be a scalar if /ONSPHERE activated else can be scalar or array.
152</div>
153           
154            <h4 id="_inquad_param_x1">x1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
155              <span class="attr">in</span>
156             
157             
158              <span class="attr">required</span>
159             
160             
161             
162             
163            </h4>
164       
165          <div class="comments"></div>
166           
167            <h4 id="_inquad_param_y1">y1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
168              <span class="attr">in</span>
169             
170             
171              <span class="attr">required</span>
172             
173             
174             
175             
176            </h4>
177       
178          <div class="comments"></div>
179           
180            <h4 id="_inquad_param_x2">x2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
181              <span class="attr">in</span>
182             
183             
184              <span class="attr">required</span>
185             
186             
187             
188             
189            </h4>
190       
191          <div class="comments"></div>
192           
193            <h4 id="_inquad_param_y2">y2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
194              <span class="attr">in</span>
195             
196             
197              <span class="attr">required</span>
198             
199             
200             
201             
202            </h4>
203       
204          <div class="comments"></div>
205           
206            <h4 id="_inquad_param_x3">x3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
207              <span class="attr">in</span>
208             
209             
210              <span class="attr">required</span>
211             
212             
213             
214             
215            </h4>
216       
217          <div class="comments"></div>
218           
219            <h4 id="_inquad_param_y3">y3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
220              <span class="attr">in</span>
221             
222             
223              <span class="attr">required</span>
224             
225             
226             
227             
228            </h4>
229       
230          <div class="comments"></div>
231           
232            <h4 id="_inquad_param_x4">x4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
233              <span class="attr">in</span>
234             
235             
236              <span class="attr">required</span>
237             
238             
239             
240             
241            </h4>
242       
243          <div class="comments"></div>
244           
245            <h4 id="_inquad_param_y4">y4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
246              <span class="attr">in</span>
247             
248             
249              <span class="attr">required</span>
250             
251             
252             
253             
254            </h4>
255       
256          <div class="comments">
257 the coordinates of the quadrilateral given in the CLOCKWISE order.
258 Scalar or array.
259</div>
260           
261
262         
263
264         
265
266            <h3>Keywords</h3>
267           
268            <h4 id="_inquad_keyword_ONSPHERE">ONSPHERE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
269             
270             
271             
272             
273             
274             
275             
276             
277            </h4>
278       
279            <div class="comments">
280 to specify that the quadrilateral are on a sphere and
281 that their coordinates are longitude-latitude coordinates. In this
282 case, est-west periodicity, poles singularity and other pbs
283 related to longitude-latitude coordinates are managed
284 automatically.
285</div>
286           
287            <h4 id="_inquad_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
288             
289             
290             
291             
292             
293             
294             
295             
296            </h4>
297       
298            <div class="comments">
299 use double precision to perform the computation
300</div>
301           
302            <h4 id="_inquad_keyword_ZOOMRADIUS">ZOOMRADIUS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
303             
304             
305             
306             
307             
308             
309              <span class="attr">default:</span> <span class="value">4</span>
310             
311            </h4>
312       
313            <div class="comments">
314 the zoom (circle centered on the (x,y) with a radius of
315 zoomradius degree where we look for the the quadrilateral which
316 contains the (x,y) point) used for the satellite projection
317 when /ONSPHERE is activated.
318 4 seems to be the minimum which can be used.
319 Can be increase if the cell size is larger than 5 degrees.
320</div>
321           
322            <h4 id="_inquad_keyword_NOPRINT">NOPRINT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
323             
324             
325             
326             
327             
328             
329             
330             
331            </h4>
332       
333            <div class="comments">
334 to suppress the print messages.
335</div>
336           
337            <h4 id="_inquad_keyword_NEWCOORD">NEWCOORD&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
338             
339             
340             
341             
342             
343             
344             
345             
346            </h4>
347       
348            <div class="comments">
349</div>
350           
351         
352
353          <h3>Examples</h3><div class="preformat">
354
355 IDL> x = 1.*[1, 2, 6, 7, 3]
356 IDL> y = 1.*[1, 3, 3, 4, 7]
357 IDL> x1 = 1.*[0,4,2]
358 IDL> y1 = 1.*[1,4,8]
359 IDL> x2 = 1.*[1,6,4]
360 IDL> y2 = 1.*[5,6,8]
361 IDL> x3 = 1.*[3,8,4]
362 IDL> y3 = 1.*[4,4,6]
363 IDL> x4 = 1.*[2,6,2]
364 IDL> y4 = 1.*[0,2,6]
365 IDL> splot, [0,10], [0,10], xstyle = 1, ystyle = 1,/nodata
366 IDL> for i=0,2 do oplot, [x4[i],x1[i],x2[i],x3[i],x4[i]],[y4[i],y1[i],y2[i],y3[i],y4[i]]
367 IDL> oplot, x, y, color = 20, psym = 1, thick = 2
368 IDL> print, inquad(x, y, x1, y1, x2, y2, x3, y3, x4, y4)
369
370 On a sphere see clickincell.pro...
371</div>
372          <h3>Version history</h3>
373         
374          <h4>Version</h4><div class="preformat"> $Id: inquad.pro 163 2006-08-29 12:59:46Z navarro $
375</div>
376          <h4>History</h4><div class="preformat">
377      Sebastien Masson (smasson@lodyc.jussieu.fr)
378      August 2003
379      Based on Convert_clic_ij.pro written by Gurvan Madec
380</div>
381         
382         
383          <h3>Known issues</h3>
384         
385         
386         
387          <h4>Restrictions</h4><div class="preformat">
388 I think degenerated quadrilateral (e.g. flat of twisted) is not work.
389 This has to be tested.
390</div>
391       
392         
393         
394         
395         
396         
397         
398         
399       
400          <h3>Statistics</h3>
401          <table class="statistics">
402            <tr><td>McCabe cyclic</td><td>          21</td></tr>
403            <tr><td>McCabe essential</td><td>           1</td></tr>
404            <tr><td>McCabe modular design</td><td>           1</td></tr>
405          </table>
406         
407       
408        </div>
409       
410      </div>
411
412     
413
414      <div id="tagline">Produced by IDLdoc 2.0.</div>
415
416    </div>
417
418  </body>
419</html>
Note: See TracBrowser for help on using the repository browser.