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

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

update documentation
File size: 6.5 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>cutpar.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="compute_fromreg_imoms3_weigaddr.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="cutsegment.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>cutpar.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 cut p parallelogram(s) into p*n^2 parallelograms
65
66
67   
68
69     
70      <a name="#_cutpar"></a>
71
72      <h2>cutpar  <font size="-1" color="#006633">
73 basic work
74</font></h2>
75
76      <p><font face="Courier"><i>result = </i>cutpar(<i><a href="#_cutpar_keyword_x0">x0</a>, <a href="#_cutpar_keyword_y0">y0</a>, <a href="#_cutpar_keyword_x1">x1</a>, <a href="#_cutpar_keyword_y1">y1</a>, <a href="#_cutpar_keyword_x2">x2</a>, <a href="#_cutpar_keyword_y2">y2</a>, <a href="#_cutpar_keyword_x3">x3</a>, <a href="#_cutpar_keyword_y3">y3</a>, <a href="#_cutpar_keyword_n">n</a></i>, <a href="#_cutpar_keyword_ENDPOINTS">ENDPOINTS</a>=<i>ENDPOINTS</i>, <a href="#_cutpar_keyword_ONSPHERE">ONSPHERE</a>=<i>ONSPHERE</i>)</font></p>
77
78   
79
80
81    <h3>Return value</h3>
82 by default: a 3d array(2,n^2,p) giving the center position of each
83 piece of the parallelograms
84
85 if /ENDPOINTS : a 3d array(2,(n+1)^2,p) giving the edge positions
86 of each piece of the parallelograms
87
88
89   
90    <h3>Parameters</h3>
91   
92
93    <a name="#_cutpar_keyword_x0"></a>
94    <h4>x0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
95      <font size="-1" color="#006633">in</font>
96     
97     
98      <font size="-1" color="#006633">required</font>
99     
100     
101     
102     
103    </h4>
104
105   
106   
107
108    <a name="#_cutpar_keyword_y0"></a>
109    <h4>y0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
110      <font size="-1" color="#006633">in</font>
111     
112     
113      <font size="-1" color="#006633">required</font>
114     
115     
116     
117     
118    </h4>
119
120   
121   
122
123    <a name="#_cutpar_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="#_cutpar_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="#_cutpar_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="#_cutpar_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="#_cutpar_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="#_cutpar_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 1d arrays of p elements, giving the edge positions.
212 The edges must be given as in <a href="/Applications/itt/idl64/help/online_help/PLOT.html">PLOT</a> to draw the
213 parallelogram. (see example).
214
215   
216
217    <a name="#_cutpar_keyword_n"></a>
218    <h4>n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
219      <font size="-1" color="#006633">in</font>
220     
221     
222      <font size="-1" color="#006633">required</font>
223     
224     
225     
226     
227    </h4>
228
229   
230 each parallelogram will be cut in n^2 pieces
231
232   
233   
234
235   
236    <h3>Keywords</h3>
237
238   
239    <a name="#_cutpar_keyword_ENDPOINTS"></a>
240    <h4>ENDPOINTS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
241     
242     
243     
244     
245     
246     
247     
248     
249    </h4>
250
251   
252 see returns
253
254   
255    <a name="#_cutpar_keyword_ONSPHERE"></a>
256    <h4>ONSPHERE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
257     
258     
259     
260     
261     
262     
263     
264     
265    </h4>
266
267   
268 to specify that the points are located on a
269 sphere. In this case, x and y correspond to longitude and
270 latitude in degrees.
271
272   
273   
274
275    <h3>Examples</h3><pre>
276
277   IDL> x0 = [2,6,2]
278   IDL> y0 = [0,2,6]
279   IDL> x1 = [3,8,4]
280   IDL> y1 = [4,4,6]
281   IDL> x2 = [1,6,4]
282   IDL> y2 = [5,6,8]
283   IDL> x3 = [0,4,2]
284   IDL> y3 = [1,4,8]
285   IDL> n = 4
286   IDL> splot, [0,10], [0,10], xstyle = 1, ystyle = 1,/nodata
287   IDL> for i=0,2 do oplot, [x0[i],x1[i],x2[i],x3[i],x0[i]],[y0[i],y1[i],y2[i],y3[i],y0[i]]
288   IDL> res=cutpar(x0, y0, x1, y1, x2, y2, x3, y3, n)
289   IDL> for i=0,2 do oplot, [res[0,*,i]], [res[1,*,i]], color = 20+10*i, psym = 1, thick = 3
290
291    </pre><h3>Version history</h3>
292   
293    <h4>Version</h4>
294 $Id: cutpar.pro 372 2008-08-08 12:31:53Z pinsard $
295
296    <h4>History</h4>
297 S. Masson (smasson@lodyc.jussieu.fr)
298  - July 5th, 2002
299
300   
301
302   
303   
304   
305   
306   
307
308    <h3>Other attributes</h3>
309   
310   
311    <h4>Uses routines</h4>
312 <a href="..//Interpolation/cutsegment.html">cutsegment</a>
313
314   
315   
316   
317
318    <font size="-3"><p>&nbsp;</p></font>
319    <hr size="1" color="#CCCCCC"/>
320     
321
322   
323
324    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
325
326  </body>
327</html>
Note: See TracBrowser for help on using the repository browser.