source: trunk/SRC/Documentation/idldoc_html_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: 7.8 KB
RevLine 
[89]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>
[104]9    <title>cutpar.pro (SAXO Documentation)</title>
[89]10
11   
[191]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" />
[89]14   
15
16    <script type="text/javascript">
17      function setTitle() {
[104]18        parent.document.title="cutpar.pro (SAXO Documentation)";
[89]19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
[104]26  <h1>SAXO Documentation</h1>
[89]27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
[189]35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
[89]36     
37
38     
39      <td >Directory</td>
40     
41
42     
[189]43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]44     
45
46     
[189]47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]48     
49
50     
[189]51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
[89]52     
53
54      <td id="selected">File</td>
55
56     
[189]57      <td><a href="../../../Interpolation//cutpar.pro" title="Source code of a file">Source</a></td>
[89]58     
59
60     
[189]61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]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
[189]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>
[89]75
76</div>
77
78
79    <div id="container">
80
[189]81      <h1 class="directory"><a href="directory-overview.html">Interpolation/</a></h1>
[89]82      <h2 class="pro_file">cutpar.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[138]89      <div id="file_comments">
90 cut p parallelogram(s) into p*n^2 parallelograms
[101]91</div>
[89]92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_cutpar">
105
[234]106          <h2><a class="top" href="#container">top</a>cutpar <span class="categories">
107 basic work
[101]108</span></h2>
[89]109       
110          <p class="header">
[138]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>
[89]112       
113          <div class="comments">
[101]114</div>
[89]115
[138]116          <h3>Return value</h3><div class="preformat">
[338]117 by default: a 3d array(2,n^2,p) giving the center position of each
118 piece of the parallelograms
119
120 if /ENDPOINTS : a 3d array(2,(n+1)^2,p) giving the edge positions
121 of each piece of the parallelograms
[101]122</div>
[89]123
124         
125            <h3>Parameters</h3>
126       
127           
128            <h4 id="_cutpar_param_x0">x0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[101]129              <span class="attr">in</span>
[89]130             
131             
[101]132              <span class="attr">required</span>
[89]133             
134             
135             
136             
137            </h4>
138       
[118]139          <div class="comments"></div>
[89]140           
141            <h4 id="_cutpar_param_y0">y0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[118]142              <span class="attr">in</span>
[89]143             
144             
[118]145              <span class="attr">required</span>
[89]146             
147             
148             
149             
150            </h4>
151       
[138]152          <div class="comments"></div>
[89]153           
154            <h4 id="_cutpar_param_x1">x1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[118]155              <span class="attr">in</span>
[89]156             
157             
[118]158              <span class="attr">required</span>
[89]159             
160             
161             
162             
163            </h4>
164       
165          <div class="comments"></div>
166           
167            <h4 id="_cutpar_param_y1">y1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[118]168              <span class="attr">in</span>
[89]169             
170             
[118]171              <span class="attr">required</span>
[89]172             
173             
174             
175             
176            </h4>
177       
[138]178          <div class="comments"></div>
[89]179           
180            <h4 id="_cutpar_param_x2">x2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[118]181              <span class="attr">in</span>
[89]182             
183             
[118]184              <span class="attr">required</span>
[89]185             
186             
187             
188             
189            </h4>
190       
191          <div class="comments"></div>
192           
193            <h4 id="_cutpar_param_y2">y2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[118]194              <span class="attr">in</span>
[89]195             
196             
[118]197              <span class="attr">required</span>
[89]198             
199             
200             
201             
202            </h4>
203       
[138]204          <div class="comments"></div>
[89]205           
206            <h4 id="_cutpar_param_x3">x3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[118]207              <span class="attr">in</span>
[89]208             
209             
[118]210              <span class="attr">required</span>
[89]211             
212             
213             
214             
215            </h4>
216       
217          <div class="comments"></div>
218           
219            <h4 id="_cutpar_param_y3">y3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[118]220              <span class="attr">in</span>
[89]221             
222             
[118]223              <span class="attr">required</span>
[89]224             
225             
226             
227             
228            </h4>
229       
[138]230          <div class="comments">
231 1d arrays of p elements, giving the edge positions.
[338]232 The edges must be given as in <a href="/Applications/itt/idl64/help/online_help/PLOT.html">PLOT</a> to draw the
[242]233 parallelogram. (see example).
[118]234</div>
[89]235           
236            <h4 id="_cutpar_param_n">n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[101]237              <span class="attr">in</span>
[89]238             
239             
[101]240              <span class="attr">required</span>
[89]241             
242             
243             
244             
245            </h4>
246       
[138]247          <div class="comments">
[163]248 each parallelogram will be cut in n^2 pieces
[101]249</div>
[89]250           
251
252         
253
254         
255
256            <h3>Keywords</h3>
257           
[138]258            <h4 id="_cutpar_keyword_ENDPOINTS">ENDPOINTS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]259             
260             
261             
262             
263             
264             
265             
266             
267            </h4>
268       
[138]269            <div class="comments">
[242]270 see returns
[101]271</div>
[89]272           
[138]273            <h4 id="_cutpar_keyword_ONSPHERE">ONSPHERE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]274             
275             
276             
277             
278             
279             
280             
281             
282            </h4>
283       
[138]284            <div class="comments">
285 to specify that the points are located on a
[242]286 sphere. In this case, x and y correspond to longitude and
[138]287 latitude in degrees.
[101]288</div>
[89]289           
290         
291
[138]292          <h3>Examples</h3><div class="preformat">
[101]293
[402]294   IDL> x0 = [2,6,2]
295   IDL> y0 = [0,2,6]
296   IDL> x1 = [3,8,4]
297   IDL> y1 = [4,4,6]
298   IDL> x2 = [1,6,4]
299   IDL> y2 = [5,6,8]
300   IDL> x3 = [0,4,2]
301   IDL> y3 = [1,4,8]
302   IDL> n = 4
303   IDL> splot, [0,10], [0,10], xstyle = 1, ystyle = 1,/nodata
304   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]]
305   IDL> res=cutpar(x0, y0, x1, y1, x2, y2, x3, y3, n)
306   IDL> for i=0,2 do oplot, [res[0,*,i]], [res[1,*,i]], color = 20+10*i, psym = 1, thick = 3
[101]307</div>
308          <h3>Version history</h3>
[89]309         
[234]310          <h4>Version</h4><div class="preformat">
[402]311 $Id: cutpar.pro 372 2008-08-08 12:31:53Z pinsard $
[118]312</div>
[138]313          <h4>History</h4><div class="preformat">
[402]314 S. Masson (smasson@lodyc.jussieu.fr)
315  - July 5th, 2002
[118]316</div>
[89]317         
318         
319         
320         
321         
322         
323         
324       
[101]325          <h3>Other attributes</h3>
[89]326         
327         
[234]328          <h4>Uses routines</h4><div class="preformat">
[290]329 <a href="..//Interpolation/cutsegment.html">cutsegment</a>
[101]330</div>
[89]331         
332         
333         
334       
[163]335          <h3>Statistics</h3>
336          <table class="statistics">
337            <tr><td>McCabe cyclic</td><td>           1</td></tr>
338            <tr><td>McCabe essential</td><td>           1</td></tr>
339            <tr><td>McCabe modular design</td><td>           1</td></tr>
340          </table>
[89]341         
342       
343        </div>
344       
345      </div>
346
347     
348
349      <div id="tagline">Produced by IDLdoc 2.0.</div>
350
351    </div>
352
353  </body>
[249]354</html>
Note: See TracBrowser for help on using the repository browser.