| 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>plt1d.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="plt1d.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/PLOTS/DESSINE//plt1d.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="plt.html"><<prev file</a> | <a href="pltbase.html">next file >></a> <a href="plt1d.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/PLOTS/DESSINE/</a></h1> |
|---|
| 82 | <h2 class="pro_file">plt1d.pro</h2> |
|---|
| 83 | |
|---|
| 84 | <div id="file_attr"> |
|---|
| 85 | <dl> |
|---|
| 86 | </dl> |
|---|
| 87 | </div> |
|---|
| 88 | |
|---|
| 89 | <div id="file_comments"> |
|---|
| 90 | Trace 1d graphs: x,y,z (or t but in this case, we recall directly pltt) |
|---|
| 91 | </div> |
|---|
| 92 | |
|---|
| 93 | |
|---|
| 94 | |
|---|
| 95 | |
|---|
| 96 | |
|---|
| 97 | |
|---|
| 98 | |
|---|
| 99 | |
|---|
| 100 | |
|---|
| 101 | <div id="routine_details"> |
|---|
| 102 | |
|---|
| 103 | |
|---|
| 104 | <div class="routine_details" id="_plt1d"> |
|---|
| 105 | |
|---|
| 106 | <h2><a class="top" href="#container">top</a>plt1d <span class="categories"> |
|---|
| 107 | Graphics |
|---|
| 108 | </span></h2> |
|---|
| 109 | |
|---|
| 110 | <p class="header"> |
|---|
| 111 | plt1d<span class="result">, <a href="#_plt1d_param_tab">tab</a>, <a href="#_plt1d_param_param2">param2</a>[, <a href="#_plt1d_param_param3">param3</a>][, <a href="#_plt1d_param_param4">param4</a>]</span>, <a href="#_plt1d_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_plt1d_keyword_SIN">SIN</a>=<span class="result">SIN</span>, <a href="#_plt1d_keyword_MININ">MININ</a>=<span class="result">MININ</span>, <a href="#_plt1d_keyword_MAXIN">MAXIN</a>=<span class="result">MAXIN</span>, <a href="#_plt1d_keyword_TYPEIN">TYPEIN</a>=<span class="result">TYPEIN</span>, <a href="#_plt1d_keyword_ENDPOINTS">ENDPOINTS</a>=<span class="result">ENDPOINTS</span>, <a href="#_plt1d_keyword_COL1D">COL1D</a>=<span class="result">COL1D</span>, <a href="#_plt1d_keyword_STY1D">STY1D</a>=<span class="result">STY1D</span>, <a href="#_plt1d_keyword_OV1D">OV1D</a>=<span class="result">OV1D</span>, <a href="#_plt1d_keyword_X">X</a>=<span class="result">X</span>, <a href="#_plt1d_keyword_Y">Y</a>=<span class="result">Y</span>, <a href="#_plt1d_keyword_Z">Z</a>=<span class="result">Z</span>, <a href="#_plt1d_keyword_TT">TT</a>=<span class="result">TT</span>, <a href="#_plt1d_keyword_REVERSE_X">REVERSE_X</a>=<span class="result">REVERSE_X</span>, <a href="#_plt1d_keyword_REVERSE_Y">REVERSE_Y</a>=<span class="result">REVERSE_Y</span>, <a href="#_plt1d_keyword_SWITCHXY">SWITCHXY</a>=<span class="result">SWITCHXY</span>, <a href="#_plt1d_keyword__extra">_extra</a>=<span class="result">_extra</span></p> |
|---|
| 112 | |
|---|
| 113 | <div class="comments"> |
|---|
| 114 | </div> |
|---|
| 115 | |
|---|
| 116 | |
|---|
| 117 | |
|---|
| 118 | |
|---|
| 119 | <h3>Parameters</h3> |
|---|
| 120 | |
|---|
| 121 | |
|---|
| 122 | <h4 id="_plt1d_param_tab">tab |
|---|
| 123 | <span class="attr">in</span> |
|---|
| 124 | |
|---|
| 125 | |
|---|
| 126 | <span class="attr">required</span> |
|---|
| 127 | |
|---|
| 128 | |
|---|
| 129 | |
|---|
| 130 | |
|---|
| 131 | </h4> |
|---|
| 132 | |
|---|
| 133 | <div class="comments"> |
|---|
| 134 | The field whose we want to make the hovmoller map can be 2 kind of thing: |
|---|
| 135 | 1) An array which can be: |
|---|
| 136 | * 2d, 3d or 4d: array xy, xyz. xyt or xyzt. In this case, the array will pass |
|---|
| 137 | in moyenne or grossemoyenne to be averaged and become an array 1d. |
|---|
| 138 | * 1d:Nevertheless, the type must be specified in order to we know which trace |
|---|
| 139 | it is about. To have a correct caption, respecify the extraction zone via BOXZOOM. |
|---|
| 140 | 2) a structure respecting all criterions specified by litchamp.pro. |
|---|
| 141 | See IDL> xhelp,'litchamp'. The array contained in the structure |
|---|
| 142 | respecting criterions of case 1) |
|---|
| 143 | </div> |
|---|
| 144 | |
|---|
| 145 | <h4 id="_plt1d_param_param2">param2 |
|---|
| 146 | <span class="attr">in</span> |
|---|
| 147 | |
|---|
| 148 | |
|---|
| 149 | <span class="attr">required</span> |
|---|
| 150 | |
|---|
| 151 | |
|---|
| 152 | |
|---|
| 153 | |
|---|
| 154 | </h4> |
|---|
| 155 | |
|---|
| 156 | <div class="comments"> |
|---|
| 157 | Min value we want to consider in the contour's drawing. |
|---|
| 158 | Note: could also be the type of plot:'x','y','z' |
|---|
| 159 | </div> |
|---|
| 160 | |
|---|
| 161 | <h4 id="_plt1d_param_param3">param3 |
|---|
| 162 | <span class="attr">in</span> |
|---|
| 163 | |
|---|
| 164 | <span class="attr">optional</span> |
|---|
| 165 | |
|---|
| 166 | |
|---|
| 167 | |
|---|
| 168 | <span class="attr">default:</span> <span class="value">min/max of tab (on ocean points)</span> |
|---|
| 169 | |
|---|
| 170 | </h4> |
|---|
| 171 | |
|---|
| 172 | <div class="comments"> |
|---|
| 173 | Max value we want to consider in the contour's drawing. |
|---|
| 174 | Note: if param2 is defined as 'x','y','z' then param3 is used to define the min (see param2) |
|---|
| 175 | </div> |
|---|
| 176 | |
|---|
| 177 | <h4 id="_plt1d_param_param4">param4 |
|---|
| 178 | <span class="attr">in</span> |
|---|
| 179 | |
|---|
| 180 | <span class="attr">optional</span> |
|---|
| 181 | |
|---|
| 182 | |
|---|
| 183 | |
|---|
| 184 | <span class="attr">default:</span> <span class="value">max of tab (on ocean points)</span> |
|---|
| 185 | |
|---|
| 186 | </h4> |
|---|
| 187 | |
|---|
| 188 | <div class="comments"> |
|---|
| 189 | Type of plot (can be only 'x','y','z' for plt1d). |
|---|
| 190 | Note: if param2 is defined as 'xy' then param4 is used to define the max (see param3) |
|---|
| 191 | </div> |
|---|
| 192 | |
|---|
| 193 | |
|---|
| 194 | |
|---|
| 195 | |
|---|
| 196 | |
|---|
| 197 | |
|---|
| 198 | <h3>Keywords</h3> |
|---|
| 199 | |
|---|
| 200 | <h4 id="_plt1d_keyword_BOXZOOM">BOXZOOM |
|---|
| 201 | |
|---|
| 202 | |
|---|
| 203 | |
|---|
| 204 | |
|---|
| 205 | |
|---|
| 206 | |
|---|
| 207 | |
|---|
| 208 | |
|---|
| 209 | </h4> |
|---|
| 210 | |
|---|
| 211 | <div class="comments"> |
|---|
| 212 | Vector indicating the geographic zone (3d) on which the extraction of the field must |
|---|
| 213 | be done to do the hovmoeller. |
|---|
| 214 | If BOXZOOM has : |
|---|
| 215 | 1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]] |
|---|
| 216 | 2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]] |
|---|
| 217 | 4 elements: The extraction is made on [Boxzoom, vert1, vert2] |
|---|
| 218 | 5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]] |
|---|
| 219 | 6 elements: The extraction is made on Boxzoom |
|---|
| 220 | |
|---|
| 221 | Where lon1, lon2,lat1,lat2,vert1,vert2 are global variables defined at the last domdef! |
|---|
| 222 | </div> |
|---|
| 223 | |
|---|
| 224 | <h4 id="_plt1d_keyword_SIN">SIN |
|---|
| 225 | |
|---|
| 226 | |
|---|
| 227 | |
|---|
| 228 | |
|---|
| 229 | |
|---|
| 230 | |
|---|
| 231 | |
|---|
| 232 | |
|---|
| 233 | </h4> |
|---|
| 234 | |
|---|
| 235 | <div class="comments"> |
|---|
| 236 | Activate this keyword if we want the x axis to be traced in sinus of the |
|---|
| 237 | latitude when we make a drawing f(y) |
|---|
| 238 | </div> |
|---|
| 239 | |
|---|
| 240 | <h4 id="_plt1d_keyword_MININ">MININ |
|---|
| 241 | |
|---|
| 242 | |
|---|
| 243 | |
|---|
| 244 | |
|---|
| 245 | |
|---|
| 246 | |
|---|
| 247 | |
|---|
| 248 | |
|---|
| 249 | </h4> |
|---|
| 250 | |
|---|
| 251 | <div class="comments"> |
|---|
| 252 | Allows to specify the min value we want to consider in the drawing of contour |
|---|
| 253 | helping by the keyword instead of the argument min. If the argument and the keyword are |
|---|
| 254 | specified in the same time, it is the value specified by the keyword which is retained. |
|---|
| 255 | </div> |
|---|
| 256 | |
|---|
| 257 | <h4 id="_plt1d_keyword_MAXIN">MAXIN |
|---|
| 258 | |
|---|
| 259 | |
|---|
| 260 | |
|---|
| 261 | |
|---|
| 262 | |
|---|
| 263 | |
|---|
| 264 | |
|---|
| 265 | |
|---|
| 266 | </h4> |
|---|
| 267 | |
|---|
| 268 | <div class="comments"> |
|---|
| 269 | Allows to specify the max value we want to consider in the drawing of contour |
|---|
| 270 | helping by the keyword instead of the argument max. If the argument and the keyword are |
|---|
| 271 | specified in the same time, it is the value specified by the keyword which is retained. |
|---|
| 272 | </div> |
|---|
| 273 | |
|---|
| 274 | <h4 id="_plt1d_keyword_TYPEIN">TYPEIN |
|---|
| 275 | |
|---|
| 276 | |
|---|
| 277 | |
|---|
| 278 | |
|---|
| 279 | |
|---|
| 280 | |
|---|
| 281 | |
|---|
| 282 | |
|---|
| 283 | </h4> |
|---|
| 284 | |
|---|
| 285 | <div class="comments"> |
|---|
| 286 | allows to specify the type of hovmoller we want to do |
|---|
| 287 | 'xt','yt','zt','t' |
|---|
| 288 | with help of a keyword rather than the argument type. If the argument and the |
|---|
| 289 | keyword are specified in the same time, it is the value specified by the |
|---|
| 290 | keyword which is retained. |
|---|
| 291 | </div> |
|---|
| 292 | |
|---|
| 293 | <h4 id="_plt1d_keyword_ENDPOINTS">ENDPOINTS |
|---|
| 294 | |
|---|
| 295 | |
|---|
| 296 | |
|---|
| 297 | |
|---|
| 298 | |
|---|
| 299 | |
|---|
| 300 | |
|---|
| 301 | |
|---|
| 302 | </h4> |
|---|
| 303 | |
|---|
| 304 | <div class="comments"> |
|---|
| 305 | keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities |
|---|
| 306 | of these one are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are |
|---|
| 307 | coordinates. |
|---|
| 308 | </div> |
|---|
| 309 | |
|---|
| 310 | <h4 id="_plt1d_keyword_COL1D">COL1D |
|---|
| 311 | |
|---|
| 312 | |
|---|
| 313 | |
|---|
| 314 | |
|---|
| 315 | |
|---|
| 316 | |
|---|
| 317 | |
|---|
| 318 | |
|---|
| 319 | </h4> |
|---|
| 320 | |
|---|
| 321 | <div class="comments"> |
|---|
| 322 | --OBSOLETE--Color number when we make a trace 1d by default, 0.It is better to use the |
|---|
| 323 | keyword COLOR used by plot. |
|---|
| 324 | </div> |
|---|
| 325 | |
|---|
| 326 | <h4 id="_plt1d_keyword_STY1D">STY1D |
|---|
| 327 | |
|---|
| 328 | |
|---|
| 329 | |
|---|
| 330 | |
|---|
| 331 | |
|---|
| 332 | |
|---|
| 333 | |
|---|
| 334 | |
|---|
| 335 | </h4> |
|---|
| 336 | |
|---|
| 337 | <div class="comments"> |
|---|
| 338 | --OBSOLETE-- |
|---|
| 339 | Number of the style used when we make a 1d drawing. We should better use the |
|---|
| 340 | keyword LINESTYLE which is tho one of the plot. Beware, this keyword is still |
|---|
| 341 | useful if we want to d bars instead of curves, put sty1d='bar' |
|---|
| 342 | </div> |
|---|
| 343 | |
|---|
| 344 | <h4 id="_plt1d_keyword_OV1D">OV1D |
|---|
| 345 | |
|---|
| 346 | |
|---|
| 347 | |
|---|
| 348 | |
|---|
| 349 | |
|---|
| 350 | |
|---|
| 351 | |
|---|
| 352 | |
|---|
| 353 | </h4> |
|---|
| 354 | |
|---|
| 355 | <div class="comments"> |
|---|
| 356 | Allow the double exposure of an 1d curve to a precedent 1d trace. |
|---|
| 357 | </div> |
|---|
| 358 | |
|---|
| 359 | <h4 id="_plt1d_keyword_X">X |
|---|
| 360 | |
|---|
| 361 | |
|---|
| 362 | |
|---|
| 363 | |
|---|
| 364 | |
|---|
| 365 | |
|---|
| 366 | |
|---|
| 367 | |
|---|
| 368 | </h4> |
|---|
| 369 | |
|---|
| 370 | <div class="comments"></div> |
|---|
| 371 | |
|---|
| 372 | <h4 id="_plt1d_keyword_Y">Y |
|---|
| 373 | |
|---|
| 374 | |
|---|
| 375 | |
|---|
| 376 | |
|---|
| 377 | |
|---|
| 378 | |
|---|
| 379 | |
|---|
| 380 | |
|---|
| 381 | </h4> |
|---|
| 382 | |
|---|
| 383 | <div class="comments"></div> |
|---|
| 384 | |
|---|
| 385 | <h4 id="_plt1d_keyword_Z">Z |
|---|
| 386 | |
|---|
| 387 | |
|---|
| 388 | |
|---|
| 389 | |
|---|
| 390 | |
|---|
| 391 | |
|---|
| 392 | |
|---|
| 393 | |
|---|
| 394 | </h4> |
|---|
| 395 | |
|---|
| 396 | <div class="comments"></div> |
|---|
| 397 | |
|---|
| 398 | <h4 id="_plt1d_keyword_TT">TT |
|---|
| 399 | |
|---|
| 400 | |
|---|
| 401 | |
|---|
| 402 | |
|---|
| 403 | |
|---|
| 404 | |
|---|
| 405 | |
|---|
| 406 | |
|---|
| 407 | </h4> |
|---|
| 408 | |
|---|
| 409 | <div class="comments"></div> |
|---|
| 410 | |
|---|
| 411 | <h4 id="_plt1d_keyword_REVERSE_X">REVERSE_X |
|---|
| 412 | |
|---|
| 413 | |
|---|
| 414 | |
|---|
| 415 | |
|---|
| 416 | |
|---|
| 417 | |
|---|
| 418 | |
|---|
| 419 | |
|---|
| 420 | </h4> |
|---|
| 421 | |
|---|
| 422 | <div class="comments"> |
|---|
| 423 | To invert the x axis (so as the drawing) |
|---|
| 424 | </div> |
|---|
| 425 | |
|---|
| 426 | <h4 id="_plt1d_keyword_REVERSE_Y">REVERSE_Y |
|---|
| 427 | |
|---|
| 428 | |
|---|
| 429 | |
|---|
| 430 | |
|---|
| 431 | |
|---|
| 432 | |
|---|
| 433 | |
|---|
| 434 | |
|---|
| 435 | </h4> |
|---|
| 436 | |
|---|
| 437 | <div class="comments"> |
|---|
| 438 | To invert the y axis (so as the drawing) |
|---|
| 439 | </div> |
|---|
| 440 | |
|---|
| 441 | <h4 id="_plt1d_keyword_SWITCHXY">SWITCHXY |
|---|
| 442 | |
|---|
| 443 | |
|---|
| 444 | |
|---|
| 445 | |
|---|
| 446 | |
|---|
| 447 | |
|---|
| 448 | |
|---|
| 449 | |
|---|
| 450 | </h4> |
|---|
| 451 | |
|---|
| 452 | <div class="comments"></div> |
|---|
| 453 | |
|---|
| 454 | <h4 id="_plt1d_keyword__extra">_extra |
|---|
| 455 | |
|---|
| 456 | |
|---|
| 457 | |
|---|
| 458 | |
|---|
| 459 | |
|---|
| 460 | |
|---|
| 461 | |
|---|
| 462 | |
|---|
| 463 | </h4> |
|---|
| 464 | |
|---|
| 465 | <div class="comments"> |
|---|
| 466 | used to pass your keywords |
|---|
| 467 | </div> |
|---|
| 468 | |
|---|
| 469 | |
|---|
| 470 | |
|---|
| 471 | |
|---|
| 472 | <h3>Version history</h3> |
|---|
| 473 | |
|---|
| 474 | <h4>Version</h4><div class="preformat"> |
|---|
| 475 | $Id: plt1d.pro 172 2006-09-11 07:11:26Z smasson $ |
|---|
| 476 | </div> |
|---|
| 477 | <h4>History</h4><div class="preformat"> |
|---|
| 478 | creation 24/6/99 Eric Guilyardi |
|---|
| 479 | (a partir routine pltt de Sebastien Masson) |
|---|
| 480 | 8/7/1999 Sebastien Masson (smasson@lodyc.jussieu.fr) |
|---|
| 481 | inspection des travaux finis |
|---|
| 482 | 8/2/2000 Sebastien Masson: checkfield |
|---|
| 483 | </div> |
|---|
| 484 | |
|---|
| 485 | |
|---|
| 486 | |
|---|
| 487 | |
|---|
| 488 | |
|---|
| 489 | |
|---|
| 490 | |
|---|
| 491 | |
|---|
| 492 | |
|---|
| 493 | |
|---|
| 494 | |
|---|
| 495 | |
|---|
| 496 | |
|---|
| 497 | |
|---|
| 498 | |
|---|
| 499 | |
|---|
| 500 | <h3>Statistics</h3> |
|---|
| 501 | <table class="statistics"> |
|---|
| 502 | <tr><td>McCabe cyclic</td><td> 61</td></tr> |
|---|
| 503 | <tr><td>McCabe essential</td><td> 3</td></tr> |
|---|
| 504 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
|---|
| 505 | </table> |
|---|
| 506 | |
|---|
| 507 | |
|---|
| 508 | </div> |
|---|
| 509 | |
|---|
| 510 | </div> |
|---|
| 511 | |
|---|
| 512 | |
|---|
| 513 | |
|---|
| 514 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
|---|
| 515 | |
|---|
| 516 | </div> |
|---|
| 517 | |
|---|
| 518 | </body> |
|---|
| 519 | </html> |
|---|
