source: trunk/SRC/Documentation/idldoc_html_output/Interpolation/cutsegment.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: 6.4 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>cutsegment.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="cutsegment.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//cutsegment.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="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>
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">cutsegment.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 cut p segments into p*n equal parts
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_cutsegment">
105
106          <h2><a class="top" href="#container">top</a>cutsegment <span class="categories"> basic work
107</span></h2>
108       
109          <p class="header">
110            <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>
111       
112          <div class="comments">
113</div>
114
115          <h3>Return value</h3><div class="preformat">
116  - default: a 3d array (2,n,p) that gives the coordinates of the
117  middle of the cut segments.
118  - if /ENDPOINTS, a 3d array (2,n+1,p) that gives the
119  coordinates of the endpoints of the cutted segments.
120</div>
121
122         
123            <h3>Parameters</h3>
124       
125           
126            <h4 id="_cutsegment_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="_cutsegment_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="_cutsegment_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="_cutsegment_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">
177 1d arrays of p elements, the coordinates of the endpoints of the p segments
178</div>
179           
180            <h4 id="_cutsegment_param_n">n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
181              <span class="attr">in</span>
182             
183             
184              <span class="attr">required</span>
185             
186             
187             
188             
189            </h4>
190       
191          <div class="comments">
192 the number of pieces we want to cut each segment
193</div>
194           
195
196         
197
198         
199
200            <h3>Keywords</h3>
201           
202            <h4 id="_cutsegment_keyword_ENDPOINTS">ENDPOINTS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
203             
204             
205             
206             
207             
208             
209             
210             
211            </h4>
212       
213            <div class="comments">
214 see outputs
215</div>
216           
217            <h4 id="_cutsegment_keyword_ONSPHERE">ONSPHERE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
218             
219             
220             
221             
222             
223             
224             
225             
226            </h4>
227       
228            <div class="comments">
229 to specify that the points are located on a sphere.
230 In this case, x and y corresponds to longitude and latitude in degrees.
231</div>
232           
233         
234
235          <h3>Examples</h3><div class="preformat">
236
237 IDL> x0=[2,5]
238 IDL> y0=[5,1]
239 IDL> x1=[9,3]
240 IDL> y1=[1,8]
241 IDL> res=cutsegment(x0, y0, x1, y1, 10)
242 IDL> splot, [0,10], [0,10], xstyle = 1, ystyle = 1,/nodata
243 IDL> oplot, [x0[0], x1[0]], [y0[0], y1[0]]
244 IDL> oplot, [res[0,*,0]], [res[1,*,0]], color = 20, psym = 1, thick = 3
245 IDL> oplot, [x0[1], x1[1]], [y0[1], y1[1]]
246 IDL> oplot, [res[0,*,1]], [res[1,*,1]], color = 40, psym = 1, thick = 3
247</div>
248          <h3>Version history</h3>
249         
250          <h4>Version</h4><div class="preformat"> $Id: cutsegment.pro 163 2006-08-29 12:59:46Z navarro $
251</div>
252          <h4>History</h4><div class="preformat">
253           S. Masson (smasson@lodyc.jussieu.fr)
254           July 5th, 2002
255</div>
256         
257         
258         
259         
260         
261         
262         
263       
264         
265         
266         
267         
268         
269         
270         
271       
272          <h3>Statistics</h3>
273          <table class="statistics">
274            <tr><td>McCabe cyclic</td><td>           3</td></tr>
275            <tr><td>McCabe essential</td><td>           1</td></tr>
276            <tr><td>McCabe modular design</td><td>           1</td></tr>
277          </table>
278         
279       
280        </div>
281       
282      </div>
283
284     
285
286      <div id="tagline">Produced by IDLdoc 2.0.</div>
287
288    </div>
289
290  </body>
291</html>
Note: See TracBrowser for help on using the repository browser.