[163] | 1 | |
---|
| 2 | |
---|
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
---|
| 4 | <head> |
---|
| 5 | <title>fitintobox.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="find.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="isadirectory.html"><img src="./../next.gif" border="0" alt="Next"></a></td> |
---|
| 53 | </tr> |
---|
| 54 | </table> |
---|
| 55 | |
---|
| 56 | |
---|
| 57 | <h1><font size="-2">Utilities/</font></h1> |
---|
| 58 | <h2>fitintobox.pro</h2> |
---|
| 59 | |
---|
| 60 | <dl> |
---|
| 61 | </dl> |
---|
| 62 | |
---|
[234] | 63 | |
---|
[163] | 64 | Check that the input array has size and dimensions |
---|
| 65 | compatible with the domain that was defined with the previous call |
---|
[290] | 66 | of <a href="..//ToBeReviewed/GRILLE/domdef.html">domdef</a>. |
---|
[163] | 67 | |
---|
| 68 | |
---|
| 69 | |
---|
| 70 | |
---|
| 71 | |
---|
| 72 | <a name="#_fitintobox"></a> |
---|
| 73 | |
---|
[234] | 74 | <h2>fitintobox <font size="-1" color="#006633"> |
---|
[163] | 75 | Compatibility |
---|
| 76 | </font></h2> |
---|
| 77 | |
---|
[402] | 78 | <p><font face="Courier"><i>result = </i>fitintobox(<i><a href="#_fitintobox_keyword_field">field</a>[, <a href="#_fitintobox_keyword_nx">nx</a>][, <a href="#_fitintobox_keyword_ny">ny</a>][, <a href="#_fitintobox_keyword_nz">nz</a>][, <a href="#_fitintobox_keyword_firstx">firstx</a>][, <a href="#_fitintobox_keyword_firsty">firsty</a>][, <a href="#_fitintobox_keyword_firstz">firstz</a>][, <a href="#_fitintobox_keyword_lastx">lastx</a>][, <a href="#_fitintobox_keyword_lasty">lasty</a>][, <a href="#_fitintobox_keyword_lastz">lastz</a>]</i>, <a href="#_fitintobox_keyword_GRID">GRID</a>=<i>GRID</i>, <a href="#_fitintobox_keyword_WDEPTH">WDEPTH</a>=<i>WDEPTH</i>)</font></p> |
---|
[163] | 79 | |
---|
| 80 | |
---|
| 81 | |
---|
| 82 | |
---|
[234] | 83 | <h3>Return value</h3> |
---|
[402] | 84 | an array with dimensions matching the domain or -1 if there is an error. |
---|
[163] | 85 | |
---|
| 86 | |
---|
| 87 | |
---|
| 88 | <h3>Parameters</h3> |
---|
| 89 | |
---|
| 90 | |
---|
| 91 | <a name="#_fitintobox_keyword_field"></a> |
---|
| 92 | <h4>field |
---|
| 93 | <font size="-1" color="#006633">in</font> |
---|
| 94 | |
---|
| 95 | |
---|
| 96 | <font size="-1" color="#006633">required</font> |
---|
| 97 | |
---|
| 98 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>array or struct</i></font> |
---|
| 99 | |
---|
| 100 | |
---|
| 101 | </h4> |
---|
| 102 | |
---|
| 103 | |
---|
[234] | 104 | an array or a structure that can be read by the function |
---|
[242] | 105 | <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> |
---|
[234] | 106 | |
---|
[163] | 107 | |
---|
| 108 | |
---|
| 109 | <a name="#_fitintobox_keyword_nx"></a> |
---|
| 110 | <h4>nx |
---|
| 111 | <font size="-1" color="#006633">in</font> |
---|
| 112 | |
---|
| 113 | <font size="-1" color="#006633">optional</font> |
---|
| 114 | |
---|
| 115 | |
---|
| 116 | |
---|
[242] | 117 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></i></font> |
---|
[163] | 118 | |
---|
| 119 | </h4> |
---|
| 120 | |
---|
| 121 | |
---|
| 122 | |
---|
| 123 | |
---|
| 124 | |
---|
| 125 | <a name="#_fitintobox_keyword_ny"></a> |
---|
| 126 | <h4>ny |
---|
| 127 | <font size="-1" color="#006633">in</font> |
---|
| 128 | |
---|
| 129 | <font size="-1" color="#006633">optional</font> |
---|
| 130 | |
---|
| 131 | |
---|
| 132 | |
---|
[242] | 133 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></i></font> |
---|
[163] | 134 | |
---|
| 135 | </h4> |
---|
| 136 | |
---|
| 137 | |
---|
| 138 | |
---|
| 139 | |
---|
| 140 | |
---|
| 141 | <a name="#_fitintobox_keyword_nz"></a> |
---|
| 142 | <h4>nz |
---|
| 143 | <font size="-1" color="#006633">in</font> |
---|
| 144 | |
---|
| 145 | <font size="-1" color="#006633">optional</font> |
---|
| 146 | |
---|
| 147 | |
---|
| 148 | |
---|
[242] | 149 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></i></font> |
---|
[163] | 150 | |
---|
| 151 | </h4> |
---|
| 152 | |
---|
| 153 | |
---|
| 154 | |
---|
| 155 | |
---|
| 156 | |
---|
| 157 | <a name="#_fitintobox_keyword_firstx"></a> |
---|
| 158 | <h4>firstx |
---|
| 159 | <font size="-1" color="#006633">in</font> |
---|
| 160 | |
---|
| 161 | <font size="-1" color="#006633">optional</font> |
---|
| 162 | |
---|
| 163 | |
---|
| 164 | |
---|
[242] | 165 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></i></font> |
---|
[163] | 166 | |
---|
| 167 | </h4> |
---|
| 168 | |
---|
| 169 | |
---|
| 170 | |
---|
| 171 | |
---|
| 172 | |
---|
| 173 | <a name="#_fitintobox_keyword_firsty"></a> |
---|
| 174 | <h4>firsty |
---|
| 175 | <font size="-1" color="#006633">in</font> |
---|
| 176 | |
---|
| 177 | <font size="-1" color="#006633">optional</font> |
---|
| 178 | |
---|
| 179 | |
---|
| 180 | |
---|
[242] | 181 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></i></font> |
---|
[163] | 182 | |
---|
| 183 | </h4> |
---|
| 184 | |
---|
| 185 | |
---|
| 186 | |
---|
| 187 | |
---|
| 188 | |
---|
| 189 | <a name="#_fitintobox_keyword_firstz"></a> |
---|
| 190 | <h4>firstz |
---|
| 191 | <font size="-1" color="#006633">in</font> |
---|
| 192 | |
---|
| 193 | <font size="-1" color="#006633">optional</font> |
---|
| 194 | |
---|
| 195 | |
---|
| 196 | |
---|
[242] | 197 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></i></font> |
---|
[163] | 198 | |
---|
| 199 | </h4> |
---|
| 200 | |
---|
| 201 | |
---|
| 202 | |
---|
| 203 | |
---|
| 204 | |
---|
| 205 | <a name="#_fitintobox_keyword_lastx"></a> |
---|
| 206 | <h4>lastx |
---|
| 207 | <font size="-1" color="#006633">in</font> |
---|
| 208 | |
---|
| 209 | <font size="-1" color="#006633">optional</font> |
---|
| 210 | |
---|
| 211 | |
---|
| 212 | |
---|
[242] | 213 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></i></font> |
---|
[163] | 214 | |
---|
| 215 | </h4> |
---|
| 216 | |
---|
| 217 | |
---|
| 218 | |
---|
| 219 | |
---|
| 220 | |
---|
| 221 | <a name="#_fitintobox_keyword_lasty"></a> |
---|
| 222 | <h4>lasty |
---|
| 223 | <font size="-1" color="#006633">in</font> |
---|
| 224 | |
---|
| 225 | <font size="-1" color="#006633">optional</font> |
---|
| 226 | |
---|
| 227 | |
---|
| 228 | |
---|
[242] | 229 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></i></font> |
---|
[163] | 230 | |
---|
| 231 | </h4> |
---|
| 232 | |
---|
| 233 | |
---|
| 234 | |
---|
| 235 | |
---|
| 236 | |
---|
| 237 | <a name="#_fitintobox_keyword_lastz"></a> |
---|
| 238 | <h4>lastz |
---|
| 239 | <font size="-1" color="#006633">in</font> |
---|
| 240 | |
---|
| 241 | <font size="-1" color="#006633">optional</font> |
---|
| 242 | |
---|
| 243 | |
---|
| 244 | |
---|
[242] | 245 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></i></font> |
---|
[163] | 246 | |
---|
| 247 | </h4> |
---|
| 248 | |
---|
| 249 | |
---|
| 250 | |
---|
| 251 | |
---|
| 252 | |
---|
| 253 | |
---|
| 254 | |
---|
| 255 | <h3>Keywords</h3> |
---|
| 256 | |
---|
| 257 | |
---|
[402] | 258 | <a name="#_fitintobox_keyword_GRID"></a> |
---|
| 259 | <h4>GRID |
---|
| 260 | |
---|
| 261 | |
---|
| 262 | |
---|
| 263 | |
---|
| 264 | |
---|
| 265 | |
---|
| 266 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>vargrid defined in <a href="..//Commons/cm_4data.html">cm_4data</a></i></font> |
---|
| 267 | |
---|
| 268 | </h4> |
---|
| 269 | |
---|
| 270 | |
---|
| 271 | To specify on which grid are located the data, see <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a> |
---|
| 272 | |
---|
| 273 | |
---|
[163] | 274 | <a name="#_fitintobox_keyword_WDEPTH"></a> |
---|
| 275 | <h4>WDEPTH |
---|
| 276 | |
---|
| 277 | |
---|
| 278 | |
---|
| 279 | |
---|
| 280 | |
---|
| 281 | |
---|
[402] | 282 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> |
---|
[163] | 283 | |
---|
| 284 | </h4> |
---|
| 285 | |
---|
[234] | 286 | |
---|
[402] | 287 | To specify that we are at W level, see <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a> |
---|
[163] | 288 | |
---|
| 289 | |
---|
| 290 | |
---|
| 291 | |
---|
[234] | 292 | <h3>Examples</h3><pre> |
---|
[402] | 293 | |
---|
| 294 | IDL> help, fitintobox(findgen(jpi,jpj)) |
---|
[163] | 295 | <Expression> FLOAT = Array[41, 3] |
---|
[402] | 296 | IDL> help, fitintobox(findgen(jpi,jpj,78)) |
---|
[234] | 297 | Error: |
---|
[163] | 298 | the array dimensions [180,148,78] are incompatible |
---|
[242] | 299 | with the domain dimensions |
---|
[163] | 300 | [jpi/nx, jpj/ny, jpk/nz, jpt] = [180/41, 148/3, 31/31, 1] |
---|
| 301 | <Expression> INT = -1 |
---|
| 302 | |
---|
[234] | 303 | </pre><h3>Version history</h3> |
---|
[163] | 304 | |
---|
[234] | 305 | <h4>Version</h4> |
---|
[402] | 306 | $Id: fitintobox.pro 388 2008-12-09 09:36:41Z smasson $ |
---|
[242] | 307 | |
---|
[234] | 308 | <h4>History</h4> |
---|
| 309 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
---|
[163] | 310 | 10 juin 2000. |
---|
| 311 | June 2005: S. Masson rewrite all. |
---|
| 312 | |
---|
| 313 | |
---|
| 314 | |
---|
| 315 | |
---|
| 316 | |
---|
| 317 | |
---|
| 318 | |
---|
| 319 | |
---|
| 320 | |
---|
| 321 | <h3>Other attributes</h3> |
---|
| 322 | |
---|
| 323 | |
---|
[242] | 324 | <h4>Uses routines</h4> |
---|
[402] | 325 | <a href="..//Commons/cm_4mesh.html">cm_4mesh</a> |
---|
| 326 | <a href="..//Commons/cm_4cal.html">cm_4cal</a> |
---|
[163] | 327 | |
---|
| 328 | |
---|
| 329 | |
---|
| 330 | |
---|
| 331 | |
---|
| 332 | <font size="-3"><p> </p></font> |
---|
| 333 | <hr size="1" color="#CCCCCC"/> |
---|
| 334 | |
---|
| 335 | |
---|
| 336 | |
---|
| 337 | |
---|
[187] | 338 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0.</font></p> |
---|
[163] | 339 | |
---|
| 340 | </body> |
---|
[249] | 341 | </html> |
---|