| 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>where_tag.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="where_tag.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 documentation</td> |
|---|
| 67 | </tr> |
|---|
| 68 | </table> |
|---|
| 69 | |
|---|
| 70 | </div> |
|---|
| 71 | |
|---|
| 72 | <div id="secondary_navbar"> |
|---|
| 73 | |
|---|
| 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?format=raw" target="_TOP">view frames</a> summary: fields | routine 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/STRUCTURE/</a></h1> |
|---|
| 82 | <h2 class="pro_file">where_tag.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="_where_Tag"> |
|---|
| 103 | |
|---|
| 104 | <h2><a class="top" href="#container">top</a>where_Tag </h2> |
|---|
| 105 | |
|---|
| 106 | <p class="header"> |
|---|
| 107 | <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> |
|---|
| 108 | |
|---|
| 109 | <div class="comments"> |
|---|
| 110 | NAME: |
|---|
| 111 | WHERE_TAG |
|---|
| 112 | PURPOSE: |
|---|
| 113 | Like WHERE but works on structure tag names |
|---|
| 114 | EXPLANATION: |
|---|
| 115 | Obtain subscripts of elements in structure array for which |
|---|
| 116 | a particular Tag has values in a range or matching specified values. |
|---|
| 117 | Like the WHERE function but for use with structures |
|---|
| 118 | CATEGORY: |
|---|
| 119 | Structures |
|---|
| 120 | CALLING SEQUENCE: |
|---|
| 121 | w = where_tag( struct, [ Nfound, TAG_NAME=, TAG_NUMBER = , RANGE =, |
|---|
| 122 | VALUES =, RANGE =, ISELECT =, /NOPRINT ] |
|---|
| 123 | |
|---|
| 124 | INPUTS: |
|---|
| 125 | Struct = structure array to search. |
|---|
| 126 | |
|---|
| 127 | INPUT KEYWORDS: |
|---|
| 128 | User *must* specify (1) TAG_NAME or TAG_NUMBER to search, and (2) |
|---|
| 129 | the VALUES or RANGE to search on |
|---|
| 130 | |
|---|
| 131 | TAG_NAME = Scalar string specifying Tag Name |
|---|
| 132 | TAG_NUMBER = otherwise give the Tag Number, |
|---|
| 133 | RANGE = [min,max] range to search for in Struct, |
|---|
| 134 | VALUES = one or array of numbers to match for in Struct, |
|---|
| 135 | ISELECT= specifies indices to select only part of structure array, |
|---|
| 136 | (use it to recycle subscripts from previous searches). |
|---|
| 137 | /NOPRINT = suppress informational messages about nothing found. |
|---|
| 138 | |
|---|
| 139 | OUTPUTS: |
|---|
| 140 | Nfound = # of occurences found. |
|---|
| 141 | |
|---|
| 142 | RESULT: |
|---|
| 143 | Function returns subscripts (indices) to desired elements. |
|---|
| 144 | |
|---|
| 145 | EXAMPLES: |
|---|
| 146 | Suppose STR is a structure with tags CAT_NO:indgen(10), and |
|---|
| 147 | NAME:strarr(10). Find the indices where STR.CAT_NO is |
|---|
| 148 | between 3 and 5. |
|---|
| 149 | |
|---|
| 150 | IDL> print, WHERE_TAG( str, TAG_NAME = 'CAT_NO', VALUE = [3,4,5] ) ;or |
|---|
| 151 | IDL> print, WHERE_TAG( str, TAG_NUM = 0, RANGE = [3,5]) |
|---|
| 152 | |
|---|
| 153 | PROCEDURE: |
|---|
| 154 | Get tag number and apply the WHERE function appropriately. |
|---|
| 155 | |
|---|
| 156 | MODIFICATION HISTORY: |
|---|
| 157 | written 1990 Frank Varosi STX @ NASA/GSFC |
|---|
| 158 | Stop printing "Tag <xxx> not found" with /NOPRINT, CD Pike 8-Jun-93</div> |
|---|
| 159 | |
|---|
| 160 | |
|---|
| 161 | |
|---|
| 162 | |
|---|
| 163 | <h3>Parameters</h3> |
|---|
| 164 | |
|---|
| 165 | |
|---|
| 166 | <h4 id="_where_Tag_param_Struct">Struct |
|---|
| 167 | |
|---|
| 168 | |
|---|
| 169 | |
|---|
| 170 | |
|---|
| 171 | |
|---|
| 172 | |
|---|
| 173 | |
|---|
| 174 | |
|---|
| 175 | </h4> |
|---|
| 176 | |
|---|
| 177 | <div class="comments"></div> |
|---|
| 178 | |
|---|
| 179 | <h4 id="_where_Tag_param_Nfound">Nfound |
|---|
| 180 | |
|---|
| 181 | |
|---|
| 182 | |
|---|
| 183 | |
|---|
| 184 | |
|---|
| 185 | |
|---|
| 186 | |
|---|
| 187 | |
|---|
| 188 | </h4> |
|---|
| 189 | |
|---|
| 190 | <div class="comments"></div> |
|---|
| 191 | |
|---|
| 192 | |
|---|
| 193 | |
|---|
| 194 | |
|---|
| 195 | |
|---|
| 196 | |
|---|
| 197 | <h3>Keywords</h3> |
|---|
| 198 | |
|---|
| 199 | <h4 id="_where_Tag_keyword_TAG_NAME">TAG_NAME |
|---|
| 200 | |
|---|
| 201 | |
|---|
| 202 | |
|---|
| 203 | |
|---|
| 204 | |
|---|
| 205 | |
|---|
| 206 | |
|---|
| 207 | |
|---|
| 208 | </h4> |
|---|
| 209 | |
|---|
| 210 | <div class="comments"></div> |
|---|
| 211 | |
|---|
| 212 | <h4 id="_where_Tag_keyword_TAG_NUMBER">TAG_NUMBER |
|---|
| 213 | |
|---|
| 214 | |
|---|
| 215 | |
|---|
| 216 | |
|---|
| 217 | |
|---|
| 218 | |
|---|
| 219 | |
|---|
| 220 | |
|---|
| 221 | </h4> |
|---|
| 222 | |
|---|
| 223 | <div class="comments"></div> |
|---|
| 224 | |
|---|
| 225 | <h4 id="_where_Tag_keyword_ISELECT">ISELECT |
|---|
| 226 | |
|---|
| 227 | |
|---|
| 228 | |
|---|
| 229 | |
|---|
| 230 | |
|---|
| 231 | |
|---|
| 232 | |
|---|
| 233 | |
|---|
| 234 | </h4> |
|---|
| 235 | |
|---|
| 236 | <div class="comments"></div> |
|---|
| 237 | |
|---|
| 238 | <h4 id="_where_Tag_keyword_NOPRINT">NOPRINT |
|---|
| 239 | |
|---|
| 240 | |
|---|
| 241 | |
|---|
| 242 | |
|---|
| 243 | |
|---|
| 244 | |
|---|
| 245 | |
|---|
| 246 | |
|---|
| 247 | </h4> |
|---|
| 248 | |
|---|
| 249 | <div class="comments"></div> |
|---|
| 250 | |
|---|
| 251 | <h4 id="_where_Tag_keyword_RANGE">RANGE |
|---|
| 252 | |
|---|
| 253 | |
|---|
| 254 | |
|---|
| 255 | |
|---|
| 256 | |
|---|
| 257 | |
|---|
| 258 | |
|---|
| 259 | |
|---|
| 260 | </h4> |
|---|
| 261 | |
|---|
| 262 | <div class="comments"></div> |
|---|
| 263 | |
|---|
| 264 | <h4 id="_where_Tag_keyword_VALUES">VALUES |
|---|
| 265 | |
|---|
| 266 | |
|---|
| 267 | |
|---|
| 268 | |
|---|
| 269 | |
|---|
| 270 | |
|---|
| 271 | |
|---|
| 272 | |
|---|
| 273 | </h4> |
|---|
| 274 | |
|---|
| 275 | <div class="comments"></div> |
|---|
| 276 | |
|---|
| 277 | |
|---|
| 278 | |
|---|
| 279 | |
|---|
| 280 | |
|---|
| 281 | |
|---|
| 282 | |
|---|
| 283 | |
|---|
| 284 | |
|---|
| 285 | |
|---|
| 286 | |
|---|
| 287 | |
|---|
| 288 | |
|---|
| 289 | |
|---|
| 290 | |
|---|
| 291 | |
|---|
| 292 | |
|---|
| 293 | |
|---|
| 294 | |
|---|
| 295 | |
|---|
| 296 | |
|---|
| 297 | |
|---|
| 298 | |
|---|
| 299 | |
|---|
| 300 | |
|---|
| 301 | |
|---|
| 302 | </div> |
|---|
| 303 | |
|---|
| 304 | </div> |
|---|
| 305 | |
|---|
| 306 | |
|---|
| 307 | |
|---|
| 308 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
|---|
| 309 | |
|---|
| 310 | </div> |
|---|
| 311 | |
|---|
| 312 | </body> |
|---|
| 313 | </html> |
|---|
