source: trunk/SRC/Documentation/idldoc_html_output/Matrix/make_selection.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: 7.0 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>make_selection.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="make_selection.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//make_selection.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="inter.html">&lt;&lt;prev file</a> | <a href="union.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="make_selection.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">make_selection.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="_make_selection">
103
104          <h2><a class="top" href="#container">top</a>make_selection </h2>
105       
106          <p class="header">
107            <span class="result">result = </span>make_selection(<span class="result"><a href="#_make_selection_param_names">names</a>, <a href="#_make_selection_param_selnames">selnames</a></span>, <a href="#_make_selection_keyword_only_valid">only_valid</a>=<span class="result">only_valid</span>, <a href="#_make_selection_keyword_required">required</a>=<span class="result">required</span>, <a href="#_make_selection_keyword_quiet">quiet</a>=<span class="result">quiet</span>)</p>
108       
109          <div class="comments">
110
111 file_comments
112 Convert an array of selected values to an index
113        array that identifies the selected values in a list
114        or data array.
115
116 categories tools
117 </div>
118
119          <h3>Return value</h3><div class="preformat"> A (long) array with indexes to reference the selected values
120        in the NAMES array.
121</div>
122
123         
124            <h3>Parameters</h3>
125       
126           
127            <h4 id="_make_selection_param_names">names&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
128              <span class="attr">in</span>
129             
130             
131              <span class="attr">required</span>
132             
133             
134             
135             
136            </h4>
137       
138          <div class="comments"> A list or array of values to choose from
139</div>
140           
141            <h4 id="_make_selection_param_selnames">selnames&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
142              <span class="attr">in</span>
143             
144             
145              <span class="attr">required</span>
146             
147             
148             
149             
150            </h4>
151       
152          <div class="comments"> A list of selected values
153</div>
154           
155
156         
157
158         
159
160            <h3>Keywords</h3>
161           
162            <h4 id="_make_selection_keyword_only_valid">only_valid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
163             
164             
165             
166             
167             
168             
169             
170             
171            </h4>
172       
173            <div class="comments"> Return only indexes of found values. Values not
174            found are skipped. Default is to return 1 index value for
175            each SELNAME, which is -1 if SELNAME is not contained in
176            NAMES. If ONLY_VALID is set, the -1 values will be deleted,
177            and a value of -1 indicates that no SELNAME has been found
178            at all.
179</div>
180           
181            <h4 id="_make_selection_keyword_required">required&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
182             
183             
184             
185             
186             
187             
188             
189             
190            </h4>
191       
192            <div class="comments"> Normally, MAKE_SELECTION will return indexes for
193            all values that are found, simply ignoring the selected
194            values that are not in the NAMES array (although an error
195            message is displayed). Set this keyword to return with
196            -1 as soon as a selected value is not found.
197</div>
198           
199            <h4 id="_make_selection_keyword_quiet">quiet&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
200             
201             
202             
203             
204             
205             
206             
207             
208            </h4>
209       
210            <div class="comments"> Suppress printing of the error message if a
211            selected value is not found (the error condition will
212            still be set).
213</div>
214           
215         
216
217          <h3>Examples</h3><div class="preformat"> names = [ 'Alfred','Anton','Peter','John','Mary']
218           index = MAKE_SELECTION(names,['Peter','Mary'])
219           print,index
220           ; prints  2  4
221
222           vals = indgen(20)
223           index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9])
224           print,index
225           ; prints  9  -1  8  7  7  8  9
226
227           index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9],/ONLY_VALID)
228           print,index
229           ; prints  9  8  7  7  8  9
230
231           index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9],/REQUIRED)
232           print,index
233           ; prints  -1
234</div>
235          <h3>Version history</h3>
236         
237          <h4>Version</h4><div class="preformat"> $Id: make_selection.pro 163 2006-08-29 12:59:46Z navarro $
238</div>
239          <h4>History</h4><div class="preformat"> mgs, 28 Aug 1998: VERSION 1.00
240          mgs, 29 Aug 1998: - changed behavior and added ONLY_VALID keyword
241</div>
242         
243         
244          <h3>Known issues</h3>
245         
246         
247         
248          <h4>Restrictions</h4><div class="preformat"> If the NAMES array contains multiple entries of the same value,
249        only the index to the first entry will be returned.
250
251        A selection can contain multiple instances of the same value.
252        The index array will contain one entry per selected item
253        (See example below)
254</div>
255       
256         
257         
258         
259         
260         
261         
262         
263       
264          <h3>Statistics</h3>
265          <table class="statistics">
266            <tr><td>McCabe cyclic</td><td>           8</td></tr>
267            <tr><td>McCabe essential</td><td>           1</td></tr>
268            <tr><td>McCabe modular design</td><td>           1</td></tr>
269          </table>
270         
271       
272        </div>
273       
274      </div>
275
276     
277
278      <div id="tagline">Produced by IDLdoc 2.0.</div>
279
280    </div>
281
282  </body>
283</html>
Note: See TracBrowser for help on using the repository browser.