Context Navigation

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

Last change on this file since 89 was 89, checked in by pinsard, 18 years ago
add idldoc html output. see Documentation/idldoc_html_output/index.html
File size: 5.8 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 (IDLdoc API 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 (IDLdoc API documentation)";
19	}
20	</script>
21	</head>
22
23	<body onload="setTitle();">
24
25	<div id="navbar_title">
26	<h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td>
36
37
38
39	<td >Directory</td>
40
41
42
43	<td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44
45
46
47	<td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48
49
50
51	<td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td>
52
53
54	<td id="selected">File</td>
55
56
57	<td >Source</td>
58
59
60
61	<td><a href="./../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
62
63
64	<td >Etc</td>
65
66	<td id="flexible">Developer documentation</td>
67	</tr>
68	</table>
69
70	</div>
71
72	<div id="secondary_navbar">
73
74	<a href="cutpar.html"><<prev file</a> \| <a href="extrapolate.html">next file >></a>    <a href="cutsegment.html" target="_TOP">view single page</a> \| <a href="./../index.html?format=raw" target="_TOP">view frames</a>    summary: fields \| routine    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?format=raw">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"></div>
90
91
92
93
94
95
96
97
98
99	<div id="routine_details">
100
101
102	<div class="routine_details" id="_cutsegment">
103
104	<h2><a class="top" href="#container">top</a>cutsegment </h2>
105
106	<p class="header">
107	<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>
108
109	<div class="comments">
110	NAME: cutsegment
111
112	PURPOSE: cut p segments into p*n equal parts
113
114	CATEGORY: basic work
115
116	CALLING SEQUENCE: res = cutsegment(x0, y0, x1, y1, n)
117
118	INPUTS:
119	x0,y0 and x1,y1, 1d arrays of p elements, the coordinates of
120	the endpoints of the p segmements
121	n: the number of pieces we want to cut each segment
122
123	KEYWORD PARAMETERS:
124
125	/endpoints: see ouputs
126
127	/onsphere: to specify that the points are located on a
128	sphere. In this case, x and y corresponds to longitude and
129	latitude in degrees.
130
131	OUTPUTS:
132	defaut: a 3d array (2,n,p) that gives the coordinates of the
133	middle of the cutted segments.
134	if /endpoints, a 3d array (2,n+1,p) that gives the
135	coordinates of the endpoints of the cutted segments.
136
137	COMMON BLOCKS: no
138
139	SIDE EFFECTS: no
140
141	RESTRICTIONS: ?
142
143	EXAMPLE:
144
145	IDL> x0=[2,5]
146	IDL> y0=[5,1]
147	IDL> x1=[9,3]
148	IDL> y1=[1,8]
149	IDL> res=cutsegment(x0, y0, x1, y1, 10)
150	IDL> splot, [0,10], [0,10], xstyle = 1, ystyle = 1,/nodata
151	IDL> oplot, [x0[0], x1[0]], [y0[0], y1[0]]
152	IDL> oplot, [res[0,,0]], [res[1,,0]], color = 20, psym = 1, thick = 3
153	IDL> oplot, [x0[1], x1[1]], [y0[1], y1[1]]
154	IDL> oplot, [res[0,,1]], [res[1,,1]], color = 40, psym = 1, thick = 3
155
156	MODIFICATION HISTORY:</div>
157
158
159
160
161	<h3>Parameters</h3>
162
163
164	<h4 id="_cutsegment_param_x0">x0
165
166
167
168
169
170
171
172
173	</h4>
174
175	<div class="comments"></div>
176
177	<h4 id="_cutsegment_param_y0">y0
178
179
180
181
182
183
184
185
186	</h4>
187
188	<div class="comments"></div>
189
190	<h4 id="_cutsegment_param_x1">x1
191
192
193
194
195
196
197
198
199	</h4>
200
201	<div class="comments"></div>
202
203	<h4 id="_cutsegment_param_y1">y1
204
205
206
207
208
209
210
211
212	</h4>
213
214	<div class="comments"></div>
215
216	<h4 id="_cutsegment_param_n">n
217
218
219
220
221
222
223
224
225	</h4>
226
227	<div class="comments"></div>
228
229
230
231
232
233
234	<h3>Keywords</h3>
235
236	<h4 id="_cutsegment_keyword_endpoints">endpoints
237
238
239
240
241
242
243
244
245	</h4>
246
247	<div class="comments"></div>
248
249	<h4 id="_cutsegment_keyword_onsphere">onsphere
250
251
252
253
254
255
256
257
258	</h4>
259
260	<div class="comments"></div>
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287	</div>
288
289	</div>
290
291
292
293	<div id="tagline">Produced by IDLdoc 2.0.</div>
294
295	</div>
296
297	</body>
298	</html>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: