| 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>grossemoyenne.pro (SAXO 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="grossemoyenne.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 | |
|---|
| 35 | <td><a href="./../../overview.html" title="Overview of library">Overview</a></td> |
|---|
| 36 | |
|---|
| 37 | |
|---|
| 38 | |
|---|
| 39 | <td >Directory</td> |
|---|
| 40 | |
|---|
| 41 | |
|---|
| 42 | |
|---|
| 43 | <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td> |
|---|
| 44 | |
|---|
| 45 | |
|---|
| 46 | |
|---|
| 47 | <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td> |
|---|
| 48 | |
|---|
| 49 | |
|---|
| 50 | |
|---|
| 51 | <td><a href="./../../search-page.html" title="Search library">Search</a></td> |
|---|
| 52 | |
|---|
| 53 | |
|---|
| 54 | <td id="selected">File</td> |
|---|
| 55 | |
|---|
| 56 | |
|---|
| 57 | <td><a href="../../../../ToBeReviewed/CALCULS//grossemoyenne.pro" title="Source code of a file">Source</a></td> |
|---|
| 58 | |
|---|
| 59 | |
|---|
| 60 | |
|---|
| 61 | <td><a href="./../../idldoc-help.html" 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="fsfzpt.html"><<prev file</a> | <a href="hdyn.html">next file >></a> <a href="grossemoyenne.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> |
|---|
| 75 | |
|---|
| 76 | </div> |
|---|
| 77 | |
|---|
| 78 | |
|---|
| 79 | <div id="container"> |
|---|
| 80 | |
|---|
| 81 | <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/CALCULS/</a></h1> |
|---|
| 82 | <h2 class="pro_file">grossemoyenne.pro</h2> |
|---|
| 83 | |
|---|
| 84 | <div id="file_attr"> |
|---|
| 85 | <dl> |
|---|
| 86 | </dl> |
|---|
| 87 | </div> |
|---|
| 88 | |
|---|
| 89 | <div id="file_comments"> |
|---|
| 90 | averages a 3- or 4-d time series field over a selected |
|---|
| 91 | geographical area or along the time axis. For one ore more |
|---|
| 92 | selected axes (x, y, z, t) |
|---|
| 93 | </div> |
|---|
| 94 | |
|---|
| 95 | |
|---|
| 96 | |
|---|
| 97 | |
|---|
| 98 | |
|---|
| 99 | |
|---|
| 100 | |
|---|
| 101 | |
|---|
| 102 | |
|---|
| 103 | <div id="routine_details"> |
|---|
| 104 | |
|---|
| 105 | |
|---|
| 106 | <div class="routine_details" id="_grossemoyenne"> |
|---|
| 107 | |
|---|
| 108 | <h2><a class="top" href="#container">top</a>grossemoyenne <span class="categories"> |
|---|
| 109 | </span></h2> |
|---|
| 110 | |
|---|
| 111 | <p class="header"> |
|---|
| 112 | <span class="result">result = </span>grossemoyenne(<span class="result"><a href="#_grossemoyenne_param_tab">tab</a>, <a href="#_grossemoyenne_param_direc">direc</a></span>, <a href="#_grossemoyenne_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_grossemoyenne_keyword_INTEGRATION">INTEGRATION</a>=<span class="result">INTEGRATION</span>, <a href="#_grossemoyenne_keyword_NAN">NAN</a>=<span class="result">NAN</span>, <a href="#_grossemoyenne_keyword_NODOMDEF">NODOMDEF</a>=<span class="result">NODOMDEF</span>, <a href="#_grossemoyenne_keyword_WDEPTH">WDEPTH</a>=<span class="result">WDEPTH</span>, <a href="#_grossemoyenne_keyword_SPATIALFIRST">SPATIALFIRST</a>=<span class="result">SPATIALFIRST</span>, <a href="#_grossemoyenne_keyword_TEMPORALFIRST">TEMPORALFIRST</a>=<span class="result">TEMPORALFIRST</span>, <a href="#_grossemoyenne_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> |
|---|
| 113 | |
|---|
| 114 | <div class="comments"> |
|---|
| 115 | </div> |
|---|
| 116 | |
|---|
| 117 | |
|---|
| 118 | |
|---|
| 119 | |
|---|
| 120 | <h3>Parameters</h3> |
|---|
| 121 | |
|---|
| 122 | |
|---|
| 123 | <h4 id="_grossemoyenne_param_tab">tab |
|---|
| 124 | <span class="attr">in</span> |
|---|
| 125 | |
|---|
| 126 | |
|---|
| 127 | <span class="attr">required</span> |
|---|
| 128 | |
|---|
| 129 | |
|---|
| 130 | |
|---|
| 131 | |
|---|
| 132 | </h4> |
|---|
| 133 | |
|---|
| 134 | <div class="comments"> |
|---|
| 135 | 3 or 4d field |
|---|
| 136 | </div> |
|---|
| 137 | |
|---|
| 138 | <h4 id="_grossemoyenne_param_direc">direc |
|---|
| 139 | <span class="attr">in</span> |
|---|
| 140 | |
|---|
| 141 | |
|---|
| 142 | <span class="attr">required</span> |
|---|
| 143 | |
|---|
| 144 | |
|---|
| 145 | |
|---|
| 146 | |
|---|
| 147 | </h4> |
|---|
| 148 | |
|---|
| 149 | <div class="comments"> |
|---|
| 150 | 'x' 'y' 'z' 't' 'xy' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' |
|---|
| 151 | 'xyt' 'xzt' 'yzt' or 'xyzt' |
|---|
| 152 | </div> |
|---|
| 153 | |
|---|
| 154 | |
|---|
| 155 | |
|---|
| 156 | |
|---|
| 157 | |
|---|
| 158 | |
|---|
| 159 | <h3>Keywords</h3> |
|---|
| 160 | |
|---|
| 161 | <h4 id="_grossemoyenne_keyword_BOXZOOM">BOXZOOM |
|---|
| 162 | |
|---|
| 163 | |
|---|
| 164 | |
|---|
| 165 | |
|---|
| 166 | |
|---|
| 167 | |
|---|
| 168 | |
|---|
| 169 | |
|---|
| 170 | </h4> |
|---|
| 171 | |
|---|
| 172 | <div class="comments"> |
|---|
| 173 | [xmin,xmax,ymin,ymax (,(zmin,)zmax)] to more details, see domdef |
|---|
| 174 | boxzoom can have 5 forms: |
|---|
| 175 | [vert2], [vert1, vert2],[lon1, lon2, lat1, lat2], |
|---|
| 176 | [lon1, lon2, lat1, lat2, vert2],[lon1, lon2, lat1, lat2, vert1,vert2] |
|---|
| 177 | </div> |
|---|
| 178 | |
|---|
| 179 | <h4 id="_grossemoyenne_keyword_INTEGRATION">INTEGRATION |
|---|
| 180 | |
|---|
| 181 | |
|---|
| 182 | |
|---|
| 183 | |
|---|
| 184 | |
|---|
| 185 | |
|---|
| 186 | |
|---|
| 187 | |
|---|
| 188 | </h4> |
|---|
| 189 | |
|---|
| 190 | <div class="comments"> |
|---|
| 191 | To make an integral rather than an average |
|---|
| 192 | </div> |
|---|
| 193 | |
|---|
| 194 | <h4 id="_grossemoyenne_keyword_NAN">NAN |
|---|
| 195 | |
|---|
| 196 | |
|---|
| 197 | |
|---|
| 198 | |
|---|
| 199 | |
|---|
| 200 | |
|---|
| 201 | |
|---|
| 202 | |
|---|
| 203 | </h4> |
|---|
| 204 | |
|---|
| 205 | <div class="comments"> |
|---|
| 206 | not a number, we activate it if we want to average without considerate some |
|---|
| 207 | masked values of TAB. |
|---|
| 208 | If masked values of TAB are values consecrated by IDL(!values.f_nan), we |
|---|
| 209 | just have to put NAN. |
|---|
| 210 | If masked values of TAB are valued a (a must be different of 1, |
|---|
| 211 | corresponding to nan = !values.f_nan and of 0, which desactivate nan). |
|---|
| 212 | We have to put NAN=a. |
|---|
| 213 | Comment: In output, rsult points which are NAN will be valued a or |
|---|
| 214 | !values.f_nan. |
|---|
| 215 | </div> |
|---|
| 216 | |
|---|
| 217 | <h4 id="_grossemoyenne_keyword_NODOMDEF">NODOMDEF |
|---|
| 218 | |
|---|
| 219 | |
|---|
| 220 | |
|---|
| 221 | |
|---|
| 222 | |
|---|
| 223 | |
|---|
| 224 | |
|---|
| 225 | |
|---|
| 226 | </h4> |
|---|
| 227 | |
|---|
| 228 | <div class="comments"> |
|---|
| 229 | We activate it if we do not want to pass in domdef even if the keyword |
|---|
| 230 | boxzoom is present (like when grossemoyenne is called via checkfield) |
|---|
| 231 | </div> |
|---|
| 232 | |
|---|
| 233 | <h4 id="_grossemoyenne_keyword_WDEPTH">WDEPTH |
|---|
| 234 | |
|---|
| 235 | |
|---|
| 236 | |
|---|
| 237 | |
|---|
| 238 | |
|---|
| 239 | |
|---|
| 240 | |
|---|
| 241 | |
|---|
| 242 | </h4> |
|---|
| 243 | |
|---|
| 244 | <div class="comments"> |
|---|
| 245 | to specify that the field is at W depth instead of T |
|---|
| 246 | depth (automatically activated if vargrid eq 'W') |
|---|
| 247 | </div> |
|---|
| 248 | |
|---|
| 249 | <h4 id="_grossemoyenne_keyword_SPATIALFIRST">SPATIALFIRST |
|---|
| 250 | |
|---|
| 251 | |
|---|
| 252 | |
|---|
| 253 | |
|---|
| 254 | |
|---|
| 255 | |
|---|
| 256 | |
|---|
| 257 | |
|---|
| 258 | </h4> |
|---|
| 259 | |
|---|
| 260 | <div class="comments"> |
|---|
| 261 | when performing at the same time |
|---|
| 262 | spatial and temporal mean, grossemoyenne is assuming |
|---|
| 263 | that the mask is not changing with the time. In |
|---|
| 264 | consequence, grossemoyenne performs temporal mean |
|---|
| 265 | first and then call moyenne. Activate /SPATIALFIRST if |
|---|
| 266 | you want to perform the spatial mean before the |
|---|
| 267 | temporal mean. Note that if NAN is activated, then |
|---|
| 268 | SPATIALFIRST is activated automatically. |
|---|
| 269 | </div> |
|---|
| 270 | |
|---|
| 271 | <h4 id="_grossemoyenne_keyword_TEMPORALFIRST">TEMPORALFIRST |
|---|
| 272 | |
|---|
| 273 | |
|---|
| 274 | |
|---|
| 275 | |
|---|
| 276 | |
|---|
| 277 | |
|---|
| 278 | |
|---|
| 279 | |
|---|
| 280 | </h4> |
|---|
| 281 | |
|---|
| 282 | <div class="comments"> |
|---|
| 283 | to force to perform first temporal |
|---|
| 284 | mean even if nan is activated (see SPATIALFIRST explanations...) |
|---|
| 285 | </div> |
|---|
| 286 | |
|---|
| 287 | <h4 id="_grossemoyenne_keyword__EXTRA">_EXTRA |
|---|
| 288 | |
|---|
| 289 | |
|---|
| 290 | |
|---|
| 291 | |
|---|
| 292 | |
|---|
| 293 | |
|---|
| 294 | |
|---|
| 295 | |
|---|
| 296 | </h4> |
|---|
| 297 | |
|---|
| 298 | <div class="comments"></div> |
|---|
| 299 | |
|---|
| 300 | |
|---|
| 301 | |
|---|
| 302 | |
|---|
| 303 | <h3>Version history</h3> |
|---|
| 304 | |
|---|
| 305 | <h4>Version</h4><div class="preformat"> |
|---|
| 306 | $Id: grossemoyenne.pro 232 2007-03-20 16:59:36Z pinsard $</div> |
|---|
| 307 | <h4>History</h4><div class="preformat"> |
|---|
| 308 | Jerome Vialard (jv@lodyc.jussieu.fr) |
|---|
| 309 | 2/7/98 |
|---|
| 310 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
|---|
| 311 | adaptation array containing a temporal dimension |
|---|
| 312 | 14/8/98 |
|---|
| 313 | 15/1/98 |
|---|
| 314 | 12/3/99 adaptation for NAN and utilization of TEMPORARY |
|---|
| 315 | </div> |
|---|
| 316 | |
|---|
| 317 | |
|---|
| 318 | <h3>Known issues</h3> |
|---|
| 319 | |
|---|
| 320 | |
|---|
| 321 | |
|---|
| 322 | <h4>Restrictions</h4><div class="preformat"> |
|---|
| 323 | Put values corresponding to land at 1.e20 |
|---|
| 324 | </div> |
|---|
| 325 | |
|---|
| 326 | <h3>Other attributes</h3> |
|---|
| 327 | |
|---|
| 328 | |
|---|
| 329 | <h4>Uses routines</h4><div class="preformat"> |
|---|
| 330 | result:un tableau |
|---|
| 331 | common |
|---|
| 332 | domdef |
|---|
| 333 | </div> |
|---|
| 334 | |
|---|
| 335 | |
|---|
| 336 | |
|---|
| 337 | |
|---|
| 338 | <h3>Statistics</h3> |
|---|
| 339 | <table class="statistics"> |
|---|
| 340 | <tr><td>McCabe cyclic</td><td> 140</td></tr> |
|---|
| 341 | <tr><td>McCabe essential</td><td> 1</td></tr> |
|---|
| 342 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
|---|
| 343 | </table> |
|---|
| 344 | |
|---|
| 345 | |
|---|
| 346 | </div> |
|---|
| 347 | |
|---|
| 348 | </div> |
|---|
| 349 | |
|---|
| 350 | |
|---|
| 351 | |
|---|
| 352 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
|---|
| 353 | |
|---|
| 354 | </div> |
|---|
| 355 | |
|---|
| 356 | </body> |
|---|
| 357 | </html> |
|---|
