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

Last change on this file since 249 was 249, checked in by smasson, 17 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  - default: a 3d array(2,n^2,p) giving the center position of each
83  piece of the parallelograms
84  - if /ENDPOINTS : a 3d array(2,(n+1)^2,p) giving the edge positions
85  of each piece of the parallelograms
86
87
88   
89    <h3>Parameters</h3>
90   
91
92    <a name="#_cutpar_keyword_x0"></a>
93    <h4>x0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
94      <font size="-1" color="#006633">in</font>
95     
96     
97      <font size="-1" color="#006633">required</font>
98     
99     
100     
101     
102    </h4>
103
104   
105   
106
107    <a name="#_cutpar_keyword_y0"></a>
108    <h4>y0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
109      <font size="-1" color="#006633">in</font>
110     
111     
112      <font size="-1" color="#006633">required</font>
113     
114     
115     
116     
117    </h4>
118
119   
120   
121
122    <a name="#_cutpar_keyword_x1"></a>
123    <h4>x1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
124      <font size="-1" color="#006633">in</font>
125     
126     
127      <font size="-1" color="#006633">required</font>
128     
129     
130     
131     
132    </h4>
133
134   
135   
136
137    <a name="#_cutpar_keyword_y1"></a>
138    <h4>y1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
139      <font size="-1" color="#006633">in</font>
140     
141     
142      <font size="-1" color="#006633">required</font>
143     
144     
145     
146     
147    </h4>
148
149   
150   
151
152    <a name="#_cutpar_keyword_x2"></a>
153    <h4>x2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
154      <font size="-1" color="#006633">in</font>
155     
156     
157      <font size="-1" color="#006633">required</font>
158     
159     
160     
161     
162    </h4>
163
164   
165   
166
167    <a name="#_cutpar_keyword_y2"></a>
168    <h4>y2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
169      <font size="-1" color="#006633">in</font>
170     
171     
172      <font size="-1" color="#006633">required</font>
173     
174     
175     
176     
177    </h4>
178
179   
180   
181
182    <a name="#_cutpar_keyword_x3"></a>
183    <h4>x3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
184      <font size="-1" color="#006633">in</font>
185     
186     
187      <font size="-1" color="#006633">required</font>
188     
189     
190     
191     
192    </h4>
193
194   
195   
196
197    <a name="#_cutpar_keyword_y3"></a>
198    <h4>y3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
199      <font size="-1" color="#006633">in</font>
200     
201     
202      <font size="-1" color="#006633">required</font>
203     
204     
205     
206     
207    </h4>
208
209   
210 1d arrays of p elements, giving the edge positions.
211 The edges must be given as in <proidl>plot</proidl> to draw the
212 parallelogram. (see example).
213
214   
215
216    <a name="#_cutpar_keyword_n"></a>
217    <h4>n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
218      <font size="-1" color="#006633">in</font>
219     
220     
221      <font size="-1" color="#006633">required</font>
222     
223     
224     
225     
226    </h4>
227
228   
229 each parallelogram will be cut in n^2 pieces
230
231   
232   
233
234   
235    <h3>Keywords</h3>
236
237   
238    <a name="#_cutpar_keyword_ENDPOINTS"></a>
239    <h4>ENDPOINTS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
240     
241     
242     
243     
244     
245     
246     
247     
248    </h4>
249
250   
251 see returns
252
253   
254    <a name="#_cutpar_keyword_ONSPHERE"></a>
255    <h4>ONSPHERE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
256     
257     
258     
259     
260     
261     
262     
263     
264    </h4>
265
266   
267 to specify that the points are located on a
268 sphere. In this case, x and y correspond to longitude and
269 latitude in degrees.
270
271   
272   
273
274    <h3>Examples</h3><pre>
275
276 IDL> x0 = [2,6,2]
277 IDL> y0 = [0,2,6]
278 IDL> x1 = [3,8,4]
279 IDL> y1 = [4,4,6]
280 IDL> x2 = [1,6,4]
281 IDL> y2 = [5,6,8]
282 IDL> x3 = [0,4,2]
283 IDL> y3 = [1,4,8]
284 IDL> n = 4
285 IDL> splot, [0,10], [0,10], xstyle = 1, ystyle = 1,/nodata
286 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]]
287 IDL> res=cutpar(x0, y0, x1, y1, x2, y2, x3, y3, n)
288 IDL> for i=0,2 do oplot, [res[0,*,i]], [res[1,*,i]], color = 20+10*i, psym = 1, thick = 3
289
290    </pre><h3>Version history</h3>
291   
292    <h4>Version</h4>
293 $Id: cutpar.pro 242 2007-04-06 08:35:17Z pinsard $
294
295    <h4>History</h4>
296           S. Masson (smasson@lodyc.jussieu.fr)
297           July 5th, 2002
298
299   
300
301   
302   
303   
304   
305   
306
307    <h3>Other attributes</h3>
308   
309   
310    <h4>Uses routines</h4>
311 <a href=".//cutsegment.html">cutsegment</a>
312
313   
314   
315   
316
317    <font size="-3"><p>&nbsp;</p></font>
318    <hr size="1" color="#CCCCCC"/>
319     
320
321   
322
323    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
324
325  </body>
326</html>
Note: See TracBrowser for help on using the repository browser.