[138] | 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>fitintobox.pro (SAXO Documentation)</title> |
---|
| 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" /> |
---|
[138] | 14 | |
---|
| 15 | |
---|
| 16 | <script type="text/javascript"> |
---|
| 17 | function setTitle() { |
---|
| 18 | parent.document.title="fitintobox.pro (SAXO Documentation)"; |
---|
| 19 | } |
---|
| 20 | </script> |
---|
| 21 | </head> |
---|
| 22 | |
---|
| 23 | <body onload="setTitle();"> |
---|
| 24 | |
---|
| 25 | <div id="navbar_title"> |
---|
| 26 | <h1>SAXO Documentation</h1> |
---|
| 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> |
---|
[138] | 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> |
---|
[138] | 44 | |
---|
| 45 | |
---|
| 46 | |
---|
[189] | 47 | <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td> |
---|
[138] | 48 | |
---|
| 49 | |
---|
| 50 | |
---|
[189] | 51 | <td><a href="./../search-page.html" title="Search library">Search</a></td> |
---|
[138] | 52 | |
---|
| 53 | |
---|
| 54 | <td id="selected">File</td> |
---|
| 55 | |
---|
| 56 | |
---|
[189] | 57 | <td><a href="../../../Utilities//fitintobox.pro" title="Source code of a file">Source</a></td> |
---|
[138] | 58 | |
---|
| 59 | |
---|
| 60 | |
---|
[189] | 61 | <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td> |
---|
[138] | 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="find.html"><<prev file</a> | <a href="isadirectory.html">next file >></a> <a href="fitintobox.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> |
---|
[138] | 75 | |
---|
| 76 | </div> |
---|
| 77 | |
---|
| 78 | |
---|
| 79 | <div id="container"> |
---|
| 80 | |
---|
[189] | 81 | <h1 class="directory"><a href="directory-overview.html">Utilities/</a></h1> |
---|
[138] | 82 | <h2 class="pro_file">fitintobox.pro</h2> |
---|
| 83 | |
---|
| 84 | <div id="file_attr"> |
---|
| 85 | <dl> |
---|
| 86 | </dl> |
---|
| 87 | </div> |
---|
| 88 | |
---|
[234] | 89 | <div id="file_comments"> |
---|
[138] | 90 | Check that the input array has size and dimensions |
---|
| 91 | compatible with the domain that was defined with the previous call |
---|
[290] | 92 | of <a href="..//ToBeReviewed/GRILLE/domdef.html">domdef</a>. |
---|
[138] | 93 | </div> |
---|
| 94 | |
---|
| 95 | |
---|
| 96 | |
---|
| 97 | |
---|
| 98 | |
---|
| 99 | |
---|
| 100 | |
---|
| 101 | |
---|
| 102 | |
---|
| 103 | <div id="routine_details"> |
---|
| 104 | |
---|
| 105 | |
---|
| 106 | <div class="routine_details" id="_fitintobox"> |
---|
| 107 | |
---|
[234] | 108 | <h2><a class="top" href="#container">top</a>fitintobox <span class="categories"> |
---|
[157] | 109 | Compatibility |
---|
[138] | 110 | </span></h2> |
---|
| 111 | |
---|
| 112 | <p class="header"> |
---|
[402] | 113 | <span class="result">result = </span>fitintobox(<span class="result"><a href="#_fitintobox_param_field">field</a>[, <a href="#_fitintobox_param_nx">nx</a>][, <a href="#_fitintobox_param_ny">ny</a>][, <a href="#_fitintobox_param_nz">nz</a>][, <a href="#_fitintobox_param_firstx">firstx</a>][, <a href="#_fitintobox_param_firsty">firsty</a>][, <a href="#_fitintobox_param_firstz">firstz</a>][, <a href="#_fitintobox_param_lastx">lastx</a>][, <a href="#_fitintobox_param_lasty">lasty</a>][, <a href="#_fitintobox_param_lastz">lastz</a>]</span>, <a href="#_fitintobox_keyword_GRID">GRID</a>=<span class="result">GRID</span>, <a href="#_fitintobox_keyword_WDEPTH">WDEPTH</a>=<span class="result">WDEPTH</span>)</p> |
---|
[138] | 114 | |
---|
| 115 | <div class="comments"> |
---|
| 116 | </div> |
---|
| 117 | |
---|
[234] | 118 | <h3>Return value</h3><div class="preformat"> |
---|
[402] | 119 | an array with dimensions matching the domain or -1 if there is an error. |
---|
[138] | 120 | </div> |
---|
| 121 | |
---|
| 122 | |
---|
| 123 | <h3>Parameters</h3> |
---|
| 124 | |
---|
| 125 | |
---|
| 126 | <h4 id="_fitintobox_param_field">field |
---|
| 127 | <span class="attr">in</span> |
---|
| 128 | |
---|
| 129 | |
---|
| 130 | <span class="attr">required</span> |
---|
| 131 | |
---|
[163] | 132 | <span class="attr">type:</span> <span class="value">array or struct</span> |
---|
[138] | 133 | |
---|
| 134 | |
---|
| 135 | </h4> |
---|
| 136 | |
---|
[163] | 137 | <div class="comments"> |
---|
[234] | 138 | an array or a structure that can be read by the function |
---|
[242] | 139 | <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> |
---|
[234] | 140 | </div> |
---|
[138] | 141 | |
---|
| 142 | <h4 id="_fitintobox_param_nx">nx |
---|
| 143 | <span class="attr">in</span> |
---|
| 144 | |
---|
| 145 | <span class="attr">optional</span> |
---|
| 146 | |
---|
| 147 | |
---|
| 148 | |
---|
[242] | 149 | <span class="attr">default:</span> <span class="value">define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></span> |
---|
[138] | 150 | |
---|
| 151 | </h4> |
---|
| 152 | |
---|
| 153 | <div class="comments"> |
---|
| 154 | </div> |
---|
| 155 | |
---|
| 156 | <h4 id="_fitintobox_param_ny">ny |
---|
| 157 | <span class="attr">in</span> |
---|
| 158 | |
---|
| 159 | <span class="attr">optional</span> |
---|
| 160 | |
---|
| 161 | |
---|
| 162 | |
---|
[242] | 163 | <span class="attr">default:</span> <span class="value">define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></span> |
---|
[138] | 164 | |
---|
| 165 | </h4> |
---|
| 166 | |
---|
| 167 | <div class="comments"> |
---|
| 168 | </div> |
---|
| 169 | |
---|
| 170 | <h4 id="_fitintobox_param_nz">nz |
---|
| 171 | <span class="attr">in</span> |
---|
| 172 | |
---|
| 173 | <span class="attr">optional</span> |
---|
| 174 | |
---|
| 175 | |
---|
| 176 | |
---|
[242] | 177 | <span class="attr">default:</span> <span class="value">define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></span> |
---|
[138] | 178 | |
---|
| 179 | </h4> |
---|
| 180 | |
---|
| 181 | <div class="comments"> |
---|
| 182 | </div> |
---|
| 183 | |
---|
| 184 | <h4 id="_fitintobox_param_firstx">firstx |
---|
| 185 | <span class="attr">in</span> |
---|
| 186 | |
---|
| 187 | <span class="attr">optional</span> |
---|
| 188 | |
---|
| 189 | |
---|
| 190 | |
---|
[242] | 191 | <span class="attr">default:</span> <span class="value">define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></span> |
---|
[138] | 192 | |
---|
| 193 | </h4> |
---|
| 194 | |
---|
| 195 | <div class="comments"> |
---|
| 196 | </div> |
---|
| 197 | |
---|
| 198 | <h4 id="_fitintobox_param_firsty">firsty |
---|
| 199 | <span class="attr">in</span> |
---|
| 200 | |
---|
| 201 | <span class="attr">optional</span> |
---|
| 202 | |
---|
| 203 | |
---|
| 204 | |
---|
[242] | 205 | <span class="attr">default:</span> <span class="value">define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></span> |
---|
[138] | 206 | |
---|
| 207 | </h4> |
---|
| 208 | |
---|
| 209 | <div class="comments"> |
---|
| 210 | </div> |
---|
| 211 | |
---|
| 212 | <h4 id="_fitintobox_param_firstz">firstz |
---|
| 213 | <span class="attr">in</span> |
---|
| 214 | |
---|
| 215 | <span class="attr">optional</span> |
---|
| 216 | |
---|
| 217 | |
---|
| 218 | |
---|
[242] | 219 | <span class="attr">default:</span> <span class="value">define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></span> |
---|
[138] | 220 | |
---|
| 221 | </h4> |
---|
| 222 | |
---|
| 223 | <div class="comments"> |
---|
| 224 | </div> |
---|
| 225 | |
---|
| 226 | <h4 id="_fitintobox_param_lastx">lastx |
---|
| 227 | <span class="attr">in</span> |
---|
| 228 | |
---|
| 229 | <span class="attr">optional</span> |
---|
| 230 | |
---|
| 231 | |
---|
| 232 | |
---|
[242] | 233 | <span class="attr">default:</span> <span class="value">define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></span> |
---|
[138] | 234 | |
---|
| 235 | </h4> |
---|
| 236 | |
---|
| 237 | <div class="comments"> |
---|
| 238 | </div> |
---|
| 239 | |
---|
| 240 | <h4 id="_fitintobox_param_lasty">lasty |
---|
| 241 | <span class="attr">in</span> |
---|
| 242 | |
---|
| 243 | <span class="attr">optional</span> |
---|
| 244 | |
---|
| 245 | |
---|
| 246 | |
---|
[242] | 247 | <span class="attr">default:</span> <span class="value">define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></span> |
---|
[138] | 248 | |
---|
| 249 | </h4> |
---|
| 250 | |
---|
| 251 | <div class="comments"> |
---|
| 252 | </div> |
---|
| 253 | |
---|
| 254 | <h4 id="_fitintobox_param_lastz">lastz |
---|
| 255 | <span class="attr">in</span> |
---|
| 256 | |
---|
| 257 | <span class="attr">optional</span> |
---|
| 258 | |
---|
| 259 | |
---|
| 260 | |
---|
[242] | 261 | <span class="attr">default:</span> <span class="value">define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></span> |
---|
[138] | 262 | |
---|
| 263 | </h4> |
---|
| 264 | |
---|
| 265 | <div class="comments"> |
---|
| 266 | </div> |
---|
| 267 | |
---|
| 268 | |
---|
| 269 | |
---|
| 270 | |
---|
| 271 | |
---|
| 272 | |
---|
| 273 | <h3>Keywords</h3> |
---|
| 274 | |
---|
[402] | 275 | <h4 id="_fitintobox_keyword_GRID">GRID |
---|
| 276 | |
---|
| 277 | |
---|
| 278 | |
---|
| 279 | |
---|
| 280 | |
---|
| 281 | |
---|
| 282 | <span class="attr">default:</span> <span class="value">vargrid defined in <a href="..//Commons/cm_4data.html">cm_4data</a></span> |
---|
| 283 | |
---|
| 284 | </h4> |
---|
| 285 | |
---|
| 286 | <div class="comments"> |
---|
| 287 | To specify on which grid are located the data, see <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a> |
---|
| 288 | </div> |
---|
| 289 | |
---|
[138] | 290 | <h4 id="_fitintobox_keyword_WDEPTH">WDEPTH |
---|
| 291 | |
---|
| 292 | |
---|
| 293 | |
---|
| 294 | |
---|
| 295 | |
---|
| 296 | |
---|
[402] | 297 | <span class="attr">default:</span> <span class="value">0</span> |
---|
[138] | 298 | |
---|
| 299 | </h4> |
---|
| 300 | |
---|
[234] | 301 | <div class="comments"> |
---|
[402] | 302 | To specify that we are at W level, see <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a> |
---|
[138] | 303 | </div> |
---|
| 304 | |
---|
| 305 | |
---|
| 306 | |
---|
[234] | 307 | <h3>Examples</h3><div class="preformat"> |
---|
[402] | 308 | |
---|
| 309 | IDL> help, fitintobox(findgen(jpi,jpj)) |
---|
[138] | 310 | <Expression> FLOAT = Array[41, 3] |
---|
[402] | 311 | IDL> help, fitintobox(findgen(jpi,jpj,78)) |
---|
[234] | 312 | Error: |
---|
[138] | 313 | the array dimensions [180,148,78] are incompatible |
---|
[242] | 314 | with the domain dimensions |
---|
[138] | 315 | [jpi/nx, jpj/ny, jpk/nz, jpt] = [180/41, 148/3, 31/31, 1] |
---|
| 316 | <Expression> INT = -1 |
---|
| 317 | </div> |
---|
| 318 | <h3>Version history</h3> |
---|
| 319 | |
---|
[234] | 320 | <h4>Version</h4><div class="preformat"> |
---|
[402] | 321 | $Id: fitintobox.pro 388 2008-12-09 09:36:41Z smasson $ |
---|
[242] | 322 | </div> |
---|
[234] | 323 | <h4>History</h4><div class="preformat"> |
---|
| 324 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
---|
[138] | 325 | 10 juin 2000. |
---|
| 326 | June 2005: S. Masson rewrite all. |
---|
| 327 | </div> |
---|
| 328 | |
---|
| 329 | |
---|
| 330 | |
---|
| 331 | |
---|
| 332 | |
---|
| 333 | |
---|
| 334 | |
---|
| 335 | |
---|
| 336 | <h3>Other attributes</h3> |
---|
| 337 | |
---|
| 338 | |
---|
[242] | 339 | <h4>Uses routines</h4><div class="preformat"> |
---|
[402] | 340 | <a href="..//Commons/cm_4mesh.html">cm_4mesh</a> |
---|
| 341 | <a href="..//Commons/cm_4cal.html">cm_4cal</a> |
---|
[138] | 342 | </div> |
---|
| 343 | |
---|
| 344 | |
---|
| 345 | |
---|
| 346 | |
---|
[163] | 347 | <h3>Statistics</h3> |
---|
| 348 | <table class="statistics"> |
---|
| 349 | <tr><td>McCabe cyclic</td><td> 66</td></tr> |
---|
| 350 | <tr><td>McCabe essential</td><td> 1</td></tr> |
---|
| 351 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
---|
| 352 | </table> |
---|
[138] | 353 | |
---|
| 354 | |
---|
| 355 | </div> |
---|
| 356 | |
---|
| 357 | </div> |
---|
| 358 | |
---|
| 359 | |
---|
| 360 | |
---|
| 361 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
| 362 | |
---|
| 363 | </div> |
---|
| 364 | |
---|
| 365 | </body> |
---|
[249] | 366 | </html> |
---|