source: trunk/SRC/Documentation/idldoc_assistant_output/Matrix/make_selection.html @ 177

Last change on this file since 177 was 177, checked in by smasson, 18 years ago

updates of html files...
File size: 5.7 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>make_selection.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="inter.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="union.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Matrix/</font></h1>
58    <h2>make_selection.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64
65   
66
67     
68      <a name="#_make_selection"></a>
69
70      <h2>make_selection  </h2>
71
72      <p><font face="Courier"><i>result = </i>make_selection(<i><a href="#_make_selection_keyword_names">names</a>, <a href="#_make_selection_keyword_selnames">selnames</a></i>, <a href="#_make_selection_keyword_only_valid">only_valid</a>=<i>only_valid</i>, <a href="#_make_selection_keyword_required">required</a>=<i>required</i>, <a href="#_make_selection_keyword_quiet">quiet</a>=<i>quiet</i>)</font></p>
73
74   
75
76 file_comments
77 Convert an array of selected values to an index
78        array that identifies the selected values in a list
79        or data array.
80
81 categories tools
82 
83
84    <h3>Return value</h3> A (long) array with indexes to reference the selected values
85        in the NAMES array.
86
87
88   
89    <h3>Parameters</h3>
90   
91
92    <a name="#_make_selection_keyword_names"></a>
93    <h4>names&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
94      <font size="-1" color="#006633">in</font>
95     
96     
97      <font size="-1" color="#006633">required</font>
98     
99     
100     
101     
102    </h4>
103
104     A list or array of values to choose from
105
106   
107
108    <a name="#_make_selection_keyword_selnames"></a>
109    <h4>selnames&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
110      <font size="-1" color="#006633">in</font>
111     
112     
113      <font size="-1" color="#006633">required</font>
114     
115     
116     
117     
118    </h4>
119
120     A list of selected values
121
122   
123   
124
125   
126    <h3>Keywords</h3>
127
128   
129    <a name="#_make_selection_keyword_only_valid"></a>
130    <h4>only_valid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
131     
132     
133     
134     
135     
136     
137     
138     
139    </h4>
140
141     Return only indexes of found values. Values not
142            found are skipped. Default is to return 1 index value for
143            each SELNAME, which is -1 if SELNAME is not contained in
144            NAMES. If ONLY_VALID is set, the -1 values will be deleted,
145            and a value of -1 indicates that no SELNAME has been found
146            at all.
147
148   
149    <a name="#_make_selection_keyword_required"></a>
150    <h4>required&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
151     
152     
153     
154     
155     
156     
157     
158     
159    </h4>
160
161     Normally, MAKE_SELECTION will return indexes for
162            all values that are found, simply ignoring the selected
163            values that are not in the NAMES array (although an error
164            message is displayed). Set this keyword to return with
165            -1 as soon as a selected value is not found.
166
167   
168    <a name="#_make_selection_keyword_quiet"></a>
169    <h4>quiet&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
170     
171     
172     
173     
174     
175     
176     
177     
178    </h4>
179
180     Suppress printing of the error message if a
181            selected value is not found (the error condition will
182            still be set).
183
184   
185   
186
187    <h3>Examples</h3> names = [ 'Alfred','Anton','Peter','John','Mary']
188           index = MAKE_SELECTION(names,['Peter','Mary'])
189           print,index
190           ; prints  2  4
191
192           vals = indgen(20)
193           index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9])
194           print,index
195           ; prints  9  -1  8  7  7  8  9
196
197           index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9],/ONLY_VALID)
198           print,index
199           ; prints  9  8  7  7  8  9
200
201           index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9],/REQUIRED)
202           print,index
203           ; prints  -1
204
205    <h3>Version history</h3>
206   
207    <h4>Version</h4> $Id: make_selection.pro 163 2006-08-29 12:59:46Z navarro $
208
209    <h4>History</h4> mgs, 28 Aug 1998: VERSION 1.00
210          mgs, 29 Aug 1998: - changed behavior and added ONLY_VALID keyword
211
212   
213
214    <h3>Known issues</h3>
215   
216   
217   
218    <h4>Restrictions</h4> If the NAMES array contains multiple entries of the same value,
219        only the index to the first entry will be returned.
220
221        A selection can contain multiple instances of the same value.
222        The index array will contain one entry per selected item
223        (See example below)
224
225
226   
227   
228   
229   
230   
231   
232   
233
234    <font size="-3"><p>&nbsp;</p></font>
235    <hr size="1" color="#CCCCCC"/>
236     
237
238   
239
240    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep 13 16:32:17 2006.</font></p>
241
242  </body>
243</html>
Note: See TracBrowser for help on using the repository browser.