source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/MATRICE/extrait.html @ 104

Last change on this file since 104 was 104, checked in by pinsard, 18 years ago

start to modify headers of Postscript *.pro files for better idldoc output + change the title of idldoc output in html to SAXO Documentation
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>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?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&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="different.html">&lt;&lt;prev file</a> | <a href="inter.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="extrait.html" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" 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?format=raw">ToBeReviewed/MATRICE/</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"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_extrait">
103
104          <h2><a class="top" href="#container">top</a>extrait </h2>
105       
106          <p class="header">
107            <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>
108       
109          <div class="comments">
110 NAME:extrait
111
112 PURPOSE:extraction de sous domaines de matrices. Meme si le sous
113 domaine est "troue". cf. : l''exemple
114 Par defaut IDL peut faire des extractions de sous domaines:
115
116      IDL> a=indgen(5,5)
117      IDL> print, a
118             0       1       2       3       4
119             5       6       7       8       9
120            10      11      12      13      14
121            15      16      17      18      19
122            20      21      22      23      24
123      IDL> print, a[[0,2],3]
124            15      17
125      IDL> print, a[[0,2],*] 
126             0       2
127             5       7
128            10      12
129            15      17
130            20      22
131 mais
132      IDL> print, a[[0,2],[3,4]]
133            15      22
134 alors que
135      IDL> print, extrait(a,[0,2],[3,4]) 
136            15      17
137            20      22
138
139 CATEGORY:bidouille avec les matrices
140
141 CALLING SEQUENCE:res=extrait(tab,indicex[,indicey[,indicez,[indicet]]])
142
143 INPUTS:
144        tab: un tableau 1,2,3 ou 4 d
145
146        indicex: indicex peut avoir deux formes:
147              1)un vecteur contenant les indices des lignes a garder
148              2)le string '*' dans ce cas touts les lignes sont
149              gardees
150
151        indicey/z/t: la meme chose que indicex mais pour les
152        dimensions 2,3 et 4.
153
154        rq: il faut autant de vecteurs indice que tab a de dimensions
155
156 KEYWORD PARAMETERS:
157
158 OUTPUTS:
159         res: une matice 1,2,3 ou 4d extraite a partir de tab
160
161 COMMON BLOCKS:
162
163 SIDE EFFECTS:res=-1 en cas d''erreur
164
165 RESTRICTIONS:
166
167 EXAMPLE:
168 j''ai une matrice A de dim 2. je veux en extraire une petite matrice
169 2d interscetion de la ligne 2,3 et 7 et de la colonne 0 et 1
170     
171      res=extrait(A,[2,3,7],[0,1])
172
173autre ex:
174      IDL> print, a
175      a b c
176      d e f
177      g h i
178      IDL> print, extrait(a,[0,2],[0,2])       
179      a c
180      g i
181</div>
182
183         
184
185         
186            <h3>Parameters</h3>
187       
188           
189            <h4 id="_extrait_param_tab">tab&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
190             
191             
192             
193             
194             
195             
196             
197             
198            </h4>
199       
200          <div class="comments"></div>
201           
202            <h4 id="_extrait_param_indicex">indicex&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
203             
204             
205             
206             
207             
208             
209             
210             
211            </h4>
212       
213          <div class="comments"></div>
214           
215            <h4 id="_extrait_param_indicey">indicey&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
216             
217             
218             
219             
220             
221             
222             
223             
224            </h4>
225       
226          <div class="comments"></div>
227           
228            <h4 id="_extrait_param_indicez">indicez&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
229             
230             
231             
232             
233             
234             
235             
236             
237            </h4>
238       
239          <div class="comments"></div>
240           
241            <h4 id="_extrait_param_indicet">indicet&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
242             
243             
244             
245             
246             
247             
248             
249             
250            </h4>
251       
252          <div class="comments"></div>
253           
254
255         
256
257         
258
259         
260         
261         
262         
263         
264         
265         
266         
267         
268         
269         
270         
271       
272         
273         
274         
275         
276         
277         
278         
279       
280         
281       
282        </div>
283       
284      </div>
285
286     
287
288      <div id="tagline">Produced by IDLdoc 2.0.</div>
289
290    </div>
291
292  </body>
293</html>
Note: See TracBrowser for help on using the repository browser.