| 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>velovect.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="velovect.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="vecteur.html"><<prev file</a> | next file >> <a href="velovect.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/PLOTS/VECTEUR/</a></h1> |
|---|
| 82 | <h2 class="pro_file">velovect.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="_VELOVECT"> |
|---|
| 103 | |
|---|
| 104 | <h2><a class="top" href="#container">top</a>VELOVECT </h2> |
|---|
| 105 | |
|---|
| 106 | <p class="header"> |
|---|
| 107 | VELOVECT<span class="result">, <a href="#_VELOVECT_param_U">U</a>, <a href="#_VELOVECT_param_V">V</a>, <a href="#_VELOVECT_param_X">X</a>, <a href="#_VELOVECT_param_Y">Y</a></span>, <a href="#_VELOVECT_keyword_Missing">Missing</a>=<span class="result">Missing</span>, <a href="#_VELOVECT_keyword_Length">Length</a>=<span class="result">Length</span>, <a href="#_VELOVECT_keyword_Dots">Dots</a>=<span class="result">Dots</span>, <a href="#_VELOVECT_keyword_Color">Color</a>=<span class="result">Color</span>, <a href="#_VELOVECT_keyword_CLIP">CLIP</a>=<span class="result">CLIP</span>, <a href="#_VELOVECT_keyword_NOCLIP">NOCLIP</a>=<span class="result">NOCLIP</span>, <a href="#_VELOVECT_keyword_OVERPLOT">OVERPLOT</a>=<span class="result">OVERPLOT</span>, <a href="#_VELOVECT_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> |
|---|
| 108 | |
|---|
| 109 | <div class="comments"> |
|---|
| 110 | NAME: |
|---|
| 111 | VELOVECT |
|---|
| 112 | |
|---|
| 113 | PURPOSE: |
|---|
| 114 | Produce a two-dimensional velocity field plot. |
|---|
| 115 | |
|---|
| 116 | A directed arrow is drawn at each point showing the direction and |
|---|
| 117 | magnitude of the field. |
|---|
| 118 | |
|---|
| 119 | CATEGORY: |
|---|
| 120 | Plotting, two-dimensional. |
|---|
| 121 | |
|---|
| 122 | CALLING SEQUENCE: |
|---|
| 123 | VELOVECT, U, V [, X, Y] |
|---|
| 124 | |
|---|
| 125 | INPUTS: |
|---|
| 126 | U: The X component of the two-dimensional field. |
|---|
| 127 | U must be a two-dimensional array. |
|---|
| 128 | |
|---|
| 129 | V: The Y component of the two dimensional field. Y must have |
|---|
| 130 | the same dimensions as X. The vector at point [i,j] has a |
|---|
| 131 | magnitude of: |
|---|
| 132 | |
|---|
| 133 | (U[i,j]^2 + V[i,j]^2)^0.5 |
|---|
| 134 | |
|---|
| 135 | and a direction of: |
|---|
| 136 | |
|---|
| 137 | ATAN2(V[i,j],U[i,j]). |
|---|
| 138 | |
|---|
| 139 | OPTIONAL INPUT PARAMETERS: |
|---|
| 140 | X: Optional abcissae values. X must be a vector with a length |
|---|
| 141 | equal to the first dimension of U and V. |
|---|
| 142 | |
|---|
| 143 | Y: Optional ordinate values. Y must be a vector with a length |
|---|
| 144 | equal to the first dimension of U and V. |
|---|
| 145 | |
|---|
| 146 | KEYWORD INPUT PARAMETERS: |
|---|
| 147 | COLOR: The color index used for the plot. |
|---|
| 148 | |
|---|
| 149 | DOTS: Set this keyword to 1 to place a dot at each missing point. |
|---|
| 150 | Set this keyword to 0 or omit it to draw nothing for missing |
|---|
| 151 | points. Has effect only if MISSING is specified. |
|---|
| 152 | |
|---|
| 153 | LENGTH: Length factor. The default of 1.0 makes the longest (U,V) |
|---|
| 154 | vector the length of a cell. |
|---|
| 155 | |
|---|
| 156 | MISSING: Missing data value. Vectors with a LENGTH greater |
|---|
| 157 | than MISSING are ignored. |
|---|
| 158 | |
|---|
| 159 | OVERPLOT: Set this keyword to make VELOVECT "overplot". That is, the |
|---|
| 160 | current graphics screen is not erased, no axes are drawn, and |
|---|
| 161 | the previously established scaling remains in effect. |
|---|
| 162 | |
|---|
| 163 | |
|---|
| 164 | Note: All other keywords are passed directly to the PLOT procedure |
|---|
| 165 | and may be used to set option such as TITLE, POSITION, |
|---|
| 166 | NOERASE, etc. |
|---|
| 167 | OUTPUTS: |
|---|
| 168 | None. |
|---|
| 169 | |
|---|
| 170 | COMMON BLOCKS: |
|---|
| 171 | None. |
|---|
| 172 | |
|---|
| 173 | SIDE EFFECTS: |
|---|
| 174 | Plotting on the selected device is performed. System |
|---|
| 175 | variables concerning plotting are changed. |
|---|
| 176 | |
|---|
| 177 | RESTRICTIONS: |
|---|
| 178 | None. |
|---|
| 179 | |
|---|
| 180 | PROCEDURE: |
|---|
| 181 | Straightforward. Unrecognized keywords are passed to the PLOT |
|---|
| 182 | procedure. |
|---|
| 183 | |
|---|
| 184 | MODIFICATION HISTORY: |
|---|
| 185 | DMS, RSI, Oct., 1983. |
|---|
| 186 | For Sun, DMS, RSI, April, 1989. |
|---|
| 187 | Added TITLE, Oct, 1990. |
|---|
| 188 | Added POSITION, NOERASE, COLOR, Feb 91, RES. |
|---|
| 189 | August, 1993. Vince Patrick, Adv. Visualization Lab, U. of Maryland, |
|---|
| 190 | fixed errors in math. |
|---|
| 191 | August, 1993. DMS, Added _EXTRA keyword inheritance. |
|---|
| 192 | January, 1994, KDB. Fixed integer math which produced 0 and caused |
|---|
| 193 | divide by zero errors. |
|---|
| 194 | December, 1994, MWR. Added _EXTRA inheritance for PLOTS and OPLOT. |
|---|
| 195 | June, 1995, MWR. Removed _EXTRA inheritance for PLOTS and changed |
|---|
| 196 | OPLOT to PLOTS. |
|---|
| 197 | September, 1996, GGS. Changed denominator of x_step and y_step vars. |
|---|
| 198 | February, 1998, DLD. Add support for CLIP and NO_CLIP keywords. |
|---|
| 199 | June, 1998, DLD. Add support for OVERPLOT keyword.</div> |
|---|
| 200 | |
|---|
| 201 | |
|---|
| 202 | |
|---|
| 203 | |
|---|
| 204 | <h3>Parameters</h3> |
|---|
| 205 | |
|---|
| 206 | |
|---|
| 207 | <h4 id="_VELOVECT_param_U">U |
|---|
| 208 | |
|---|
| 209 | |
|---|
| 210 | |
|---|
| 211 | |
|---|
| 212 | |
|---|
| 213 | |
|---|
| 214 | |
|---|
| 215 | |
|---|
| 216 | </h4> |
|---|
| 217 | |
|---|
| 218 | <div class="comments"></div> |
|---|
| 219 | |
|---|
| 220 | <h4 id="_VELOVECT_param_V">V |
|---|
| 221 | |
|---|
| 222 | |
|---|
| 223 | |
|---|
| 224 | |
|---|
| 225 | |
|---|
| 226 | |
|---|
| 227 | |
|---|
| 228 | |
|---|
| 229 | </h4> |
|---|
| 230 | |
|---|
| 231 | <div class="comments"></div> |
|---|
| 232 | |
|---|
| 233 | <h4 id="_VELOVECT_param_X">X |
|---|
| 234 | |
|---|
| 235 | |
|---|
| 236 | |
|---|
| 237 | |
|---|
| 238 | |
|---|
| 239 | |
|---|
| 240 | |
|---|
| 241 | |
|---|
| 242 | </h4> |
|---|
| 243 | |
|---|
| 244 | <div class="comments"></div> |
|---|
| 245 | |
|---|
| 246 | <h4 id="_VELOVECT_param_Y">Y |
|---|
| 247 | |
|---|
| 248 | |
|---|
| 249 | |
|---|
| 250 | |
|---|
| 251 | |
|---|
| 252 | |
|---|
| 253 | |
|---|
| 254 | |
|---|
| 255 | </h4> |
|---|
| 256 | |
|---|
| 257 | <div class="comments"></div> |
|---|
| 258 | |
|---|
| 259 | |
|---|
| 260 | |
|---|
| 261 | |
|---|
| 262 | |
|---|
| 263 | |
|---|
| 264 | <h3>Keywords</h3> |
|---|
| 265 | |
|---|
| 266 | <h4 id="_VELOVECT_keyword_Missing">Missing |
|---|
| 267 | |
|---|
| 268 | |
|---|
| 269 | |
|---|
| 270 | |
|---|
| 271 | |
|---|
| 272 | |
|---|
| 273 | |
|---|
| 274 | |
|---|
| 275 | </h4> |
|---|
| 276 | |
|---|
| 277 | <div class="comments"></div> |
|---|
| 278 | |
|---|
| 279 | <h4 id="_VELOVECT_keyword_Length">Length |
|---|
| 280 | |
|---|
| 281 | |
|---|
| 282 | |
|---|
| 283 | |
|---|
| 284 | |
|---|
| 285 | |
|---|
| 286 | |
|---|
| 287 | |
|---|
| 288 | </h4> |
|---|
| 289 | |
|---|
| 290 | <div class="comments"></div> |
|---|
| 291 | |
|---|
| 292 | <h4 id="_VELOVECT_keyword_Dots">Dots |
|---|
| 293 | |
|---|
| 294 | |
|---|
| 295 | |
|---|
| 296 | |
|---|
| 297 | |
|---|
| 298 | |
|---|
| 299 | |
|---|
| 300 | |
|---|
| 301 | </h4> |
|---|
| 302 | |
|---|
| 303 | <div class="comments"></div> |
|---|
| 304 | |
|---|
| 305 | <h4 id="_VELOVECT_keyword_Color">Color |
|---|
| 306 | |
|---|
| 307 | |
|---|
| 308 | |
|---|
| 309 | |
|---|
| 310 | |
|---|
| 311 | |
|---|
| 312 | |
|---|
| 313 | |
|---|
| 314 | </h4> |
|---|
| 315 | |
|---|
| 316 | <div class="comments"></div> |
|---|
| 317 | |
|---|
| 318 | <h4 id="_VELOVECT_keyword_CLIP">CLIP |
|---|
| 319 | |
|---|
| 320 | |
|---|
| 321 | |
|---|
| 322 | |
|---|
| 323 | |
|---|
| 324 | |
|---|
| 325 | |
|---|
| 326 | |
|---|
| 327 | </h4> |
|---|
| 328 | |
|---|
| 329 | <div class="comments"></div> |
|---|
| 330 | |
|---|
| 331 | <h4 id="_VELOVECT_keyword_NOCLIP">NOCLIP |
|---|
| 332 | |
|---|
| 333 | |
|---|
| 334 | |
|---|
| 335 | |
|---|
| 336 | |
|---|
| 337 | |
|---|
| 338 | |
|---|
| 339 | |
|---|
| 340 | </h4> |
|---|
| 341 | |
|---|
| 342 | <div class="comments"></div> |
|---|
| 343 | |
|---|
| 344 | <h4 id="_VELOVECT_keyword_OVERPLOT">OVERPLOT |
|---|
| 345 | |
|---|
| 346 | |
|---|
| 347 | |
|---|
| 348 | |
|---|
| 349 | |
|---|
| 350 | |
|---|
| 351 | |
|---|
| 352 | |
|---|
| 353 | </h4> |
|---|
| 354 | |
|---|
| 355 | <div class="comments"></div> |
|---|
| 356 | |
|---|
| 357 | <h4 id="_VELOVECT_keyword__EXTRA">_EXTRA |
|---|
| 358 | |
|---|
| 359 | |
|---|
| 360 | |
|---|
| 361 | |
|---|
| 362 | |
|---|
| 363 | |
|---|
| 364 | |
|---|
| 365 | |
|---|
| 366 | </h4> |
|---|
| 367 | |
|---|
| 368 | <div class="comments"></div> |
|---|
| 369 | |
|---|
| 370 | |
|---|
| 371 | |
|---|
| 372 | |
|---|
| 373 | |
|---|
| 374 | |
|---|
| 375 | |
|---|
| 376 | |
|---|
| 377 | |
|---|
| 378 | |
|---|
| 379 | |
|---|
| 380 | |
|---|
| 381 | |
|---|
| 382 | |
|---|
| 383 | |
|---|
| 384 | |
|---|
| 385 | |
|---|
| 386 | |
|---|
| 387 | |
|---|
| 388 | |
|---|
| 389 | |
|---|
| 390 | |
|---|
| 391 | |
|---|
| 392 | |
|---|
| 393 | |
|---|
| 394 | |
|---|
| 395 | </div> |
|---|
| 396 | |
|---|
| 397 | </div> |
|---|
| 398 | |
|---|
| 399 | |
|---|
| 400 | |
|---|
| 401 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
|---|
| 402 | |
|---|
| 403 | </div> |
|---|
| 404 | |
|---|
| 405 | </body> |
|---|
| 406 | </html> |
|---|
