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

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

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