[89] | 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> |
---|
[104] | 9 | <title>where_tag.pro (SAXO Documentation)</title> |
---|
[89] | 10 | |
---|
| 11 | |
---|
[191] | 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" /> |
---|
[89] | 14 | |
---|
| 15 | |
---|
| 16 | <script type="text/javascript"> |
---|
| 17 | function setTitle() { |
---|
[104] | 18 | parent.document.title="where_tag.pro (SAXO Documentation)"; |
---|
[89] | 19 | } |
---|
| 20 | </script> |
---|
| 21 | </head> |
---|
| 22 | |
---|
| 23 | <body onload="setTitle();"> |
---|
| 24 | |
---|
| 25 | <div id="navbar_title"> |
---|
[104] | 26 | <h1>SAXO Documentation</h1> |
---|
[89] | 27 | </div> |
---|
| 28 | |
---|
| 29 | |
---|
| 30 | <div id="main_navbar"> |
---|
| 31 | |
---|
| 32 | <table cellspacing="0"> |
---|
| 33 | <tr> |
---|
| 34 | |
---|
[189] | 35 | <td><a href="./../../overview.html" title="Overview of library">Overview</a></td> |
---|
[89] | 36 | |
---|
| 37 | |
---|
| 38 | |
---|
| 39 | <td >Directory</td> |
---|
| 40 | |
---|
| 41 | |
---|
| 42 | |
---|
[189] | 43 | <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td> |
---|
[89] | 44 | |
---|
| 45 | |
---|
| 46 | |
---|
[189] | 47 | <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td> |
---|
[89] | 48 | |
---|
| 49 | |
---|
| 50 | |
---|
[189] | 51 | <td><a href="./../../search-page.html" title="Search library">Search</a></td> |
---|
[89] | 52 | |
---|
| 53 | |
---|
| 54 | <td id="selected">File</td> |
---|
| 55 | |
---|
| 56 | |
---|
[189] | 57 | <td><a href="../../../../ToBeReviewed/STRUCTURE//where_tag.pro" title="Source code of a file">Source</a></td> |
---|
[89] | 58 | |
---|
| 59 | |
---|
| 60 | |
---|
[189] | 61 | <td><a href="./../../idldoc-help.html" title="Help on IDLdoc">Help</a></td> |
---|
[89] | 62 | |
---|
| 63 | |
---|
| 64 | <td >Etc</td> |
---|
| 65 | |
---|
| 66 | <td id="flexible">Developer documentation</td> |
---|
| 67 | </tr> |
---|
| 68 | </table> |
---|
| 69 | |
---|
| 70 | </div> |
---|
| 71 | |
---|
| 72 | <div id="secondary_navbar"> |
---|
| 73 | |
---|
[189] | 74 | <a href="struct2string.html"><<prev file</a> | next file >> <a href="where_tag.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a> summary: fields | routine details: <a href="#routine_details">routine</a> |
---|
[89] | 75 | |
---|
| 76 | </div> |
---|
| 77 | |
---|
| 78 | |
---|
| 79 | <div id="container"> |
---|
| 80 | |
---|
[189] | 81 | <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/STRUCTURE/</a></h1> |
---|
[89] | 82 | <h2 class="pro_file">where_tag.pro</h2> |
---|
| 83 | |
---|
| 84 | <div id="file_attr"> |
---|
| 85 | <dl> |
---|
| 86 | </dl> |
---|
| 87 | </div> |
---|
| 88 | |
---|
[151] | 89 | <div id="file_comments"> |
---|
| 90 | Like WHERE but works on structure tag names |
---|
| 91 | Obtain subscripts of elements in structure array for which |
---|
| 92 | a particular Tag has values in a range or matching specified values. |
---|
| 93 | Like the WHERE function but for use with structures |
---|
| 94 | </div> |
---|
[89] | 95 | |
---|
| 96 | |
---|
| 97 | |
---|
| 98 | |
---|
| 99 | |
---|
| 100 | |
---|
| 101 | |
---|
| 102 | |
---|
| 103 | |
---|
| 104 | <div id="routine_details"> |
---|
| 105 | |
---|
| 106 | |
---|
[163] | 107 | <div class="routine_details" id="_where_tag"> |
---|
[89] | 108 | |
---|
[163] | 109 | <h2><a class="top" href="#container">top</a>where_tag <span class="categories"> |
---|
[157] | 110 | Structure |
---|
[151] | 111 | </span></h2> |
---|
[89] | 112 | |
---|
| 113 | <p class="header"> |
---|
[163] | 114 | <span class="result">result = </span>where_tag(<span class="result"><a href="#_where_tag_param_Struct">Struct</a>, <a href="#_where_tag_param_Nfound">Nfound</a></span>, <a href="#_where_tag_keyword_TAG_NAME">TAG_NAME</a>=<span class="result">TAG_NAME</span>, <a href="#_where_tag_keyword_TAG_NUMBER">TAG_NUMBER</a>=<span class="result">TAG_NUMBER</span>, <a href="#_where_tag_keyword_ISELECT">ISELECT</a>=<span class="result">ISELECT</span>, <a href="#_where_tag_keyword_NOPRINT">NOPRINT</a>=<span class="result">NOPRINT</span>, <a href="#_where_tag_keyword_RANGE">RANGE</a>=<span class="result">RANGE</span>, <a href="#_where_tag_keyword_VALUES">VALUES</a>=<span class="result">VALUES</span>)</p> |
---|
[89] | 115 | |
---|
[234] | 116 | <div class="comments"> |
---|
| 117 | </div> |
---|
[89] | 118 | |
---|
[151] | 119 | <h3>Return value</h3><div class="preformat"> |
---|
| 120 | Nfound {out} |
---|
[163] | 121 | # of occurrences found. |
---|
[151] | 122 | </div> |
---|
[97] | 123 | |
---|
[89] | 124 | |
---|
| 125 | <h3>Parameters</h3> |
---|
| 126 | |
---|
| 127 | |
---|
[163] | 128 | <h4 id="_where_tag_param_Struct">Struct |
---|
[151] | 129 | <span class="attr">in</span> |
---|
[89] | 130 | |
---|
| 131 | |
---|
[151] | 132 | <span class="attr">required</span> |
---|
[89] | 133 | |
---|
| 134 | |
---|
| 135 | |
---|
| 136 | |
---|
| 137 | </h4> |
---|
| 138 | |
---|
[151] | 139 | <div class="comments"> |
---|
| 140 | structure array to search. |
---|
| 141 | </div> |
---|
[89] | 142 | |
---|
[163] | 143 | <h4 id="_where_tag_param_Nfound">Nfound |
---|
[89] | 144 | |
---|
| 145 | |
---|
| 146 | |
---|
| 147 | |
---|
| 148 | |
---|
| 149 | |
---|
| 150 | |
---|
| 151 | |
---|
| 152 | </h4> |
---|
| 153 | |
---|
| 154 | <div class="comments"></div> |
---|
| 155 | |
---|
| 156 | |
---|
| 157 | |
---|
| 158 | |
---|
| 159 | |
---|
| 160 | |
---|
| 161 | <h3>Keywords</h3> |
---|
| 162 | |
---|
[163] | 163 | <h4 id="_where_tag_keyword_TAG_NAME">TAG_NAME |
---|
[89] | 164 | |
---|
| 165 | |
---|
| 166 | |
---|
| 167 | |
---|
| 168 | |
---|
| 169 | |
---|
| 170 | |
---|
| 171 | |
---|
| 172 | </h4> |
---|
| 173 | |
---|
[151] | 174 | <div class="comments"> |
---|
| 175 | Scalar string specifying Tag Name |
---|
| 176 | </div> |
---|
[89] | 177 | |
---|
[163] | 178 | <h4 id="_where_tag_keyword_TAG_NUMBER">TAG_NUMBER |
---|
[89] | 179 | |
---|
| 180 | |
---|
| 181 | |
---|
| 182 | |
---|
| 183 | |
---|
| 184 | |
---|
| 185 | |
---|
| 186 | |
---|
| 187 | </h4> |
---|
| 188 | |
---|
[151] | 189 | <div class="comments"> |
---|
| 190 | Otherwise give the Tag Number, |
---|
| 191 | </div> |
---|
[89] | 192 | |
---|
[163] | 193 | <h4 id="_where_tag_keyword_ISELECT">ISELECT |
---|
[89] | 194 | |
---|
| 195 | |
---|
| 196 | |
---|
| 197 | |
---|
| 198 | |
---|
| 199 | |
---|
| 200 | |
---|
| 201 | |
---|
| 202 | </h4> |
---|
| 203 | |
---|
[151] | 204 | <div class="comments"> |
---|
| 205 | Specifies indices to select only part of structure array, |
---|
| 206 | (use it to recycle subscripts from previous searches). |
---|
| 207 | </div> |
---|
[89] | 208 | |
---|
[163] | 209 | <h4 id="_where_tag_keyword_NOPRINT">NOPRINT |
---|
[89] | 210 | |
---|
| 211 | |
---|
| 212 | |
---|
| 213 | |
---|
| 214 | |
---|
| 215 | |
---|
| 216 | |
---|
| 217 | |
---|
| 218 | </h4> |
---|
| 219 | |
---|
[151] | 220 | <div class="comments"> |
---|
| 221 | Suppress informational messages about nothing found. |
---|
| 222 | </div> |
---|
[89] | 223 | |
---|
[163] | 224 | <h4 id="_where_tag_keyword_RANGE">RANGE |
---|
[89] | 225 | |
---|
| 226 | |
---|
| 227 | |
---|
| 228 | |
---|
| 229 | |
---|
| 230 | |
---|
| 231 | |
---|
| 232 | |
---|
| 233 | </h4> |
---|
| 234 | |
---|
[151] | 235 | <div class="comments"> |
---|
| 236 | [min,max] range to search for in Struct |
---|
| 237 | </div> |
---|
[89] | 238 | |
---|
[163] | 239 | <h4 id="_where_tag_keyword_VALUES">VALUES |
---|
[89] | 240 | |
---|
| 241 | |
---|
| 242 | |
---|
| 243 | |
---|
| 244 | |
---|
| 245 | |
---|
| 246 | |
---|
| 247 | |
---|
| 248 | </h4> |
---|
| 249 | |
---|
[151] | 250 | <div class="comments"> |
---|
| 251 | One or array of numbers to match for in Struct, |
---|
| 252 | </div> |
---|
[89] | 253 | |
---|
| 254 | |
---|
| 255 | |
---|
[151] | 256 | <h3>Examples</h3><div class="preformat"> |
---|
| 257 | Suppose STR is a structure with tags CAT_NO:indgen(10), and |
---|
| 258 | NAME:strarr(10). Find the indices where STR.CAT_NO is |
---|
| 259 | between 3 and 5. |
---|
| 260 | |
---|
| 261 | IDL> print, WHERE_TAG( str, TAG_NAME = 'CAT_NO', VALUE = [3,4,5] ) ;or |
---|
| 262 | IDL> print, WHERE_TAG( str, TAG_NUM = 0, RANGE = [3,5]) |
---|
| 263 | </div> |
---|
| 264 | <h3>Version history</h3> |
---|
[89] | 265 | |
---|
[151] | 266 | <h4>Version</h4><div class="preformat"> |
---|
[290] | 267 | $Id: where_tag.pro 262 2007-08-21 14:19:32Z pinsard $ |
---|
[151] | 268 | </div> |
---|
| 269 | <h4>History</h4><div class="preformat"> |
---|
| 270 | written 1990 Frank Varosi STX @ NASA/GSFC |
---|
| 271 | Stop printing "Tag <xxx> not found" with /NOPRINT, CD Pike 8-Jun-93 |
---|
| 272 | </div> |
---|
[89] | 273 | |
---|
| 274 | |
---|
[151] | 275 | <h3>Known issues</h3> |
---|
[89] | 276 | |
---|
| 277 | |
---|
| 278 | |
---|
[151] | 279 | <h4>Restrictions</h4><div class="preformat"> |
---|
| 280 | User *must* specify (1) TAG_NAME or TAG_NUMBER to search, and (2) |
---|
| 281 | the VALUES or RANGE to search on; |
---|
| 282 | </div> |
---|
[89] | 283 | |
---|
| 284 | |
---|
| 285 | |
---|
| 286 | |
---|
| 287 | |
---|
| 288 | |
---|
| 289 | |
---|
| 290 | |
---|
| 291 | |
---|
[163] | 292 | <h3>Statistics</h3> |
---|
| 293 | <table class="statistics"> |
---|
| 294 | <tr><td>McCabe cyclic</td><td> 26</td></tr> |
---|
| 295 | <tr><td>McCabe essential</td><td> 1</td></tr> |
---|
| 296 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
---|
| 297 | </table> |
---|
[89] | 298 | |
---|
| 299 | |
---|
| 300 | </div> |
---|
| 301 | |
---|
| 302 | </div> |
---|
| 303 | |
---|
| 304 | |
---|
| 305 | |
---|
| 306 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
| 307 | |
---|
| 308 | </div> |
---|
| 309 | |
---|
| 310 | </body> |
---|
[249] | 311 | </html> |
---|