source: trunk/SRC/Documentation/idldoc_assistant_output/Obsolete/extrait.html @ 163

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)
File size: 5.3 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>extrait.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="cp.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="ficdate.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Obsolete/</font></h1>
58    <h2>extrait.pro</h2>
59
60    <dl>
61    </dl>
62
63     
64 extraction of subdomains of matrices;
65 Even if the subdomain is "pierced" (see the example)
66 By default, IDL can make extractions of subdomain:
67
68      IDL> a=indgen(5,5)
69      IDL> print, a
70             0       1       2       3       4
71             5       6       7       8       9
72            10      11      12      13      14
73            15      16      17      18      19
74            20      21      22      23      24
75      IDL> print, a[[0,2],3]
76            15      17
77      IDL> print, a[[0,2],*] 
78             0       2
79             5       7
80            10      12
81            15      17
82            20      22
83 but
84      IDL> print, a[[0,2],[3,4]]
85            15      22
86 while
87      IDL> print, extrait(a,[0,2],[3,4]) 
88            15      17
89            20      22
90
91
92 you better use extrac2
93
94
95   
96
97     
98      <a name="#_extrait"></a>
99
100      <h2>extrait <font size="-1" color="#FF6633">obsolete</font> <font size="-1" color="#006633"> 
101 Utilities
102</font></h2>
103
104      <p><font face="Courier"><i>result = </i>extrait(<i><a href="#_extrait_keyword_tab">tab</a>, <a href="#_extrait_keyword_indicex">indicex</a>, <a href="#_extrait_keyword_indicey">indicey</a>, <a href="#_extrait_keyword_indicez">indicez</a>, <a href="#_extrait_keyword_indicet">indicet</a></i>)</font></p>
105
106   
107
108
109    <h3>Return value</h3> 
110 a matrix 1,2,3 or 4d extract from tab
111
112
113   
114    <h3>Parameters</h3>
115   
116
117    <a name="#_extrait_keyword_tab"></a>
118    <h4>tab&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
119      <font size="-1" color="#006633">in</font>
120     
121     
122      <font size="-1" color="#006633">required</font>
123     
124     
125     
126     
127    </h4>
128
129     
130 a 1,2,3 or 4 dim table
131
132   
133
134    <a name="#_extrait_keyword_indicex"></a>
135    <h4>indicex&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
136      <font size="-1" color="#006633">in</font>
137     
138     
139      <font size="-1" color="#006633">required</font>
140     
141     
142     
143     
144    </h4>
145
146     
147 can have 2 forms:
148 1)a vector containing indexes of lines we want to keep
149 2)the string '*' if we want to keep all lines.
150
151   
152
153    <a name="#_extrait_keyword_indicey"></a>
154    <h4>indicey&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
155      <font size="-1" color="#006633">in</font>
156     
157     
158      <font size="-1" color="#006633">required</font>
159     
160     
161     
162     
163    </h4>
164
165     
166 the same thing that indicex but for dim 2.
167
168   
169
170    <a name="#_extrait_keyword_indicez"></a>
171    <h4>indicez&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
172      <font size="-1" color="#006633">in</font>
173     
174     
175      <font size="-1" color="#006633">required</font>
176     
177     
178     
179     
180    </h4>
181
182     
183 the same thing that indicex but for dim 3.
184 
185   
186
187    <a name="#_extrait_keyword_indicet"></a>
188    <h4>indicet&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
189      <font size="-1" color="#006633">in</font>
190     
191     
192      <font size="-1" color="#006633">required</font>
193     
194     
195     
196     
197    </h4>
198
199     
200 the same thing that indicex but for dim 4.
201
202   
203   
204
205   
206
207    <h3>Examples</h3> 
208 I have a dim 2 matrix named A. I want extract a small intersection
209 matrix 2d of the line 2,3 and 7 and of the column 0 and 1:
210     
211 IDL> res=extrait(A,[2,3,7],[0,1])
212
213 other ex:
214 IDL> print, a
215 a b c
216 d e f
217 g h i
218 IDL> print, extrait(a,[0,2],[0,2])       
219 a c
220 g i
221 
222    <h3>Version history</h3>
223   
224    <h4>Version</h4> $Id: extrait.pro 157 2006-08-21 09:01:50Z navarro $
225
226    <h4>History</h4> Sebastien Masson (smasson@lodyc.jussieu.fr)
227 12/1/1999
228 29/4/1999: correction of a bug and complement of the heading
229
230   
231
232    <h3>Known issues</h3>
233    <h4>Obsolete</h4>
234
235   
236   
237    <h4>Restrictions</h4> 
238 res=-1 in case of mistake
239 
240
241   
242   
243   
244   
245   
246   
247   
248
249    <font size="-3"><p>&nbsp;</p></font>
250    <hr size="1" color="#CCCCCC"/>
251     
252
253   
254
255    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:49:24 2006.</font></p>
256
257  </body>
258</html>
Note: See TracBrowser for help on using the repository browser.