Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/Obsolete/extrait.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.5 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>extrait.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="extrait.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="../../../Obsolete//extrait.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 documentation</td>
67	</tr>
68	</table>
69
70	</div>
71
72	<div id="secondary_navbar">
73
74	<a href="cp.html"><<prev file</a> \| <a href="ficdate.html">next file >></a>    <a href="extrait.html" target="_TOP">view single page</a> \| <a href="./../index.html" 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">Obsolete/</a></h1>
82	<h2 class="pro_file">extrait.pro</h2>
83
84	<div id="file_attr">
85	<dl>
86	</dl>
87	</div>
88
89	<div id="file_comments">
90	extraction of subdomains of matrices;
91	Even if the subdomain is "pierced" (see the example)
92	By default, IDL can make extractions of subdomain:
93
94	IDL> a=indgen(5,5)
95	IDL> print, a
96	0 1 2 3 4
97	5 6 7 8 9
98	10 11 12 13 14
99	15 16 17 18 19
100	20 21 22 23 24
101	IDL> print, a[[0,2],3]
102	15 17
103	IDL> print, a[[0,2],*]
104	0 2
105	5 7
106	10 12
107	15 17
108	20 22
109	but
110	IDL> print, a[[0,2],[3,4]]
111	15 22
112	while
113	IDL> print, extrait(a,[0,2],[3,4])
114	15 17
115	20 22
116
117
118	you better use extrac2
119	</div>
120
121
122
123
124
125
126
127
128
129	<div id="routine_details">
130
131
132	<div class="routine_details" id="_extrait">
133
134	<h2><a class="top" href="#container">top</a>extrait <span class="warning">obsolete</span> <span class="categories">
135	Utilities
136	</span></h2>
137
138	<p class="header">
139	<span class="result">result = </span>extrait(<span class="result"><a href="#_extrait_param_tab">tab</a>, <a href="#_extrait_param_indicex">indicex</a>, <a href="#_extrait_param_indicey">indicey</a>, <a href="#_extrait_param_indicez">indicez</a>, <a href="#_extrait_param_indicet">indicet</a></span>)</p>
140
141	<div class="comments">
142	</div>
143
144	<h3>Return value</h3><div class="preformat">
145	a matrix 1,2,3 or 4d extract from tab
146	</div>
147
148
149	<h3>Parameters</h3>
150
151
152	<h4 id="_extrait_param_tab">tab
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">
164	a 1,2,3 or 4 dim table
165	</div>
166
167	<h4 id="_extrait_param_indicex">indicex
168	<span class="attr">in</span>
169
170
171	<span class="attr">required</span>
172
173
174
175
176	</h4>
177
178	<div class="comments">
179	can have 2 forms:
180	1)a vector containing indexes of lines we want to keep
181	2)the string '*' if we want to keep all lines.
182	</div>
183
184	<h4 id="_extrait_param_indicey">indicey
185	<span class="attr">in</span>
186
187
188	<span class="attr">required</span>
189
190
191
192
193	</h4>
194
195	<div class="comments">
196	the same thing that indicex but for dim 2.
197	</div>
198
199	<h4 id="_extrait_param_indicez">indicez
200	<span class="attr">in</span>
201
202
203	<span class="attr">required</span>
204
205
206
207
208	</h4>
209
210	<div class="comments">
211	the same thing that indicex but for dim 3.
212	</div>
213
214	<h4 id="_extrait_param_indicet">indicet
215	<span class="attr">in</span>
216
217
218	<span class="attr">required</span>
219
220
221
222
223	</h4>
224
225	<div class="comments">
226	the same thing that indicex but for dim 4.
227	</div>
228
229
230
231
232
233
234	<h3>Examples</h3><div class="preformat">
235	I have a dim 2 matrix named A. I want extract a small intersection
236	matrix 2d of the line 2,3 and 7 and of the column 0 and 1:
237
238	IDL> res=extrait(A,[2,3,7],[0,1])
239
240	other ex:
241	IDL> print, a
242	a b c
243	d e f
244	g h i
245	IDL> print, extrait(a,[0,2],[0,2])
246	a c
247	g i
248	</div>
249	<h3>Version history</h3>
250
251	<h4>Version</h4><div class="preformat"> $Id: extrait.pro 163 2006-08-29 12:59:46Z navarro $
252	</div>
253	<h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr)
254	12/1/1999
255	29/4/1999: correction of a bug and complement of the heading
256	</div>
257
258
259	<h3>Known issues</h3>
260	<h4>Obsolete</h4><div class="preformat">
261	</div>
262
263
264	<h4>Restrictions</h4><div class="preformat">
265	res=-1 in case of mistake
266	</div>
267
268
269
270
271
272
273
274
275
276	<h3>Statistics</h3>
277	<table class="statistics">
278	<tr><td>McCabe cyclic</td><td> 7</td></tr>
279	<tr><td>McCabe essential</td><td> 1</td></tr>
280	<tr><td>McCabe modular design</td><td> 1</td></tr>
281	</table>
282
283
284	</div>
285
286	</div>
287
288
289
290	<div id="tagline">Produced by IDLdoc 2.0.</div>
291
292	</div>
293
294	</body>
295	</html>

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

Download in other formats: