[89] | 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>norme.pro (IDLdoc API 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="norme.pro (IDLdoc API documentation)"; |
---|
| 19 | } |
---|
| 20 | </script> |
---|
| 21 | </head> |
---|
| 22 | |
---|
| 23 | <body onload="setTitle();"> |
---|
| 24 | |
---|
| 25 | <div id="navbar_title"> |
---|
| 26 | <h1>IDLdoc API 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="moyenne.html"><<prev file</a> | <a href="projectondepth.html">next file >></a> <a href="norme.html" 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">norme.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="_norme"> |
---|
| 103 | |
---|
| 104 | <h2><a class="top" href="#container">top</a>norme </h2> |
---|
| 105 | |
---|
| 106 | <p class="header"> |
---|
| 107 | <span class="result">result = </span>norme(<span class="result"><a href="#_norme_param_composanteu">composanteu</a>, <a href="#_norme_param_composantev">composantev</a></span>, <a href="#_norme_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_norme_keyword_DIREC">DIREC</a>=<span class="result">DIREC</span>, <a href="#_norme_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p> |
---|
| 108 | |
---|
| 109 | <div class="comments"> |
---|
| 110 | NAME:norme |
---|
| 111 | |
---|
| 112 | PURPOSE: calcule la norme d''un champ de vecteurs, puis fait une |
---|
| 113 | moyenne eventuelle. |
---|
| 114 | Rq1: le champ de vecteur peut etre, 2d:xy, 3d: xyz ou xyt, |
---|
| 115 | 4d: xyzt |
---|
| 116 | Rq2: le calcul de la norme est fait avant l''eventuelle |
---|
| 117 | moyenne spatiale ou temporelle car la moyenne de la norme |
---|
| 118 | n''est pas egale a la norme des moyennes. |
---|
| 119 | |
---|
| 120 | CATEGORY: calcul de post traitement |
---|
| 121 | |
---|
| 122 | CALLING SEQUENCE:res=norme(champ_de_vecteurs) |
---|
| 123 | |
---|
| 124 | INPUTS:un tableau 2d, 3d ou 4d |
---|
| 125 | |
---|
| 126 | KEYWORD PARAMETERS: |
---|
| 127 | |
---|
| 128 | BOXZOOM: boxzoom sur laquelle moyenner (par defaut le domaine |
---|
| 129 | selectionner par le dernier domdef effectue) |
---|
| 130 | |
---|
| 131 | DIREC:'t' 'x' 'y' 'z' 'xy' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt' |
---|
| 132 | 'xzt' 'yzt' 'xyzt' directions selon lesquelles effectuer les |
---|
| 133 | moyennes |
---|
| 134 | |
---|
| 135 | OUTPUTS:tableau a tracer avec plt, pltz ou pltt. |
---|
| 136 | |
---|
| 137 | COMMON BLOCKS: |
---|
| 138 | common.pro |
---|
| 139 | |
---|
| 140 | SIDE EFFECTS: |
---|
| 141 | |
---|
| 142 | La norme est calculee aux points T. Pour faire ce calcul, on |
---|
| 143 | moyenne les champs U et V aux points T avant de calculer la norme. |
---|
| 144 | Au bord des cotes et du domaine, on ne peut pas calculer les |
---|
| 145 | champs U et V aux points T, ces points sont donc a la valeur |
---|
| 146 | !values.f_nan. |
---|
| 147 | |
---|
| 148 | lorsqu''on fait le calcul sur un domaine geographique reduit, |
---|
| 149 | les champs U et V ne comprennent pas forcement le meme nombre |
---|
| 150 | de points. Dans ce cas on redecoupe U et V pour ne garder que |
---|
| 151 | les points en commun. Au passage on refait un domdef qui |
---|
| 152 | redefinit un domaine geographique sur lequel les champs U et V |
---|
| 153 | sont extraits sur les meme points. |
---|
| 154 | |
---|
| 155 | RESTRICTIONS: |
---|
| 156 | |
---|
| 157 | pour savoir a quel type de tableau on a a faire, on teste la |
---|
| 158 | taille de celui-ci et les dates donnees par time[0] et |
---|
| 159 | time[jpt-1] pour savoir si il y a une dimension |
---|
| 160 | temporelle. Avant de lancer norme s''assurer que time et jpt |
---|
| 161 | sont bien definis comme il faut! |
---|
| 162 | |
---|
| 163 | EXAMPLE: |
---|
| 164 | |
---|
| 165 | pour calculer la moyenne de la norme des courants sur tout le |
---|
| 166 | dommaine entre 0 et 50: |
---|
| 167 | IDL> res=norme(un,vn,boxzoom=[0,50],dir='xyz') |
---|
| 168 | </div> |
---|
| 169 | |
---|
| 170 | |
---|
| 171 | |
---|
| 172 | |
---|
| 173 | <h3>Parameters</h3> |
---|
| 174 | |
---|
| 175 | |
---|
| 176 | <h4 id="_norme_param_composanteu">composanteu |
---|
| 177 | |
---|
| 178 | |
---|
| 179 | |
---|
| 180 | |
---|
| 181 | |
---|
| 182 | |
---|
| 183 | |
---|
| 184 | |
---|
| 185 | </h4> |
---|
| 186 | |
---|
| 187 | <div class="comments"></div> |
---|
| 188 | |
---|
| 189 | <h4 id="_norme_param_composantev">composantev |
---|
| 190 | |
---|
| 191 | |
---|
| 192 | |
---|
| 193 | |
---|
| 194 | |
---|
| 195 | |
---|
| 196 | |
---|
| 197 | |
---|
| 198 | </h4> |
---|
| 199 | |
---|
| 200 | <div class="comments"></div> |
---|
| 201 | |
---|
| 202 | |
---|
| 203 | |
---|
| 204 | |
---|
| 205 | |
---|
| 206 | |
---|
| 207 | <h3>Keywords</h3> |
---|
| 208 | |
---|
| 209 | <h4 id="_norme_keyword_BOXZOOM">BOXZOOM |
---|
| 210 | |
---|
| 211 | |
---|
| 212 | |
---|
| 213 | |
---|
| 214 | |
---|
| 215 | |
---|
| 216 | |
---|
| 217 | |
---|
| 218 | </h4> |
---|
| 219 | |
---|
| 220 | <div class="comments"></div> |
---|
| 221 | |
---|
| 222 | <h4 id="_norme_keyword_DIREC">DIREC |
---|
| 223 | |
---|
| 224 | |
---|
| 225 | |
---|
| 226 | |
---|
| 227 | |
---|
| 228 | |
---|
| 229 | |
---|
| 230 | |
---|
| 231 | </h4> |
---|
| 232 | |
---|
| 233 | <div class="comments"></div> |
---|
| 234 | |
---|
| 235 | <h4 id="_norme_keyword__extra">_extra |
---|
| 236 | |
---|
| 237 | |
---|
| 238 | |
---|
| 239 | |
---|
| 240 | |
---|
| 241 | |
---|
| 242 | |
---|
| 243 | |
---|
| 244 | </h4> |
---|
| 245 | |
---|
| 246 | <div class="comments"></div> |
---|
| 247 | |
---|
| 248 | |
---|
| 249 | |
---|
| 250 | |
---|
| 251 | |
---|
| 252 | |
---|
| 253 | |
---|
| 254 | |
---|
| 255 | |
---|
| 256 | |
---|
| 257 | |
---|
| 258 | |
---|
| 259 | |
---|
| 260 | |
---|
| 261 | |
---|
| 262 | |
---|
| 263 | |
---|
| 264 | |
---|
| 265 | |
---|
| 266 | |
---|
| 267 | |
---|
| 268 | |
---|
| 269 | |
---|
| 270 | |
---|
| 271 | |
---|
| 272 | |
---|
| 273 | </div> |
---|
| 274 | |
---|
| 275 | </div> |
---|
| 276 | |
---|
| 277 | |
---|
| 278 | |
---|
| 279 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
| 280 | |
---|
| 281 | </div> |
---|
| 282 | |
---|
| 283 | </body> |
---|
| 284 | </html> |
---|