source: trunk/SRC/Documentation/idldoc_html_output/Interpolation/cutsegment.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
File size: 6.4 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>cutsegment.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="cutsegment.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//cutsegment.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="cutpar.html">&lt;&lt;prev file</a> | <a href="extrapolate.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="cutsegment.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">cutsegment.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[138]89      <div id="file_comments">
90 cut p segments into p*n equal parts
[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="_cutsegment">
105
[234]106          <h2><a class="top" href="#container">top</a>cutsegment <span class="categories">
107 basic work
[101]108</span></h2>
[89]109       
110          <p class="header">
[138]111            <span class="result">result = </span>cutsegment(<span class="result"><a href="#_cutsegment_param_x0">x0</a>, <a href="#_cutsegment_param_y0">y0</a>, <a href="#_cutsegment_param_x1">x1</a>, <a href="#_cutsegment_param_y1">y1</a>, <a href="#_cutsegment_param_n">n</a></span>, <a href="#_cutsegment_keyword_ENDPOINTS">ENDPOINTS</a>=<span class="result">ENDPOINTS</span>, <a href="#_cutsegment_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">
117  - default: a 3d array (2,n,p) that gives the coordinates of the
[163]118  middle of the cut segments.
[138]119  - if /ENDPOINTS, a 3d array (2,n+1,p) that gives the
120  coordinates of the endpoints of the cutted segments.
[101]121</div>
[89]122
123         
124            <h3>Parameters</h3>
125       
126           
127            <h4 id="_cutsegment_param_x0">x0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[101]128              <span class="attr">in</span>
[89]129             
130             
[101]131              <span class="attr">required</span>
[89]132             
133             
134             
135             
136            </h4>
137       
[118]138          <div class="comments"></div>
[89]139           
140            <h4 id="_cutsegment_param_y0">y0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[118]141              <span class="attr">in</span>
[89]142             
143             
[118]144              <span class="attr">required</span>
[89]145             
146             
147             
148             
149            </h4>
150       
151          <div class="comments"></div>
152           
153            <h4 id="_cutsegment_param_x1">x1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[118]154              <span class="attr">in</span>
[89]155             
156             
[118]157              <span class="attr">required</span>
[89]158             
159             
160             
161             
162            </h4>
163       
164          <div class="comments"></div>
165           
166            <h4 id="_cutsegment_param_y1">y1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[118]167              <span class="attr">in</span>
[89]168             
169             
[118]170              <span class="attr">required</span>
[89]171             
172             
173             
174             
175            </h4>
176       
[118]177          <div class="comments">
178 1d arrays of p elements, the coordinates of the endpoints of the p segments
179</div>
[89]180           
181            <h4 id="_cutsegment_param_n">n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[101]182              <span class="attr">in</span>
[89]183             
184             
[101]185              <span class="attr">required</span>
[89]186             
187             
188             
189             
190            </h4>
191       
[138]192          <div class="comments">
193 the number of pieces we want to cut each segment
[101]194</div>
[89]195           
196
197         
198
199         
200
201            <h3>Keywords</h3>
202           
[138]203            <h4 id="_cutsegment_keyword_ENDPOINTS">ENDPOINTS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]204             
205             
206             
207             
208             
209             
210             
211             
212            </h4>
213       
[138]214            <div class="comments">
[242]215 see returns
[101]216</div>
[89]217           
[138]218            <h4 id="_cutsegment_keyword_ONSPHERE">ONSPHERE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]219             
220             
221             
222             
223             
224             
225             
226             
227            </h4>
228       
[138]229            <div class="comments">
230 to specify that the points are located on a sphere.
[242]231 In this case, x and y correspond to longitude and latitude in degrees.
[101]232</div>
[89]233           
234         
235
[138]236          <h3>Examples</h3><div class="preformat">
[402]237
238   IDL> x0=[2,5]
239   IDL> y0=[5,1]
240   IDL> x1=[9,3]
241   IDL> y1=[1,8]
242   IDL> res=cutsegment(x0, y0, x1, y1, 10)
243   IDL> splot, [0,10], [0,10], xstyle = 1, ystyle = 1,/nodata
244   IDL> oplot, [x0[0], x1[0]], [y0[0], y1[0]]
245   IDL> oplot, [res[0,*,0]], [res[1,*,0]], color = 20, psym = 1, thick = 3
246   IDL> oplot, [x0[1], x1[1]], [y0[1], y1[1]]
247   IDL> oplot, [res[0,*,1]], [res[1,*,1]], color = 40, psym = 1, thick = 3
[101]248</div>
249          <h3>Version history</h3>
[89]250         
[234]251          <h4>Version</h4><div class="preformat">
[402]252 $Id: cutsegment.pro 371 2008-08-07 09:32:02Z pinsard $
[118]253</div>
[138]254          <h4>History</h4><div class="preformat">
[101]255           S. Masson (smasson@lodyc.jussieu.fr)
[118]256           July 5th, 2002
257</div>
[89]258         
259         
260         
261         
262         
263         
264         
265       
266         
267         
268         
269         
270         
271         
272         
273       
[163]274          <h3>Statistics</h3>
275          <table class="statistics">
276            <tr><td>McCabe cyclic</td><td>           3</td></tr>
277            <tr><td>McCabe essential</td><td>           1</td></tr>
278            <tr><td>McCabe modular design</td><td>           1</td></tr>
279          </table>
[89]280         
281       
282        </div>
283       
284      </div>
285
286     
287
288      <div id="tagline">Produced by IDLdoc 2.0.</div>
289
290    </div>
291
292  </body>
[249]293</html>
Note: See TracBrowser for help on using the repository browser.