[163] | 1 | |
---|
| 2 | |
---|
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
---|
| 4 | <head> |
---|
| 5 | <title>extractstru.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="chkstru.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="mixstru.html"><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>extractstru.pro</h2> |
---|
| 59 | |
---|
| 60 | <dl> |
---|
| 61 | </dl> |
---|
| 62 | |
---|
| 63 | |
---|
| 64 | extract elements of a structure to constitute a new structure. |
---|
| 65 | |
---|
| 66 | |
---|
| 67 | |
---|
| 68 | |
---|
| 69 | |
---|
| 70 | <a name="#_extractstru"></a> |
---|
| 71 | |
---|
| 72 | <h2>extractstru <font size="-1" color="#006633"> |
---|
| 73 | Utilities |
---|
| 74 | </font></h2> |
---|
| 75 | |
---|
| 76 | <p><font face="Courier"><i>result = </i>extractstru(<i><a href="#_extractstru_keyword_stru">stru</a>, <a href="#_extractstru_keyword_liste">liste</a></i>, <a href="#_extractstru_keyword_KEEP">KEEP</a>=<i>KEEP</i>, <a href="#_extractstru_keyword_DELETE">DELETE</a>=<i>DELETE</i>)</font></p> |
---|
| 77 | |
---|
| 78 | |
---|
| 79 | |
---|
| 80 | <h3>Return value</h3> |
---|
| 81 | A structure or -1 in case of problem |
---|
| 82 | |
---|
| 83 | |
---|
| 84 | |
---|
| 85 | <h3>Parameters</h3> |
---|
| 86 | |
---|
| 87 | |
---|
| 88 | <a name="#_extractstru_keyword_stru"></a> |
---|
| 89 | <h4>stru |
---|
| 90 | <font size="-1" color="#006633">in</font> |
---|
| 91 | |
---|
| 92 | |
---|
| 93 | <font size="-1" color="#006633">required</font> |
---|
| 94 | |
---|
| 95 | |
---|
| 96 | |
---|
| 97 | |
---|
| 98 | </h4> |
---|
| 99 | |
---|
| 100 | |
---|
| 101 | A structure |
---|
| 102 | |
---|
| 103 | |
---|
| 104 | |
---|
| 105 | <a name="#_extractstru_keyword_liste"></a> |
---|
| 106 | <h4>liste |
---|
| 107 | <font size="-1" color="#006633">in</font> |
---|
| 108 | |
---|
| 109 | |
---|
| 110 | <font size="-1" color="#006633">required</font> |
---|
| 111 | |
---|
| 112 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font> |
---|
| 113 | |
---|
| 114 | |
---|
| 115 | </h4> |
---|
| 116 | |
---|
| 117 | |
---|
[234] | 118 | A vector of string including names of STRU to be deleted |
---|
[163] | 119 | (by default) or to be kept (if KEEP is activated). |
---|
| 120 | |
---|
| 121 | |
---|
| 122 | |
---|
| 123 | |
---|
| 124 | |
---|
| 125 | <h3>Keywords</h3> |
---|
| 126 | |
---|
| 127 | |
---|
| 128 | <a name="#_extractstru_keyword_KEEP"></a> |
---|
| 129 | <h4>KEEP |
---|
| 130 | |
---|
| 131 | |
---|
| 132 | |
---|
| 133 | |
---|
| 134 | |
---|
| 135 | |
---|
| 136 | |
---|
| 137 | |
---|
| 138 | </h4> |
---|
| 139 | |
---|
| 140 | |
---|
| 141 | Specify that the given liste concern elements of STRU to be kept. |
---|
| 142 | |
---|
| 143 | |
---|
| 144 | <a name="#_extractstru_keyword_DELETE"></a> |
---|
| 145 | <h4>DELETE |
---|
| 146 | |
---|
| 147 | |
---|
| 148 | |
---|
| 149 | |
---|
| 150 | |
---|
| 151 | |
---|
| 152 | |
---|
| 153 | |
---|
| 154 | </h4> |
---|
| 155 | |
---|
| 156 | |
---|
| 157 | Specify that the given liste concern elements of STRU to be deleted. |
---|
[402] | 158 | |
---|
[163] | 159 | This keyword is activated by default. |
---|
| 160 | |
---|
| 161 | |
---|
| 162 | |
---|
| 163 | |
---|
[234] | 164 | <h3>Examples</h3><pre> |
---|
[163] | 165 | |
---|
[402] | 166 | IDL> extra=get_extra(/ok, year=1999, age_capitaine=35 ) |
---|
| 167 | IDL> help, extra,/struct |
---|
[163] | 168 | ** Structure <83e66bc>, 3 tags, length=6, refs=1: |
---|
| 169 | AGE_CAPITAINE INT 35 |
---|
| 170 | OK INT 1 |
---|
| 171 | YEAR INT 1999 |
---|
[402] | 172 | IDL> help, extractstru(extra,['ok','hhuihi','YEAR']),/stru |
---|
[163] | 173 | ** Structure <831afac>, 1 tags, length=2, refs=1: |
---|
| 174 | AGE_CAPITAINE INT 35 |
---|
[402] | 175 | IDL> help, extractstru(extra,['ok','hhuihi','YEAR'],/keep),/stru |
---|
[163] | 176 | ** Structure <834bbc4>, 2 tags, length=4, refs=1: |
---|
| 177 | OK INT 1 |
---|
| 178 | YEAR INT 1999 |
---|
| 179 | |
---|
[234] | 180 | </pre><h3>Version history</h3> |
---|
[163] | 181 | |
---|
| 182 | <h4>Version</h4> |
---|
[402] | 183 | $Id: extractstru.pro 375 2008-08-08 15:55:40Z pinsard $ |
---|
[234] | 184 | |
---|
[163] | 185 | <h4>History</h4> |
---|
| 186 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
---|
| 187 | 8/10/1999 |
---|
| 188 | |
---|
| 189 | |
---|
| 190 | |
---|
| 191 | |
---|
| 192 | |
---|
| 193 | |
---|
| 194 | |
---|
| 195 | |
---|
| 196 | |
---|
| 197 | |
---|
| 198 | |
---|
| 199 | |
---|
| 200 | |
---|
| 201 | |
---|
| 202 | |
---|
| 203 | |
---|
| 204 | |
---|
| 205 | <font size="-3"><p> </p></font> |
---|
| 206 | <hr size="1" color="#CCCCCC"/> |
---|
| 207 | |
---|
| 208 | |
---|
| 209 | |
---|
| 210 | |
---|
[187] | 211 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0.</font></p> |
---|
[163] | 212 | |
---|
| 213 | </body> |
---|
[249] | 214 | </html> |
---|