source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/MATRICE/make_selection.html @ 89

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

add idldoc html output. see Documentation/idldoc_html_output/index.html
File size: 6.7 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 (IDLdoc API 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 (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API 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="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?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">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 NAME:
111        MAKE_SELECTION (function)
112
113 PURPOSE:
114        Convert an array of selected values to an index
115        array that identifies the selected values in a list
116        or data array.
117
118 CATEGORY:
119        Tools
120
121 CALLING SEQUENCE:
122        index = MAKE_SELECTION(NAMES,SELNAMES [,keywords])
123
124 INPUTS:
125        NAMES -> A list or array of values to choose from
126
127        SELNAMES -> A list of selected values
128
129 KEYWORD PARAMETERS:
130        ONLY_VALID -> Return only indices of found values. Values not
131            found are skipped. Default is to return 1 index value for
132            each SELNAME, which is -1 if SELNAME is not contained in
133            NAMES. If ONLY_VALID is set, the -1 values will be deleted,
134            and a value of -1 indicates that no SELNAME has been found
135            at all.
136
137        REQUIRED -> Normally, MAKE_SELECTION will return indices for
138            all values that are found, simply ignoring the selected
139            values that are not in the NAMES array (although an error
140            message is displayed). Set this keyword to return with
141            -1 as soon as a selected value is not found.
142
143        QUIET -> Suppress printing of the error message if a
144            selected value is not found (the error condition will
145            still be set).
146
147 OUTPUTS:
148        A (long) array with indices to reference the selected values
149        in the NAMES array.
150
151 SUBROUTINES:
152
153 REQUIREMENTS:
154
155 NOTES:
156        If the NAMES array contains multiple entries of the same value,
157        only the index to the first entry will be returned.
158
159        A selection can contain multiple instances of the same value.
160        The index array will contain one entry per selected item
161        (See example below)
162
163 EXAMPLE:
164        names = [ 'Alfred','Anton','Peter','John','Mary']
165        index = MAKE_SELECTION(names,['Peter','Mary'])
166        print,index
167        ; prints  2  4
168
169        vals = indgen(20)
170        index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9])
171        print,index
172        ; prints  9  -1  8  7  7  8  9
173
174        index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9],/ONLY_VALID)
175        print,index
176        ; prints  9  8  7  7  8  9
177
178        index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9],/REQUIRED)
179        print,index
180        ; prints  -1
181
182
183 MODIFICATION HISTORY:
184        mgs, 28 Aug 1998: VERSION 1.00
185        mgs, 29 Aug 1998: - changed behaviour and added ONLY_VALID keyword
186</div>
187
188         
189
190         
191            <h3>Parameters</h3>
192       
193           
194            <h4 id="_make_selection_param_names">names&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
195             
196             
197             
198             
199             
200             
201             
202             
203            </h4>
204       
205          <div class="comments"></div>
206           
207            <h4 id="_make_selection_param_selnames">selnames&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
208             
209             
210             
211             
212             
213             
214             
215             
216            </h4>
217       
218          <div class="comments"></div>
219           
220
221         
222
223         
224
225            <h3>Keywords</h3>
226           
227            <h4 id="_make_selection_keyword_only_valid">only_valid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
228             
229             
230             
231             
232             
233             
234             
235             
236            </h4>
237       
238            <div class="comments"></div>
239           
240            <h4 id="_make_selection_keyword_required">required&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
241             
242             
243             
244             
245             
246             
247             
248             
249            </h4>
250       
251            <div class="comments"></div>
252           
253            <h4 id="_make_selection_keyword_quiet">quiet&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
254             
255             
256             
257             
258             
259             
260             
261             
262            </h4>
263       
264            <div class="comments"></div>
265           
266         
267
268         
269         
270         
271         
272         
273         
274         
275         
276         
277         
278         
279         
280       
281         
282         
283         
284         
285         
286         
287         
288       
289         
290       
291        </div>
292       
293      </div>
294
295     
296
297      <div id="tagline">Produced by IDLdoc 2.0.</div>
298
299    </div>
300
301  </body>
302</html>
Note: See TracBrowser for help on using the repository browser.