source: trunk/SRC/Documentation/idldoc_html_output/Matrix/extrac2.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.4 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>extrac2.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="extrac2.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="../../../Matrix//extrac2.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&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="extrac2.html" target="_TOP">view single page</a> | <a href="./../index.html" 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">Matrix/</a></h1>
82      <h2 class="pro_file">extrac2.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, extrac2(a,[0,2],[3,4])
114            15      17
115            20      22
116</div>
117
118     
119
120     
121
122     
123
124     
125
126      <div id="routine_details">
127       
128
129        <div class="routine_details" id="_extrac2">
130
131          <h2><a class="top" href="#container">top</a>extrac2 <span class="categories"> 
132 Utilities
133</span></h2>
134       
135          <p class="header">
136            <span class="result">result = </span>extrac2(<span class="result"><a href="#_extrac2_param_array">array</a>, <a href="#_extrac2_param_index1">index1</a>, <a href="#_extrac2_param_index2">index2</a>, <a href="#_extrac2_param_index3">index3</a>, <a href="#_extrac2_param_index4">index4</a></span>)</p>
137       
138          <div class="comments">
139</div>
140
141          <h3>Return value</h3><div class="preformat">
142 a matrix 1,2,3 or 4d extract from input array
143</div>
144
145         
146            <h3>Parameters</h3>
147       
148           
149            <h4 id="_extrac2_param_array">array&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
150              <span class="attr">in</span>
151             
152             
153              <span class="attr">required</span>
154             
155             
156             
157             
158            </h4>
159       
160          <div class="comments">
161 a 1,2,3 or 4 dim input array
162</div>
163           
164            <h4 id="_extrac2_param_index1">index1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
165              <span class="attr">in</span>
166             
167             
168              <span class="attr">required</span>
169             
170             
171             
172             
173            </h4>
174       
175          <div class="comments">
176 can have 2 forms:
177 1)a vector containing indexes of lines we want to keep
178 2)the string '*' if we want to keep all lines.
179</div>
180           
181            <h4 id="_extrac2_param_index2">index2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
182              <span class="attr">in</span>
183             
184             
185              <span class="attr">required</span>
186             
187             
188             
189             
190            </h4>
191       
192          <div class="comments">
193 the same thing that index1 but for dim 2.
194</div>
195           
196            <h4 id="_extrac2_param_index3">index3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
197              <span class="attr">in</span>
198             
199             
200              <span class="attr">required</span>
201             
202             
203             
204             
205            </h4>
206       
207          <div class="comments">
208 the same thing that index1 but for dim 3.
209</div>
210           
211            <h4 id="_extrac2_param_index4">index4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
212              <span class="attr">in</span>
213             
214             
215              <span class="attr">required</span>
216             
217             
218             
219             
220            </h4>
221       
222          <div class="comments">
223 the same thing that index1 but for dim 4.
224</div>
225           
226
227         
228
229         
230
231          <h3>Examples</h3><div class="preformat">
232 I have a dim 2 matrix named A. I want extract a small intersection
233 matrix 2d of the line 2,3 and 7 and of the column 0 and 1:
234 
235 IDL> res=extrac2(A,[2,3,7],[0,1])
236
237 other ex:
238 IDL> print, a
239 a b c
240 d e f
241 g h i
242 IDL> print, extrac2(a,[0,2],[0,2])
243 a c
244 g i
245</div>
246          <h3>Version history</h3>
247         
248          <h4>Version</h4><div class="preformat"> $Id: extrac2.pro 163 2006-08-29 12:59:46Z navarro $
249</div>
250          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr)
251                       12/1/1999
252                       29/4/1999: correction of a bug and complement of the heading
253</div>
254         
255         
256          <h3>Known issues</h3>
257         
258         
259         
260          <h4>Restrictions</h4><div class="preformat">
261 -1 in case of mistake
262</div>
263       
264         
265         
266         
267         
268         
269         
270         
271       
272          <h3>Statistics</h3>
273          <table class="statistics">
274            <tr><td>McCabe cyclic</td><td>          14</td></tr>
275            <tr><td>McCabe essential</td><td>           1</td></tr>
276            <tr><td>McCabe modular design</td><td>           1</td></tr>
277          </table>
278         
279       
280        </div>
281       
282      </div>
283
284     
285
286      <div id="tagline">Produced by IDLdoc 2.0.</div>
287
288    </div>
289
290  </body>
291</html>
Note: See TracBrowser for help on using the repository browser.