| 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>moyenne.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="moyenne.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?format=raw" title="Overview of library">Overview</a></td> |
|---|
| 36 | |
|---|
| 37 | |
|---|
| 38 | |
|---|
| 39 | <td >Directory</td> |
|---|
| 40 | |
|---|
| 41 | |
|---|
| 42 | |
|---|
| 43 | <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td> |
|---|
| 44 | |
|---|
| 45 | |
|---|
| 46 | |
|---|
| 47 | <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td> |
|---|
| 48 | |
|---|
| 49 | |
|---|
| 50 | |
|---|
| 51 | <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td> |
|---|
| 52 | |
|---|
| 53 | |
|---|
| 54 | <td id="selected">File</td> |
|---|
| 55 | |
|---|
| 56 | |
|---|
| 57 | <td >Source</td> |
|---|
| 58 | |
|---|
| 59 | |
|---|
| 60 | |
|---|
| 61 | <td><a href="./../../idldoc-help.html?format=raw" 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="level2mask.html"><<prev file</a> | <a href="norme.html">next file >></a> <a href="moyenne.html?format=raw" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" 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?format=raw">ToBeReviewed/CALCULS/</a></h1> |
|---|
| 82 | <h2 class="pro_file">moyenne.pro</h2> |
|---|
| 83 | |
|---|
| 84 | <div id="file_attr"> |
|---|
| 85 | <dl> |
|---|
| 86 | </dl> |
|---|
| 87 | </div> |
|---|
| 88 | |
|---|
| 89 | <div id="file_comments"></div> |
|---|
| 90 | |
|---|
| 91 | |
|---|
| 92 | |
|---|
| 93 | |
|---|
| 94 | |
|---|
| 95 | |
|---|
| 96 | |
|---|
| 97 | |
|---|
| 98 | |
|---|
| 99 | <div id="routine_details"> |
|---|
| 100 | |
|---|
| 101 | |
|---|
| 102 | <div class="routine_details" id="_moyenne"> |
|---|
| 103 | |
|---|
| 104 | <h2><a class="top" href="#container">top</a>moyenne </h2> |
|---|
| 105 | |
|---|
| 106 | <p class="header"> |
|---|
| 107 | <span class="result">result = </span>moyenne(<span class="result"><a href="#_moyenne_param_tab">tab</a>, <a href="#_moyenne_param_direc">direc</a></span>, <a href="#_moyenne_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_moyenne_keyword_INTEGRATION">INTEGRATION</a>=<span class="result">INTEGRATION</span>, <a href="#_moyenne_keyword_NAN">NAN</a>=<span class="result">NAN</span>, <a href="#_moyenne_keyword_NODOMDEF">NODOMDEF</a>=<span class="result">NODOMDEF</span>, <a href="#_moyenne_keyword_WDEPTH">WDEPTH</a>=<span class="result">WDEPTH</span>, <a href="#_moyenne_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p> |
|---|
| 108 | |
|---|
| 109 | <div class="comments"> |
|---|
| 110 | NAME: moyenne |
|---|
| 111 | |
|---|
| 112 | PURPOSE: averages a 2- or 3-d field over a selected |
|---|
| 113 | geographical area and along one ore more |
|---|
| 114 | selected axes (x, y or z) |
|---|
| 115 | |
|---|
| 116 | CATEGORY: |
|---|
| 117 | |
|---|
| 118 | CALLING SEQUENCE: result = moyenne(tab,'direc',BOXZOOM=boxzoom) |
|---|
| 119 | |
|---|
| 120 | INPUTS: tab = 2 or 3d field |
|---|
| 121 | direc = 'x' 'y' 'z' 'xy' 'xz' 'yz' or 'xyz' |
|---|
| 122 | |
|---|
| 123 | KEYWORD PARAMETERS: |
|---|
| 124 | |
|---|
| 125 | BOXZOOM = [xmin,xmax,ymin,ymax (,(zmin,)zmax)] pour plus |
|---|
| 126 | de detail cf domdef. |
|---|
| 127 | boxzoom peut prendre 5 formes: |
|---|
| 128 | [vert2], [vert1, vert2],[lon1, lon2, lat1, lat2], |
|---|
| 129 | [lon1, lon2, lat1, lat2, vert2],[lon1, lon2, lat1, |
|---|
| 130 | lat2, vert1,vert2] |
|---|
| 131 | |
|---|
| 132 | NAN: not a number, a activer si l''on peut faire veut |
|---|
| 133 | faire une moyenne sans tenir compte de certaines |
|---|
| 134 | valeurs masques de tab. |
|---|
| 135 | si les valeurs masques de tab sont la valeur consacree |
|---|
| 136 | par IDL (!values.f_nan), il suffit de mettre /NAN. |
|---|
| 137 | si les valeurs masques de tab on pour valeur a (a doit |
|---|
| 138 | etre differente de 1 (correspond a nan = |
|---|
| 139 | !values.f_nan) et de 0 (qui desactive nan) |
|---|
| 140 | il faut mettre NAN=a. |
|---|
| 141 | Rq: en sorties les points de result qui sont NAN |
|---|
| 142 | auront pour valeur a ou !values.f_nan. |
|---|
| 143 | |
|---|
| 144 | NODOMDEF: activer si l''on ne veut pas passer ds |
|---|
| 145 | domdef bien que le mot cle boxzoom soit present (comme |
|---|
| 146 | c''est le cas qd moyenne est appelee via checkfield) |
|---|
| 147 | |
|---|
| 148 | INTEGRATION: pour faire une integrale plutot qu''une moyenne |
|---|
| 149 | |
|---|
| 150 | /WDEPTH: to specify that the field is at W depth instad of T |
|---|
| 151 | depth (automatically activated if vargrid eq 'W') |
|---|
| 152 | |
|---|
| 153 | OUTPUTS: result:un tableau |
|---|
| 154 | |
|---|
| 155 | COMMON BLOCKS: |
|---|
| 156 | common domdef |
|---|
| 157 | |
|---|
| 158 | SIDE EFFECTS:met les valeurs correspondants a la terre a 1e20 |
|---|
| 159 | |
|---|
| 160 | RESTRICTIONS: |
|---|
| 161 | |
|---|
| 162 | EXAMPLE: |
|---|
| 163 | </div> |
|---|
| 164 | |
|---|
| 165 | |
|---|
| 166 | |
|---|
| 167 | |
|---|
| 168 | <h3>Parameters</h3> |
|---|
| 169 | |
|---|
| 170 | |
|---|
| 171 | <h4 id="_moyenne_param_tab">tab |
|---|
| 172 | |
|---|
| 173 | |
|---|
| 174 | |
|---|
| 175 | |
|---|
| 176 | |
|---|
| 177 | |
|---|
| 178 | |
|---|
| 179 | |
|---|
| 180 | </h4> |
|---|
| 181 | |
|---|
| 182 | <div class="comments"></div> |
|---|
| 183 | |
|---|
| 184 | <h4 id="_moyenne_param_direc">direc |
|---|
| 185 | |
|---|
| 186 | |
|---|
| 187 | |
|---|
| 188 | |
|---|
| 189 | |
|---|
| 190 | |
|---|
| 191 | |
|---|
| 192 | |
|---|
| 193 | </h4> |
|---|
| 194 | |
|---|
| 195 | <div class="comments"></div> |
|---|
| 196 | |
|---|
| 197 | |
|---|
| 198 | |
|---|
| 199 | |
|---|
| 200 | |
|---|
| 201 | |
|---|
| 202 | <h3>Keywords</h3> |
|---|
| 203 | |
|---|
| 204 | <h4 id="_moyenne_keyword_BOXZOOM">BOXZOOM |
|---|
| 205 | |
|---|
| 206 | |
|---|
| 207 | |
|---|
| 208 | |
|---|
| 209 | |
|---|
| 210 | |
|---|
| 211 | |
|---|
| 212 | |
|---|
| 213 | </h4> |
|---|
| 214 | |
|---|
| 215 | <div class="comments"></div> |
|---|
| 216 | |
|---|
| 217 | <h4 id="_moyenne_keyword_INTEGRATION">INTEGRATION |
|---|
| 218 | |
|---|
| 219 | |
|---|
| 220 | |
|---|
| 221 | |
|---|
| 222 | |
|---|
| 223 | |
|---|
| 224 | |
|---|
| 225 | |
|---|
| 226 | </h4> |
|---|
| 227 | |
|---|
| 228 | <div class="comments"></div> |
|---|
| 229 | |
|---|
| 230 | <h4 id="_moyenne_keyword_NAN">NAN |
|---|
| 231 | |
|---|
| 232 | |
|---|
| 233 | |
|---|
| 234 | |
|---|
| 235 | |
|---|
| 236 | |
|---|
| 237 | |
|---|
| 238 | |
|---|
| 239 | </h4> |
|---|
| 240 | |
|---|
| 241 | <div class="comments"></div> |
|---|
| 242 | |
|---|
| 243 | <h4 id="_moyenne_keyword_NODOMDEF">NODOMDEF |
|---|
| 244 | |
|---|
| 245 | |
|---|
| 246 | |
|---|
| 247 | |
|---|
| 248 | |
|---|
| 249 | |
|---|
| 250 | |
|---|
| 251 | |
|---|
| 252 | </h4> |
|---|
| 253 | |
|---|
| 254 | <div class="comments"></div> |
|---|
| 255 | |
|---|
| 256 | <h4 id="_moyenne_keyword_WDEPTH">WDEPTH |
|---|
| 257 | |
|---|
| 258 | |
|---|
| 259 | |
|---|
| 260 | |
|---|
| 261 | |
|---|
| 262 | |
|---|
| 263 | |
|---|
| 264 | |
|---|
| 265 | </h4> |
|---|
| 266 | |
|---|
| 267 | <div class="comments"></div> |
|---|
| 268 | |
|---|
| 269 | <h4 id="_moyenne_keyword__extra">_extra |
|---|
| 270 | |
|---|
| 271 | |
|---|
| 272 | |
|---|
| 273 | |
|---|
| 274 | |
|---|
| 275 | |
|---|
| 276 | |
|---|
| 277 | |
|---|
| 278 | </h4> |
|---|
| 279 | |
|---|
| 280 | <div class="comments"></div> |
|---|
| 281 | |
|---|
| 282 | |
|---|
| 283 | |
|---|
| 284 | |
|---|
| 285 | |
|---|
| 286 | |
|---|
| 287 | |
|---|
| 288 | |
|---|
| 289 | |
|---|
| 290 | |
|---|
| 291 | |
|---|
| 292 | |
|---|
| 293 | |
|---|
| 294 | |
|---|
| 295 | |
|---|
| 296 | |
|---|
| 297 | |
|---|
| 298 | |
|---|
| 299 | |
|---|
| 300 | |
|---|
| 301 | |
|---|
| 302 | |
|---|
| 303 | |
|---|
| 304 | |
|---|
| 305 | |
|---|
| 306 | |
|---|
| 307 | </div> |
|---|
| 308 | |
|---|
| 309 | </div> |
|---|
| 310 | |
|---|
| 311 | |
|---|
| 312 | |
|---|
| 313 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
|---|
| 314 | |
|---|
| 315 | </div> |
|---|
| 316 | |
|---|
| 317 | </body> |
|---|
| 318 | </html> |
|---|
