source: trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/inquad.html @ 187

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

introducing hyperlinks in idldoc outputs (2/2)

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