Changeset 352 for trunk/SRC/Documentation/xmldoc/wiki/MiniNotice
- Timestamp:
- 04/21/08 17:15:35 (16 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/xmldoc/wiki/MiniNotice
r351 r352 1 2 3 1 = Mini Guide for Basic Commands in the XXX Program = 4 2 [[PageOutline]] 5 3 6 4 7 5 … … 9 7 10 8 11 12 13 9 == Launching XXX == 14 15 10 16 11 There is several ways to launch XXX which we will detail in the next sections: … … 29 24 }}} 30 25 31 32 26 === idl> xxx === 33 27 34 28 A window will open with 3 parts to consider. 35 29 … … 60 54 61 55 62 63 64 56 ==== Data file name ==== 65 57 66 58 The name of the data file. It can be typed directly in the window provided, or selected with the help of the browse button. 67 59 68 69 60 ==== Grid initialization method ==== 70 61 71 62 For visualising grilled data, you need to [wiki:FirstSteps define the grid] on which are located the data. By default, "automatic grid construction with initncdf.pro" is checked. This means that the grid will be defined by using the informations contained in the data file (through the IDL prodecure {{{initncdf}}}) without needing any other auxiliary file. If you checked "grid construction with other IDL batch or procedure", this means that you don't want to use the default {{{initncdf}}} procedure to define the grid and you will provide your own IDL procedure or the so-called IDL batch file (a file which is called by using @, see IDL documentation). 72 63 73 74 64 ==== Grid initialization parameters ==== 75 65 76 66 This third part allows you to specify the name, the argument and the keywords of the routine you want to use to initialize the grid. 77 67 By default the name of the procedure is {{{initncdf}}}, its argument will be automatically defined so you cannot change them. If you If you checked "grid construction with other IDL batch or procedure", you have to select the name of the IDL procedure or batch file and its suitable arguments and keywords. Note that if you select an IDL batch file you cannot give any parameter or keyword. … … 84 74 85 75 86 87 88 76 Once these two lines have been completed, click on let's go. 89 90 77 For example, we choose the IDL batch file "tst_initlev". Compare the result with "automatic grid construction with initncdf.pro" checked. Cf [#Launching XXX] 91 92 93 94 78 Oceania at 125 meters of depth with proper grid initialization 95 79 … … 99 83 100 84 101 102 103 104 105 85 === idl> xxx, /separate === 106 86 107 87 This is the same as the simple idl> xxx except that once the xxx window open, you will have 2 separate windows (command and plotting window) instead of one. 108 88 109 110 111 89 === idl> xxx, restore = 'file.dat' === 112 90 113 91 In that case xxx window will open directly in the same state as it was when the file "file.dat" was created. see +++++++ 114 115 116 117 92 === idl> xxx, 'file.nc' === 118 93 … … 125 100 }}} 126 101 127 128 129 102 === idl> xxx, 'file.nc', keywd1 = âŠ, keywd2 = ⊠=== 130 103 … … 137 110 }}} 138 111 139 140 141 112 === idl> xxx, 'file.nc', 'initgrid' === 142 113 143 In this case, the xxx window directly open the data file 'file.nc' and build the grid directly with the IDL procedure or batch file {{{initgrid}}} 144 {{{ 114 In this case, the xxx window directly open the data file 'file.nc' and build the grid directly with the IDL procedure or batch file {{{initgrid}}}{{{ 145 115 #!html 146 116 <pre xmlns:xl="http://www.w3.org/1999/xlink" class="screen"> … … 149 119 }}} 150 120 151 152 153 121 === idl> xxx, 'file.nc', 'initgrid', keywd1 = âŠ, keywd2 = ⊠=== 154 122 155 123 In this case, the xxx window directly open the data file 'file.nc', build the grid directly with the IDL procedure {{{initgrid}}} and use the keywords keywd1 = âŠ, keywd2 = ⊠in the call of {{{initgrid}}}. 156 124 157 158 159 125 === idl> xxx, 'file.nc', 'initgrid', 'arg1, arg2, âŠ' === 160 126 161 127 In this case, the xxx window directly open the data file 'file.nc', build the grid directly with the IDL procedure {{{initgrid}}} and use the string 'arg1, arg2, âŠ' to specify the input arguments in the call of {{{initgrid}}}. 162 128 163 164 165 166 167 129 == Description of XXX window == 168 130 169 170 171 172 131 Window xxx 2 173 132 … … 218 177 219 178 Spefications 220 221 222 179 223 180 … … 228 185 === Plot type list === 229 186 Allows specification of the type of plot desired. 230 231 232 187 Different plot types available 233 188 … … 237 192 238 193 239 240 241 194 242 195 If the type plt is selected, the selection of plot type 243 196 is made by mouse. Cf [#Launching XXX] 244 197 245 246 247 198 === The menu bar made up of 3 sub-menus === 199 248 200 ==== File sub-menu ==== 249 201 250 251 202 The File menu 252 203 … … 255 206 256 207 257 258 259 260 261 * #xA;* #xA;* #xA; 262 263 208 * Open: to open a new file. Same procedure as during the launch of XXX. 209 The new file can be on a different grid, with different variables, with a different time base ⊠210 * New XXX: to open a second XXX window identical to the first one. @star@ Quit: to close the XXX window. 264 211 ==== Save As sub-menu ==== 265 212 266 267 213 The Save As menu 268 214 … … 271 217 272 218 273 274 275 276 277 * #xA;* #xA;* #xA;* #xA;* #xA;* #xA; 278 279 219 * Postscript: to save the plotting window in Postscript format @star@ Animated gif: to create an animation of the plotting window. 220 The creation of an animation is only possible if none of the plots have a time axis, and if the plots are all on the same time base (calendar). On the other hand, animations of horizontal and vertical plots, with different color palettes (for those not on an X-terminal), are possible.The creation of animations has a tendency to saturate the video memory of X-terminals, crashing the entire program ⊠* Gif: to save a gif of the plotting window. @star@ IDL procedure: to save the command history that has created the plot in an IDL procedure that can be re-executed later. For example if I save the commands in {{{xxx_figure.pro}}} file, when ever I want, I can then launch a new IDL session and type: 221 {{{ 222 #!html 223 <pre xmlns:xl="http://www.w3.org/1999/xlink" class="screen"> 224 <code class="prompt">idl></code> <strong class="userinput"><code>@init</code></strong> 225 <code class="prompt">idl></code> <strong class="userinput"><code>xxx_figure</code></strong> 226 </pre> 227 }}} 228 229 and I'll obtain the saved figure. 230 {{{ 231 #!html 232 <pre xmlns:xl="http://www.w3.org/1999/xlink" class="screen"> 233 <code class="prompt">idl></code> <strong class="userinput"><code>xxx_figure,/post</code></strong> 234 </pre> 235 }}} 236 237 or 238 {{{ 239 #!html 240 <pre xmlns:xl="http://www.w3.org/1999/xlink" class="screen"> 241 <code class="prompt">idl></code> <strong class="userinput"><code>@ps</code></strong> 242 </pre> 243 }}} 244 245 will then create a Postscript file of the figure. 246 * RESTORE kwd of xxx: to save the xxx widget (all buttons and parameters stored in memory âŠ) in a binary file in order to quit xxx and relaunch it later with idl> xxx, restore = 'file.dat' and get exactly the same configuration. @star@ Print to prompt: lists in the IDL window the command history that created the last plot. Useful primarily for debugging⊠280 247 ==== Flag options sub-menu ==== 281 248 282 283 249 The Flag Option menu 284 250 … … 287 253 288 254 289 290 291 292 293 * #xA;* #xA;* #xA;* #xA;* #xA; 294 295 Careful, a selected option remains selected until it is re-clicked. 296 297 298 255 * Portrait/Landscape: changes the configuration of the plot. @star@ Overlay: to plot contours of a different field on top the 256 one represented as color-filled contours. It is necessary to relaunch the entire plot to make this work! * Vecteur: to plot a vector field on top of contours. Only 257 works on horizontal plots ({{{plt.pro}}}). 258 As for Overlay, a relaunch of the entire plot is necessary. * Longitude / x index: switches longitude labeling of the plot sub-domain from degrees to indexes following i. @star@ Latitude / y index: switches latitude labeling of the plot sub-domain from degrees to indexes following j.Careful, a selected option remains selected until it is re-clicked. 299 259 === OK button === 300 260 Click on this OK button is required to make a new plot appear 301 302 303 261 === Page Layout === 304 262 Specify the number of columns and rows for plots on the sheet of paper. 305 306 307 263 Number of Column 308 264 … … 312 268 313 269 314 315 316 317 270 Example: For 2 columns and 2 rows 318 271 … … 322 275 323 276 324 325 326 327 277 === List of variables === 328 278 You can choose the variable to work on. 329 330 331 279 Example of different Variables available 332 280 … … 336 284 337 285 338 339 340 341 286 === List of open files === 342 287 You can choose the file to work on. 343 344 345 288 Example of list of open files 346 289 … … 350 293 351 294 352 353 354 355 295 === Command text === 356 296 357 297 To specify in the widget part number 7 the computation you want to do on the data 358 298 In all cases bellow, the name given to a field (a, b, c, âŠ) is of no importance. 359 360 299 ==== Linear calculation ==== 361 300 … … 363 302 #!html 364 303 <pre xmlns:xl="http://www.w3.org/1999/xlink" class="screen">a - b</pre> 365 }}}{{{ 304 }}} 305 {{{ 366 306 #!html 367 307 <pre xmlns:xl="http://www.w3.org/1999/xlink" class="screen">numb1*a</pre> 368 }}}{{{ 308 }}} 309 {{{ 369 310 #!html 370 311 <pre xmlns:xl="http://www.w3.org/1999/xlink" class="screen">a + numb</pre> 371 }}} or any command with the following format {{{ 312 }}} 313 or any command with the following format {{{ 372 314 #!html 373 315 <pre xmlns:xl="http://www.w3.org/1999/xlink" class="screen">numb1*a + numb2*b + numb3*c ⊠+ numb</pre> 374 }}} where numb1, numb2, ⊠correspond to numbers and a, b, c ⊠will be the data to read.375 316 }}} 317 where numb1, numb2, ⊠correspond to numbers and a, b, c ⊠will be the data to read. 376 318 377 319 ==== Any kind of computation ==== … … 380 322 #!html 381 323 <pre xmlns:xl="http://www.w3.org/1999/xlink" class="screen">"a"^2</pre> 382 }}}{{{ 324 }}} 325 {{{ 383 326 #!html 384 327 <pre xmlns:xl="http://www.w3.org/1999/xlink" class="screen">"a" - abs("b")</pre> 385 }}}{{{ 328 }}} 329 {{{ 386 330 #!html 387 331 <pre xmlns:xl="http://www.w3.org/1999/xlink" class="screen">grad("a", 'x')</pre> 388 }}} ⊠389 390 391 332 }}} 333 ⊠392 334 393 335 === Calendar === 394 336 395 337 The calendar is made up of two drop-lists, which allow specification of two dates, the beginning and end of a time series, or the period over which to average before plotting. 396 397 398 338 Example: first plot in January, second plot is from January to December 399 339 … … 403 343 404 344 405 406 407 408 345 === Define the domain === 409 346 … … 417 354 418 355 419 420 356 Change Domain area: zoom on Oceania 421 357 … … 425 361 426 362 427 428 363 This configuration give us: 429 364 … … 433 368 434 369 435 436 370 Change depth area: between depth 125 and 126 437 371 … … 441 375 442 376 443 444 377 temperature of the ocean at depth 125 meters without proper land/sea mask 445 378 … … 450 383 451 384 As you can see, at this depth, we better define a land/sea mask when loading the grid. Cf [#Launching XXX] 452 453 454 455 385 === Specify your plot === 456 386 457 387 ==== Specify min, max and contour interval ==== 458 388 459 460 389 min, max, and contour interval specifications 461 390 … … 467 396 You can restore configuration by default by pressing the Default button. 468 397 The path of the file [../../ToBeReviewed/WIDGET/AUTOUR_de_XXX/definedefaultextra.pro definedefaultextra.pro] that defines the default values for each variable names is displayed when the cursor hovers over the button Default. This file contains a case statement based on the name of the variable and defining the min, max, contour interval and other keywords that should be used as default for the specified variable. You can copy this file in your own {{{${HOME}/My_IDL/}}} directory and easily modify it to suit your favorite default values. 469 470 471 472 398 ==== Specify the palette to be used ==== 473 399 For the color palette, you can either specify the name or go search for one among the palettes available. 474 475 476 400 The Color menu 477 401 … … 481 405 482 406 483 484 485 486 407 ==== Add any keyword ==== 487 408 … … 495 416 496 417 497 498 418 Add {{{/realcont}}} keyword 499 419 … … 503 423 504 424 505 506 425 Graphic with {{{/realcont}}} keyword 507 426 … … 511 430 512 431 513 514 432 Add /realcont, map=[90,0,0], /ortho, cell_fill=2 keywords 515 433 … … 519 437 520 438 521 522 439 Graphic with /realcont, map=[90,0,0], /ortho, cell_fill=2 keywords 523 440 … … 527 444 528 445 529 530 531 532 533 534 446 == Mouse Actions == 535 447 … … 538 450 Select a domain and select the horizontal plot (plt), vertical plot 539 451 (pltz), or the hovmoeller plot (pltt): 540 541 452 The domain we'd like to select for the plot is determined by one of 542 453 its diagonals, defined therefore by two points. … … 548 459 To determine which type of plot should be made of selection, use: 549 460 550 551 If the plot selector is on plt 552 553 * #xA;* #xA;* #xA; 554 555 556 In summary: 557 558 559 560 * #xA;* #xA; 561 562 563 * #xA;* #xA; 564 565 566 * #xA;* #xA; 567 568 569 570 571 If the plot selector is on something other than plt the indicated plot type is made. 572 573 461 * If the plot selector is on plt * the left mouse button to create horizontal plots (plt) @star@ the middle mouse button to create vertical plots (pltz) @star@ the right mouse button to create common hovmoellers for xt and yt cuts (pltt)In summary: LCL--->plt 462 463 464 [[Image(source:/trunk/SRC/Documentation/xmldoc/figpng/xxx_mousell.png)]] 465 466 467 468 Horizontal Plot 469 470 471 [[Image(source:/trunk/SRC/Documentation/xmldoc/figpng/xxx_0701.png)]] 472 473 474 * LCM--->pltz 475 476 477 [[Image(source:/trunk/SRC/Documentation/xmldoc/figpng/xxx_mouselm.png)]] 478 479 480 481 Vertical Plot 482 483 484 [[Image(source:/trunk/SRC/Documentation/xmldoc/figpng/xxx_0702.png)]] 485 486 487 * LCR--->pltt 488 489 490 [[Image(source:/trunk/SRC/Documentation/xmldoc/figpng/xxx_mouselr.png)]] 491 492 493 494 Common hovmoeller for xt and yt cuts 495 496 497 [[Image(source:/trunk/SRC/Documentation/xmldoc/figpng/xxx_0703.png)]] 498 499 500 If the plot selector is on something other than plt the indicated plot type is made. 574 501 === Create multiple plots on the same sheet and make them interact === 575 502 576 577 503 Select the number of columns and rows for the page. 578 579 504 Create a first plot. 580 505 It will appear in the first frame. 581 582 506 To create a plot in another frame double-click in the frame with the 583 507 middle button (DCM). … … 590 514 frame, all the widgets change and refer again to the first plot. 591 515 A double-click with the right button in the second frame will erase the 592 plot. 593 In summary: 594 595 596 * #xA;* #xA; 597 598 599 * #xA;* #xA; 600 601 * #xA; 602 603 Here's a series of commands to show how this works. 604 516 * plot.In summary: DCL--->"reference" frame 517 518 519 [[Image(source:/trunk/SRC/Documentation/xmldoc/figpng/xxx_mousedl.png)]] 520 521 522 523 The reference frame is selected 524 525 526 [[Image(source:/trunk/SRC/Documentation/xmldoc/figpng/xxx_0801.png)]] 527 528 529 * DCM--->"target" frame 530 531 532 [[Image(source:/trunk/SRC/Documentation/xmldoc/figpng/xxx_mousedm.png)]] 533 534 535 536 The target frame is selected 537 538 539 [[Image(source:/trunk/SRC/Documentation/xmldoc/figpng/xxx_0802.png)]] 540 541 542 * DCR--->erase the frame 543 544 545 [[Image(source:/trunk/SRC/Documentation/xmldoc/figpng/xxx_mousedr.png)]] 546 547 548 Here's a series of commands to show how this works. 605 549 606 550 … … 626 570 627 571 628 629 572 DCM in frame 2, LCL on the plot in frame 1, to create a horizontal 630 573 zoom in frame 2. 631 632 574 DCM in frame 3, LCM on the plot in frame 1, to create a vertical cut 633 575 in frame 3. 634 635 576 DCM in frame 4, LCR on the plot in frame 1, to create a hovmoeller in frame 4. 636 577 637 578 638 639 579 Frame with four plot 640 580 … … 647 587 648 588 649 650 651 589 To redo the hovmoeller with the keyword {{{/nocontour}}} 652 653 654 590 655 591 DCL in frame 4 which now becomes the reference and target frame. … … 661 597 {{{/nocontour}}} 662 598 663 664 665 599 Command text area 666 600 … … 673 607 674 608 675 676 609 click OK, and the plot is redone. 677 610 678 611 679 680 612 The fourth plot with the keyword "nocontour" 681 613 … … 688 620 689 621 690 691 692 622 in frame 5, let's create the same plot as in frame 2 except we use pltv instead of plt 693 623 694 624 695 696 625 DCL on frame 2 697 626 698 627 699 628 700 701 629 DCM on frame 5 702 630 … … 711 639 Click on OK 712 640 713 714 715 641 Frame with five plot 716 642 … … 722 648 723 649 724 725 726 727 650 == What should I do when it breakdown == 728 729 730 731 651 732 652 … … 740 660 741 661 742 743 662 in the IDL window, type 744 663 {{{ … … 749 668 }}} 750 669 751 752 670 DCR to erase the problem frame. 753 671 754 755 672 change the orientation of the plot by pressing Flag options -> Portrait/Landscape. Cf [#Launching XXX] 756 757 673 quit XXX cleanly using quit from the File menu. Cf [#Launching XXX] 758 759 760 761 674 762 675 … … 775 688 776 689 777 778
Note: See TracChangeset
for help on using the changeset viewer.