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

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

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