source: trunk/SRC/Documentation/idldoc_html_output/Interpolation/cutpar.html @ 242

Last change on this file since 242 was 242, checked in by pinsard, 17 years ago

improvements/corrections of some *.pro headers + replace some message by some report
File size: 7.7 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>cutpar.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="cutpar.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//cutpar.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="compute_fromreg_imoms3_weigaddr.html">&lt;&lt;prev file</a> | <a href="cutsegment.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="cutpar.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">cutpar.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 cut p parallelogram(s) into p*n^2 parallelograms
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_cutpar">
105
106          <h2><a class="top" href="#container">top</a>cutpar <span class="categories">
107 basic work
108</span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>cutpar(<span class="result"><a href="#_cutpar_param_x0">x0</a>, <a href="#_cutpar_param_y0">y0</a>, <a href="#_cutpar_param_x1">x1</a>, <a href="#_cutpar_param_y1">y1</a>, <a href="#_cutpar_param_x2">x2</a>, <a href="#_cutpar_param_y2">y2</a>, <a href="#_cutpar_param_x3">x3</a>, <a href="#_cutpar_param_y3">y3</a>, <a href="#_cutpar_param_n">n</a></span>, <a href="#_cutpar_keyword_ENDPOINTS">ENDPOINTS</a>=<span class="result">ENDPOINTS</span>, <a href="#_cutpar_keyword_ONSPHERE">ONSPHERE</a>=<span class="result">ONSPHERE</span>)</p>
112       
113          <div class="comments">
114</div>
115
116          <h3>Return value</h3><div class="preformat">
117  - default: a 3d array(2,n^2,p) giving the center position of each
118  piece of the parallelograms
119  - if /ENDPOINTS : a 3d array(2,(n+1)^2,p) giving the edge positions
120  of each piece of the parallelograms
121</div>
122
123         
124            <h3>Parameters</h3>
125       
126           
127            <h4 id="_cutpar_param_x0">x0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
128              <span class="attr">in</span>
129             
130             
131              <span class="attr">required</span>
132             
133             
134             
135             
136            </h4>
137       
138          <div class="comments"></div>
139           
140            <h4 id="_cutpar_param_y0">y0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
141              <span class="attr">in</span>
142             
143             
144              <span class="attr">required</span>
145             
146             
147             
148             
149            </h4>
150       
151          <div class="comments"></div>
152           
153            <h4 id="_cutpar_param_x1">x1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
154              <span class="attr">in</span>
155             
156             
157              <span class="attr">required</span>
158             
159             
160             
161             
162            </h4>
163       
164          <div class="comments"></div>
165           
166            <h4 id="_cutpar_param_y1">y1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
167              <span class="attr">in</span>
168             
169             
170              <span class="attr">required</span>
171             
172             
173             
174             
175            </h4>
176       
177          <div class="comments"></div>
178           
179            <h4 id="_cutpar_param_x2">x2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
180              <span class="attr">in</span>
181             
182             
183              <span class="attr">required</span>
184             
185             
186             
187             
188            </h4>
189       
190          <div class="comments"></div>
191           
192            <h4 id="_cutpar_param_y2">y2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
193              <span class="attr">in</span>
194             
195             
196              <span class="attr">required</span>
197             
198             
199             
200             
201            </h4>
202       
203          <div class="comments"></div>
204           
205            <h4 id="_cutpar_param_x3">x3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
206              <span class="attr">in</span>
207             
208             
209              <span class="attr">required</span>
210             
211             
212             
213             
214            </h4>
215       
216          <div class="comments"></div>
217           
218            <h4 id="_cutpar_param_y3">y3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
219              <span class="attr">in</span>
220             
221             
222              <span class="attr">required</span>
223             
224             
225             
226             
227            </h4>
228       
229          <div class="comments">
230 1d arrays of p elements, giving the edge positions.
231 The edges must be given as in <proidl>plot</proidl> to draw the
232 parallelogram. (see example).
233</div>
234           
235            <h4 id="_cutpar_param_n">n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
236              <span class="attr">in</span>
237             
238             
239              <span class="attr">required</span>
240             
241             
242             
243             
244            </h4>
245       
246          <div class="comments">
247 each parallelogram will be cut in n^2 pieces
248</div>
249           
250
251         
252
253         
254
255            <h3>Keywords</h3>
256           
257            <h4 id="_cutpar_keyword_ENDPOINTS">ENDPOINTS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
258             
259             
260             
261             
262             
263             
264             
265             
266            </h4>
267       
268            <div class="comments">
269 see returns
270</div>
271           
272            <h4 id="_cutpar_keyword_ONSPHERE">ONSPHERE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
273             
274             
275             
276             
277             
278             
279             
280             
281            </h4>
282       
283            <div class="comments">
284 to specify that the points are located on a
285 sphere. In this case, x and y correspond to longitude and
286 latitude in degrees.
287</div>
288           
289         
290
291          <h3>Examples</h3><div class="preformat">
292
293 IDL> x0 = [2,6,2]
294 IDL> y0 = [0,2,6]
295 IDL> x1 = [3,8,4]
296 IDL> y1 = [4,4,6]
297 IDL> x2 = [1,6,4]
298 IDL> y2 = [5,6,8]
299 IDL> x3 = [0,4,2]
300 IDL> y3 = [1,4,8]
301 IDL> n = 4
302 IDL> splot, [0,10], [0,10], xstyle = 1, ystyle = 1,/nodata
303 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]]
304 IDL> res=cutpar(x0, y0, x1, y1, x2, y2, x3, y3, n)
305 IDL> for i=0,2 do oplot, [res[0,*,i]], [res[1,*,i]], color = 20+10*i, psym = 1, thick = 3
306</div>
307          <h3>Version history</h3>
308         
309          <h4>Version</h4><div class="preformat">
310 $Id: cutpar.pro 231 2007-03-19 17:15:51Z pinsard $
311</div>
312          <h4>History</h4><div class="preformat">
313           S. Masson (smasson@lodyc.jussieu.fr)
314           July 5th, 2002
315</div>
316         
317         
318         
319         
320         
321         
322         
323       
324          <h3>Other attributes</h3>
325         
326         
327          <h4>Uses routines</h4><div class="preformat">
328 <a href=".//cutsegment.html">cutsegment</a>
329</div>
330         
331         
332         
333       
334          <h3>Statistics</h3>
335          <table class="statistics">
336            <tr><td>McCabe cyclic</td><td>           1</td></tr>
337            <tr><td>McCabe essential</td><td>           1</td></tr>
338            <tr><td>McCabe modular design</td><td>           1</td></tr>
339          </table>
340         
341       
342        </div>
343       
344      </div>
345
346     
347
348      <div id="tagline">Produced by IDLdoc 2.0.</div>
349
350    </div>
351
352  </body>
353</html>
Note: See TracBrowser for help on using the repository browser.