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

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
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 -1 in case of mistake
112
113
114   
115    <h3>Parameters</h3>
116   
117
118    <a name="#_extrait_keyword_tab"></a>
119    <h4>tab&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
120      <font size="-1" color="#006633">in</font>
121     
122     
123      <font size="-1" color="#006633">required</font>
124     
125     
126     
127     
128    </h4>
129
130   
131 a 1,2,3 or 4 dim table
132
133   
134
135    <a name="#_extrait_keyword_indicex"></a>
136    <h4>indicex&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
137      <font size="-1" color="#006633">in</font>
138     
139     
140      <font size="-1" color="#006633">required</font>
141     
142     
143     
144     
145    </h4>
146
147   
148 can have 2 forms:
149 1)a vector containing indexes of lines we want to keep
150 2)the string '*' if we want to keep all lines.
151
152   
153
154    <a name="#_extrait_keyword_indicey"></a>
155    <h4>indicey&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
156      <font size="-1" color="#006633">in</font>
157     
158     
159      <font size="-1" color="#006633">required</font>
160     
161     
162     
163     
164    </h4>
165
166   
167 the same thing that indicex but for dim 2.
168
169   
170
171    <a name="#_extrait_keyword_indicez"></a>
172    <h4>indicez&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
173      <font size="-1" color="#006633">in</font>
174     
175     
176      <font size="-1" color="#006633">required</font>
177     
178     
179     
180     
181    </h4>
182
183   
184 the same thing that indicex but for dim 3.
185
186   
187
188    <a name="#_extrait_keyword_indicet"></a>
189    <h4>indicet&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
190      <font size="-1" color="#006633">in</font>
191     
192     
193      <font size="-1" color="#006633">required</font>
194     
195     
196     
197     
198    </h4>
199
200   
201 the same thing that indicex but for dim 4.
202
203   
204   
205
206   
207
208    <h3>Examples</h3><pre>
209 I have a dim 2 matrix named A. I want extract a small intersection
210 matrix 2d of the line 2,3 and 7 and of the column 0 and 1:
211
212 IDL> res=extrait(A,[2,3,7],[0,1])
213
214 other ex:
215 IDL> print, a
216 a b c
217 d e f
218 g h i
219 IDL> print, extrait(a,[0,2],[0,2])
220 a c
221 g i
222
223    </pre><h3>Version history</h3>
224   
225    <h4>Version</h4>
226 $Id: extrait.pro 325 2007-12-06 10:04:53Z pinsard $
227
228    <h4>History</h4>
229 Sebastien Masson (smasson@lodyc.jussieu.fr)
230 12/1/1999
231 29/4/1999: correction of a bug and complement of the heading
232
233   
234
235    <h3>Known issues</h3>
236    <h4>Obsolete</h4>
237
238   
239   
240   
241
242   
243   
244   
245   
246   
247   
248   
249
250    <font size="-3"><p>&nbsp;</p></font>
251    <hr size="1" color="#CCCCCC"/>
252     
253
254   
255
256    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
257
258  </body>
259</html>
Note: See TracBrowser for help on using the repository browser.