| 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 | |
|---|
| 84 | <h3>Return value</h3> |
|---|
| 85 | Nfound {out} |
|---|
| 86 | # of occurrences found. |
|---|
| 87 | |
|---|
| 88 | |
|---|
| 89 | |
|---|
| 90 | <h3>Parameters</h3> |
|---|
| 91 | |
|---|
| 92 | |
|---|
| 93 | <a name="#_where_tag_keyword_Struct"></a> |
|---|
| 94 | <h4>Struct |
|---|
| 95 | <font size="-1" color="#006633">in</font> |
|---|
| 96 | |
|---|
| 97 | |
|---|
| 98 | <font size="-1" color="#006633">required</font> |
|---|
| 99 | |
|---|
| 100 | |
|---|
| 101 | |
|---|
| 102 | |
|---|
| 103 | </h4> |
|---|
| 104 | |
|---|
| 105 | |
|---|
| 106 | structure array to search. |
|---|
| 107 | |
|---|
| 108 | |
|---|
| 109 | |
|---|
| 110 | <a name="#_where_tag_keyword_Nfound"></a> |
|---|
| 111 | <h4>Nfound |
|---|
| 112 | |
|---|
| 113 | |
|---|
| 114 | |
|---|
| 115 | |
|---|
| 116 | |
|---|
| 117 | |
|---|
| 118 | |
|---|
| 119 | |
|---|
| 120 | </h4> |
|---|
| 121 | |
|---|
| 122 | |
|---|
| 123 | |
|---|
| 124 | |
|---|
| 125 | |
|---|
| 126 | |
|---|
| 127 | <h3>Keywords</h3> |
|---|
| 128 | |
|---|
| 129 | |
|---|
| 130 | <a name="#_where_tag_keyword_TAG_NAME"></a> |
|---|
| 131 | <h4>TAG_NAME |
|---|
| 132 | |
|---|
| 133 | |
|---|
| 134 | |
|---|
| 135 | |
|---|
| 136 | |
|---|
| 137 | |
|---|
| 138 | |
|---|
| 139 | |
|---|
| 140 | </h4> |
|---|
| 141 | |
|---|
| 142 | |
|---|
| 143 | Scalar string specifying Tag Name |
|---|
| 144 | |
|---|
| 145 | |
|---|
| 146 | <a name="#_where_tag_keyword_TAG_NUMBER"></a> |
|---|
| 147 | <h4>TAG_NUMBER |
|---|
| 148 | |
|---|
| 149 | |
|---|
| 150 | |
|---|
| 151 | |
|---|
| 152 | |
|---|
| 153 | |
|---|
| 154 | |
|---|
| 155 | |
|---|
| 156 | </h4> |
|---|
| 157 | |
|---|
| 158 | |
|---|
| 159 | Otherwise give the Tag Number, |
|---|
| 160 | |
|---|
| 161 | |
|---|
| 162 | <a name="#_where_tag_keyword_ISELECT"></a> |
|---|
| 163 | <h4>ISELECT |
|---|
| 164 | |
|---|
| 165 | |
|---|
| 166 | |
|---|
| 167 | |
|---|
| 168 | |
|---|
| 169 | |
|---|
| 170 | |
|---|
| 171 | |
|---|
| 172 | </h4> |
|---|
| 173 | |
|---|
| 174 | |
|---|
| 175 | Specifies indices to select only part of structure array, |
|---|
| 176 | (use it to recycle subscripts from previous searches). |
|---|
| 177 | |
|---|
| 178 | |
|---|
| 179 | <a name="#_where_tag_keyword_NOPRINT"></a> |
|---|
| 180 | <h4>NOPRINT |
|---|
| 181 | |
|---|
| 182 | |
|---|
| 183 | |
|---|
| 184 | |
|---|
| 185 | |
|---|
| 186 | |
|---|
| 187 | |
|---|
| 188 | |
|---|
| 189 | </h4> |
|---|
| 190 | |
|---|
| 191 | |
|---|
| 192 | Suppress informational messages about nothing found. |
|---|
| 193 | |
|---|
| 194 | |
|---|
| 195 | <a name="#_where_tag_keyword_RANGE"></a> |
|---|
| 196 | <h4>RANGE |
|---|
| 197 | |
|---|
| 198 | |
|---|
| 199 | |
|---|
| 200 | |
|---|
| 201 | |
|---|
| 202 | |
|---|
| 203 | |
|---|
| 204 | |
|---|
| 205 | </h4> |
|---|
| 206 | |
|---|
| 207 | |
|---|
| 208 | [min,max] range to search for in Struct |
|---|
| 209 | |
|---|
| 210 | |
|---|
| 211 | <a name="#_where_tag_keyword_VALUES"></a> |
|---|
| 212 | <h4>VALUES |
|---|
| 213 | |
|---|
| 214 | |
|---|
| 215 | |
|---|
| 216 | |
|---|
| 217 | |
|---|
| 218 | |
|---|
| 219 | |
|---|
| 220 | |
|---|
| 221 | </h4> |
|---|
| 222 | |
|---|
| 223 | |
|---|
| 224 | One or array of numbers to match for in Struct, |
|---|
| 225 | |
|---|
| 226 | |
|---|
| 227 | |
|---|
| 228 | |
|---|
| 229 | <h3>Examples</h3><pre> |
|---|
| 230 | Suppose STR is a structure with tags CAT_NO:indgen(10), and |
|---|
| 231 | NAME:strarr(10). Find the indices where STR.CAT_NO is |
|---|
| 232 | between 3 and 5. |
|---|
| 233 | |
|---|
| 234 | IDL> print, WHERE_TAG( str, TAG_NAME = 'CAT_NO', VALUE = [3,4,5] ) ;or |
|---|
| 235 | IDL> print, WHERE_TAG( str, TAG_NUM = 0, RANGE = [3,5]) |
|---|
| 236 | |
|---|
| 237 | </pre><h3>Version history</h3> |
|---|
| 238 | |
|---|
| 239 | <h4>Version</h4> |
|---|
| 240 | $Id: where_tag.pro 232 2007-03-20 16:59:36Z pinsard $ |
|---|
| 241 | |
|---|
| 242 | <h4>History</h4> |
|---|
| 243 | written 1990 Frank Varosi STX @ NASA/GSFC |
|---|
| 244 | Stop printing "Tag <xxx> not found" with /NOPRINT, CD Pike 8-Jun-93 |
|---|
| 245 | |
|---|
| 246 | |
|---|
| 247 | |
|---|
| 248 | <h3>Known issues</h3> |
|---|
| 249 | |
|---|
| 250 | |
|---|
| 251 | |
|---|
| 252 | <h4>Restrictions</h4> |
|---|
| 253 | User *must* specify (1) TAG_NAME or TAG_NUMBER to search, and (2) |
|---|
| 254 | the VALUES or RANGE to search on; |
|---|
| 255 | |
|---|
| 256 | |
|---|
| 257 | |
|---|
| 258 | |
|---|
| 259 | |
|---|
| 260 | |
|---|
| 261 | |
|---|
| 262 | |
|---|
| 263 | |
|---|
| 264 | |
|---|
| 265 | <font size="-3"><p> </p></font> |
|---|
| 266 | <hr size="1" color="#CCCCCC"/> |
|---|
| 267 | |
|---|
| 268 | |
|---|
| 269 | |
|---|
| 270 | |
|---|
| 271 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0.</font></p> |
|---|
| 272 | |
|---|
| 273 | </body> |
|---|
| 274 | </html> |
|---|
