source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/STRUCTURE/where_tag.html @ 163

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)
File size: 5.4 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>where_tag.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="struct2string.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=""><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/STRUCTURE/</font></h1>
58    <h2>where_tag.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Like WHERE but works on structure tag names
65 Obtain subscripts of elements in structure array for which
66 a particular Tag has values in a range or matching specified values.
67 Like the WHERE function but for use with structures
68 
69
70   
71
72     
73      <a name="#_where_tag"></a>
74
75      <h2>where_tag  <font size="-1" color="#006633">
76 Structure
77</font></h2>
78
79      <p><font face="Courier"><i>result = </i>where_tag(<i><a href="#_where_tag_keyword_Struct">Struct</a>, <a href="#_where_tag_keyword_Nfound">Nfound</a></i>, <a href="#_where_tag_keyword_TAG_NAME">TAG_NAME</a>=<i>TAG_NAME</i>, <a href="#_where_tag_keyword_TAG_NUMBER">TAG_NUMBER</a>=<i>TAG_NUMBER</i>, <a href="#_where_tag_keyword_ISELECT">ISELECT</a>=<i>ISELECT</i>, <a href="#_where_tag_keyword_NOPRINT">NOPRINT</a>=<i>NOPRINT</i>, <a href="#_where_tag_keyword_RANGE">RANGE</a>=<i>RANGE</i>, <a href="#_where_tag_keyword_VALUES">VALUES</a>=<i>VALUES</i>)</font></p>
80
81   
82
83    <h3>Return value</h3>
84 Nfound {out}
85 # of occurrences found.
86 
87
88   
89    <h3>Parameters</h3>
90   
91
92    <a name="#_where_tag_keyword_Struct"></a>
93    <h4>Struct&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   
105 structure array to search.
106
107   
108
109    <a name="#_where_tag_keyword_Nfound"></a>
110    <h4>Nfound&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
111     
112     
113     
114     
115     
116     
117     
118     
119    </h4>
120
121   
122   
123   
124
125   
126    <h3>Keywords</h3>
127
128   
129    <a name="#_where_tag_keyword_TAG_NAME"></a>
130    <h4>TAG_NAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
131     
132     
133     
134     
135     
136     
137     
138     
139    </h4>
140
141   
142 Scalar string specifying Tag Name
143 
144   
145    <a name="#_where_tag_keyword_TAG_NUMBER"></a>
146    <h4>TAG_NUMBER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147     
148     
149     
150     
151     
152     
153     
154     
155    </h4>
156
157   
158 Otherwise give the Tag Number,
159 
160   
161    <a name="#_where_tag_keyword_ISELECT"></a>
162    <h4>ISELECT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
163     
164     
165     
166     
167     
168     
169     
170     
171    </h4>
172
173   
174 Specifies indices to select only part of structure array,
175 (use it to recycle subscripts from previous searches).
176 
177   
178    <a name="#_where_tag_keyword_NOPRINT"></a>
179    <h4>NOPRINT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
180     
181     
182     
183     
184     
185     
186     
187     
188    </h4>
189
190   
191 Suppress informational messages about nothing found.
192
193   
194    <a name="#_where_tag_keyword_RANGE"></a>
195    <h4>RANGE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
196     
197     
198     
199     
200     
201     
202     
203     
204    </h4>
205
206   
207  [min,max] range to search for in Struct
208 
209   
210    <a name="#_where_tag_keyword_VALUES"></a>
211    <h4>VALUES&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
212     
213     
214     
215     
216     
217     
218     
219     
220    </h4>
221
222   
223 One or array of numbers to match for in Struct,
224 
225   
226   
227
228    <h3>Examples</h3>
229       Suppose STR is a structure with tags CAT_NO:indgen(10), and
230               NAME:strarr(10).   Find the indices where STR.CAT_NO is
231               between 3 and 5.
232
233       IDL> print, WHERE_TAG( str, TAG_NAME = 'CAT_NO', VALUE = [3,4,5] )  ;or
234       IDL> print, WHERE_TAG( str, TAG_NUM = 0, RANGE = [3,5])
235
236    <h3>Version history</h3>
237   
238    <h4>Version</h4>
239 $Id: where_tag.pro 157 2006-08-21 09:01:50Z navarro $
240 
241    <h4>History</h4>
242       written 1990 Frank Varosi STX @ NASA/GSFC
243       Stop printing "Tag <xxx> not found" with /NOPRINT, CD Pike 8-Jun-93
244
245   
246
247    <h3>Known issues</h3>
248   
249   
250   
251    <h4>Restrictions</h4>
252 User *must* specify (1) TAG_NAME or TAG_NUMBER to search, and (2)
253 the VALUES or RANGE to search on;
254
255
256   
257   
258   
259   
260   
261   
262   
263
264    <font size="-3"><p>&nbsp;</p></font>
265    <hr size="1" color="#CCCCCC"/>
266     
267
268   
269
270    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:50:34 2006.</font></p>
271
272  </body>
273</html>
Note: See TracBrowser for help on using the repository browser.