MethodDoc.C 261 KB
Newer Older
hrchilds's avatar
hrchilds committed
1 2
/*****************************************************************************
*
brugger's avatar
 
brugger committed
3
* Copyright (c) 2000 - 2013, Lawrence Livermore National Security, LLC
hrchilds's avatar
hrchilds committed
4
* Produced at the Lawrence Livermore National Laboratory
brugger's avatar
 
brugger committed
5
* LLNL-CODE-442911
hrchilds's avatar
hrchilds committed
6 7
* All rights reserved.
*
brugger's avatar
 
brugger committed
8
* This file is  part of VisIt. For  details, see https://visit.llnl.gov/.  The
hrchilds's avatar
hrchilds committed
9 10 11 12 13 14 15 16 17 18
* full copyright notice is contained in the file COPYRIGHT located at the root
* of the VisIt distribution or at http://www.llnl.gov/visit/copyright.html.
*
* Redistribution  and  use  in  source  and  binary  forms,  with  or  without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of  source code must  retain the above  copyright notice,
*    this list of conditions and the disclaimer below.
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this  list of  conditions  and  the  disclaimer (as noted below)  in  the
brugger's avatar
 
brugger committed
19 20 21
*    documentation and/or other materials provided with the distribution.
*  - Neither the name of  the LLNS/LLNL nor the names of  its contributors may
*    be used to endorse or promote products derived from this software without
hrchilds's avatar
hrchilds committed
22 23 24 25 26
*    specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT  HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR  IMPLIED WARRANTIES, INCLUDING,  BUT NOT  LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND  FITNESS FOR A PARTICULAR  PURPOSE
brugger's avatar
 
brugger committed
27 28 29
* ARE  DISCLAIMED. IN  NO EVENT  SHALL LAWRENCE  LIVERMORE NATIONAL  SECURITY,
* LLC, THE  U.S.  DEPARTMENT OF  ENERGY  OR  CONTRIBUTORS BE  LIABLE  FOR  ANY
* DIRECT,  INDIRECT,   INCIDENTAL,   SPECIAL,   EXEMPLARY,  OR   CONSEQUENTIAL
hrchilds's avatar
hrchilds committed
30 31 32 33 34 35 36 37 38
* DAMAGES (INCLUDING, BUT NOT  LIMITED TO, PROCUREMENT OF  SUBSTITUTE GOODS OR
* SERVICES; LOSS OF  USE, DATA, OR PROFITS; OR  BUSINESS INTERRUPTION) HOWEVER
* CAUSED  AND  ON  ANY  THEORY  OF  LIABILITY,  WHETHER  IN  CONTRACT,  STRICT
* LIABILITY, OR TORT  (INCLUDING NEGLIGENCE OR OTHERWISE)  ARISING IN ANY  WAY
* OUT OF THE  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*
*****************************************************************************/

hrchilds's avatar
hrchilds committed
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
const char *visit_AddArgument_doc = 
"AddArgument\n"
"-Add an argument to the viewer's command line argument list.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"AddArgument(argument)\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"argument\n"
"A string object that is added to the viewer's command line argument list.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"AddArgument does not return a value.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The AddArgument function is used to add extra command line arguments to\n"
"VisIt's viewer. This is only useful when VisIt's Python interface is\n"
"imported into a stand-alone Python interpreter because the AddArgument\n"
"function must be called before the viewer is launched. The AddArgument\n"
"function has no effect when used in VisIt's cli program because the viewer\n"
"is automatically launched before any commands are processed.\n"
"\n"
"\n"
"Example:\n"
"\n"
"import visit\n"
"visit.AddArgument(\"-nowin\") # Add the -nowin argument to the viewer.\n"
;
const char *visit_Close_doc = 
"Close\n"
"-Closes the viewer.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"Close()\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"none\n"
"\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The Close function does not return a value.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The Close function terminates VisIt's viewer. This is useful for Python\n"
"scripts that only need access to VisIt's capabilties for a short time\n"
"before closing VisIt.\n"
"\n"
"\n"
"Example:\n"
"\n"
"import visit\n"
"visit.Launch()\n"
"visit.Close() # Close the viewer\n"
"\n"
;
const char *visit_Launch_doc = 
"Launch\n"
"-Launches VisIt's viewer\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
117 118 119 120
"Launch() -> integer\n"
"Launch(program) -> integer\n"
"LaunchNowin() -> integer\n"
"LaunchNowin(program) -> integer\n"
hrchilds's avatar
hrchilds committed
121 122 123 124
"\n"
"\n"
"Arguments:\n"
"\n"
125 126
"program\n"
"The complete path to the top level 'visit' script.\n"
hrchilds's avatar
hrchilds committed
127 128 129 130 131 132
"\n"
"\n"
"\n"
"\n"
"Returns:\n"
"\n"
133
"The Launch functions return 1 for success and 0 for failure\n"
hrchilds's avatar
hrchilds committed
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
"\n"
"\n"
"Description:\n"
"\n"
"The Launch function is used to launch VisIt's viewer when the VisIt module\n"
"is imported into a stand-alone Python interpreter. The Launch function has\n"
"no effect when a viewer already exists. The difference between Launch and\n"
"LaunchNowin is that LaunchNowin prevents the viewer from ever creating\n"
"onscreen visualization windows. The LaunchNowin function is primarily used\n"
"in Python scripts that want to generate visualizations using VisIt without\n"
"the use of a display such as when generating movies.\n"
"\n"
"\n"
"Example 1:\n"
"\n"
"import visit\n"
"visit.AddArgument(\"-geometry\")\n"
"visit.AddArgument(\"1024x1024\")\n"
"visit.LaunchNowin()\n"
"\n"
"Example 2:\n"
"\n"
"import visit\n"
"visit.AddArgument(\"-nowin\")\n"
"visit.Launch()\n"
;
const char *visit_LocalNamespace_doc = 
"LocalNamespace\n"
"-Tells the VisIt module to import plugins into the global namespace.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"LocalNamespace()\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"none\n"
"\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The LocalNamespace function does not return a value.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The LocalNamespace function tells the VisIt module to add plugin functions\n"
"to the global namespace when the VisIt module is imported into a\n"
"stand-alone Python interpreter. This is the default behavior when using\n"
"VisIt's cli program.\n"
"\n"
"\n"
"Example:\n"
"\n"
"import visit\n"
"visit.LocalNamespace()\n"
"visit.Launch()\n"
;
const char *visit_DebugLevel_doc = 
"DebugLevel\n"
"-Set or Get the VisIt module's debug level.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"GetDebugLevel() -> integer\n"
"SetDebugLevel(level)\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"level\n"
209 210 211 212
"A string '1', '2', '3', '4', '5' with an optional 'b' suffix to indicate\n"
"whether the output should be buffered. A value of '1' is a low debug level\n"
", which should be used to produce little output while a value of 5 should \n"
"produce a lot of debug output.\n"
hrchilds's avatar
hrchilds committed
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 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 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
"\n"
"\n"
"Returns:\n"
"\n"
"The GetDebugLevel function returns the debug level of the VisIt module.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The GetDebugLevel and SetDebugLevel functions are used when debugging\n"
"VisIt Python scripts. The SetDebugLevel function sets the debug level for\n"
"VisIt's viewer thus it must be called before a Launch method. The debug\n"
"level determines how much detail is written to VisIt's execution logs when\n"
"it executes. The GetDebugLevel function can be used in Python scripts to\n"
"alter the behavior of the script. For instance, the debug level can be used\n"
"to selectively print values to the console.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli -debug 2\n"
"print \"VisIt's debug level is: %d\" % GetDebugLevel()\n"
;
const char *visit_Version_doc = 
"Version\n"
"-Returns VisIt's version string.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"Version() -> string\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The Version function return a string that represents VisIt's version.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The Version function returns a string that represents VisIt's version. The\n"
"version string can be used in Python scripts to make sure that the VisIt\n"
"module is a certain version before processing the rest of the Python script.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"print \"We are running VisIt version %s\" % Version()\n"
;
const char *visit_ActivateDatabase_doc = 
"ActivateDatabase\n"
"-Activates a database that has been previously opened.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"ActivateDatabase(argument) -> integer\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"argument\n"
"A string object containing the name of the database to be activated.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"ActivateDatabase returns 1 on success and 0 on failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The ActivateDatabase function is used to set the active database to a\n"
"database that has been previously opened. The ActivateDatabase function\n"
"only works when you are using it to activate a database that you have\n"
"previously opened. You do not need to use this function unless you\n"
"frequently toggle between more than one database when making plots or\n"
whitlocb's avatar
whitlocb committed
291 292 293 294
"changing time states. While the OpenDatabase function can also be used\n"
"to set the active database, the ActivateDatabase function does not have any\n"
"side effects that would cause the time state for the new active database\n"
"to be changed.\n"
hrchilds's avatar
hrchilds committed
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"dbs = (\"/usr/gapps/visit/data/wave.visit\", \\\n"
"\"/usr/gapps/visit/data/curv3d.silo\")\n"
"OpenDatabase(dbs[0], 17)\n"
"AddPlot(\"Pseudocolor\", \"u\")\n"
"DrawPlots()\n"
"\n"
"OpenDatabase(dbs[1])\n"
"AddPlot(\"Pseudocolor\", \"u\")\n"
"DrawPlots()\n"
"\n"
"# Let's add another plot from the first database.\n"
"ActivateDatabase(dbs[0])\n"
"AddPlot(\"Mesh\", \"quadmesh\")\n"
"DrawPlots()\n"
;
const char *visit_AddOperator_doc = 
"AddOperator\n"
317
"-Adds the named operator to the active plots.\n"
hrchilds's avatar
hrchilds committed
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
"\n"
"\n"
"Synopsis:\n"
"\n"
"AddOperator(operator) -> integer\n"
"AddOperator(operator, all) -> integer\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"operator\n"
"This is a string containing the name of the operator to be applied.\n"
"all\n"
"This is an optional integer argument that applies the operator to all\n"
"plots if the value of the argument is not zero.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The AddOperator function returns an integer value of 1 for success and 0\n"
"for failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
343
"The AddOperator function adds a VisIt operator to the active plots. The\n"
hrchilds's avatar
hrchilds committed
344
"operator argument is a string containing the name of the operator to be\n"
345
"added to the active plots. The operatore name must be a valid operator\n"
hrchilds's avatar
hrchilds committed
346
"plugin name that is a member of the tuple returned by the OperatorPlugins\n"
whitlocb's avatar
whitlocb committed
347
"function. The all argument is an integer that determines\n"
hrchilds's avatar
hrchilds committed
348
"whether or not the operator is applied to all plots. If the all argument is\n"
349
"not provided, the operator is only added to active plots. Once the\n"
hrchilds's avatar
hrchilds committed
350
"AddOperator function is called, the desired operator is added to all\n"
351
"active plots unless the all argument is a non-zero value. When the all\n"
hrchilds's avatar
hrchilds committed
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
"argument is a non-zero value, the operator is applied to all plots\n"
"regardless of whether or not they are selected. Operator attributes are set\n"
"through the SetOperatorOptions function.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/globe.silo\")\n"
"AddPlot(\"Pseudocolor\", \"u\")\n"
"AddPlot(\"Mesh\", \"mesh1\")\n"
"AddOperator(\"Slice\", 1) # Slice both plots\n"
"DrawPlots()\n"
;
const char *visit_AddPlot_doc = 
"AddPlot\n"
"-Creates a new plot.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"AddPlot(plotType, variableName) -> integer\n"
374 375
"AddPlot(plotType, variableName, inheritSIL) -> integer\n"
"AddPlot(plotType, variableName, inheritSIL, applyOperators) -> integer\n"
hrchilds's avatar
hrchilds committed
376 377 378 379 380
"\n"
"\n"
"Arguments:\n"
"\n"
"plotType\n"
381
"    This is a string containing the name of a valid plot plugin type.\n"
hrchilds's avatar
hrchilds committed
382
"variableName \n"
383 384 385 386 387 388 389
"    This is a string containing a valid variable name for the open database.\n"
"inheritSIL\n"
"    This is an integer flag indicating whether the plot should inherit the\n"
"    active plot's SIL restriction.\n"
"applyOperators\n"
"    This is an integer flag indicating whether the operators from the active\n"
"    plot should be applied to the new plot.\n"
hrchilds's avatar
hrchilds committed
390 391 392 393 394 395 396 397 398 399 400 401 402
"\n"
"\n"
"Returns:\n"
"\n"
"The AddPlot function returns an integer value of 1 for success and 0 for\n"
"failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The AddPlot function creates a new plot of the specified type using a\n"
"variable from the open database. The plotType argument is a string that\n"
"contains the name of a valid plot plugin type which must be a member of the\n"
whitlocb's avatar
whitlocb committed
403
"string tuple that is returned by the PlotPlugins function.\n"
hrchilds's avatar
hrchilds committed
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503
"The variableName argument is a string that contains the name of a variable\n"
"in the open database. After the AddPlot function is called, a new plot is\n"
"created and it is made the sole active plot.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/globe.silo\")\n"
"AddPlot(\"Subset\", \"mat1\") # Create a subset plot\n"
"DrawPlots()\n"
;
const char *visit_AddWindow_doc = 
"AddWindow\n"
"-Creates a new visualization window.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"AddWindow()\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The AddWindow function does not a return value.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The AddWindow function creates a new visualization window and makes it the\n"
"active window. This function can be used to create up to 16 visualization\n"
"windows. After that, the AddWindow function has no effect.\n"
"\n"
"\n"
"Example:\n"
"\n"
"import visit\n"
"visit.Launch()\n"
"visit.AddWindow() # Create window #2\n"
"visit.AddWindow() # Create window #3\n"
;
const char *visit_AlterDatabaseCorrelation_doc = 
"AlterDatabaseCorrelation\n"
"-Alters a specific database correlation.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"AlterDatabaseCorrelation(name, databases, method) -> integer\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"name\n"
"The name argument must be a string object containing the name of the\n"
"database correlation to be altered.\n"
"databases\n"
"The databases argument must be a tuple or list of strings containing the\n"
"fully qualified database names to be used in the database correlation.\n"
"method\n"
"The method argument must be an integer in the range [0,3].\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The AlterDatabaseCorrelation function returns 1 on success and 0 on\n"
"failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The AlterDatabaseCorrelation method alters an existing database\n"
"correlation. A database correlation is a VisIt construct that relates the\n"
"time states for two or more databases in some way. You would use the\n"
"AlterDatabaseCorrelation function if you wanted to change the list of\n"
"databases used in a database correlation or if you wanted to change how the\n"
"databases are related - the correlation method. The name argument is a\n"
"string that is the name of the database correlation to be altered. If the\n"
"name that you pass is not a valid database correlation then the\n"
"AlterDatabaseCorrelation function fails. The databases argument is a list\n"
"or tuple of string objects containing the fully-qualified\n"
"(host:/path/filename) names of the databases to be involved in the database\n"
"query. The method argument allows you to specify a database correlation\n"
"method.\n"
"Correlation method\t\tValue\n"
"IndexForIndexCorrelation\t0\n"
"StretchedIndexCorrelation\t1\n"
"TimeCorrelation\t\t\t2\n"
"CycleCorrelation\t\t\t3\n"
"\n"
"dbs = (\"/usr/gapps/visit/data/wave.visit\", \\\n"
"\"/usr/gapps/visit/data/wave*.silo database\")\n"
"OpenDatabase(dbs[0])\n"
"AddPlot(\"Pseudocolor\", \"pressure\")\n"
"OpenDatabase(dbs[1])\n"
"AddPlot(\"Pseudocolor\", \"d\")\n"
"# VisIt created an index for index database correlation but we \n"
"# want a cycle correlation.\n"
"AlterDatabaseCorrelation(\"Correlation01\", dbs, 3)\n"
;
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
const char *visit_ApplyNamedSelection_doc = 
"ApplyNamedSelection \n"
"-Applies a named selection to the active plot.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"ApplyNamedSelection(name) -> integer\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"name\n"
"The name of a named selection.  (This should have been previously created\n"
"with a CreateNamedSelection call.)\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The ApplyNamedSelection function returns 1 for success and 0 for failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"Named Selections allow you to select a group of elements (or particles).\n"
"One typically creates a named selection from a group of elements and then\n"
"later applies the named selection to another plot (thus reducing the\n"
"set of elements displayed to the ones from when the named selection was\n"
"created).\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"db = \"/usr/gapps/visit/data/wave*.silo database\"\n"
"OpenDatabase(db)\n"
"AddPlot(\"Pseudocolor\", \"pressure\")\n"
"AddOperator(\"Clip\")\n"
"c = ClipAttributes()\n"
"c.plane1Origin = (0,0.6,0)\n"
"c.plane1Normal = (0,-1,0)\n"
"SetOperatorOption(c)\n"
"DrawPlots()\n"
"\n"
"CreateNamedSelection(\"els_above_at_time_0\")\n"
whitlocb's avatar
whitlocb committed
549
"SetTimeSliderState(40)\n"
550 551 552
"RemoveLastOperator()\n"
"ApplyNamedSelection(\"els_above_at_time_0\")\n"
;
hrchilds's avatar
hrchilds committed
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
const char *visit_ChangeActivePlotsVar_doc = 
"ChangeActivePlotsVar\n"
"-Changes the variable for the active plots\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"ChangeActivePlotsVar(variableName) -> integer\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"variableName\n"
"The name of the new plot variable.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The ChangeActivePlotsVar function returns an integer value of 1 for\n"
"success and 0 for failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The ChangeActivePlotsVar function changes the plotted variable for the\n"
578
"active plots. This is a useful way to change what is being visualized\n"
hrchilds's avatar
hrchilds committed
579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
"without having to delete and recreate the current plots. The variableName\n"
"argument is a string that contains the name of a variable in the open\n"
"database.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/globe.silo\")\n"
"AddPlot(\"Pseudocolor\", \"u\")\n"
"DrawPlots()\n"
"SaveWindow()\n"
"ChangeActivePlotsVar(\"v\")\n"
;
const char *visit_CheckForNewStates_doc = 
"CheckForNewStates \n"
"-Checks the specified database for new time states.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"CheckForNewStates(name) -> integer\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"name\n"
"The name argument must be a string that contains the name of a database\n"
"that has been opened previously.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The CheckForNewStates function returns 1 for success and 0 for failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"Calculations are often run at the same time as some of the preliminary\n"
"visualization work is being performed. That said, you might be visualizing\n"
"the leading time states of a database that is still being created. If you\n"
"want to force VisIt to add any new time states that were added since you\n"
"opened the database, you can use the CheckForNewStates function. The name\n"
"argument must contain the name of a database that has been opened before.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"db = \"/usr/gapps/visit/data/wave*.silo database\"\n"
"OpenDatabase(db)\n"
"AddPlot(\"Pseudocolor\", \"pressure\")\n"
"DrawPlots()\n"
"\n"
"SetTimeSliderState(TimeSliderGetNStates() - 1)\n"
"# More files appear on disk\n"
"CheckForNewStates(db)\n"
"SetTimeSliderState(TimeSliderGetNStates() - 1)\n"
;
const char *visit_ChooseCenterOfRotation_doc = 
"ChooseCenterOfRotation\n"
"-Allows you to interactively pick a new center of rotation.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"ChooseCenterOfRotation() -> integer\n"
"ChooseCenterOfRotation(screenX, screenY) -> integer\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"screenX\n"
"The X coordinate of the pick point in normalized [0,1] screen space.\n"
"screenY\n"
"The Y cooridinate of the pick point in normalized [0,1] screen space.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The ChooseCenterOfRotation function returns 1 if successful and 0 if it\n"
"fails.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The ChooseCenterOfRotation function allows you to pick a new center of\n"
"rotation, which is the point about which plots are rotated when you\n"
"interactively rotate plots. The function can either take zero arguments, in\n"
"which case you must interactively pick on plots, or it can take two\n"
"arguments that correspond to the X and Y coordinates of the desired pick\n"
"point in normalized screen space. When using the two argument version of\n"
"the ChooseCenterOfRotation function, the X and Y values are floating point\n"
"values in the range [0,1]. If the ChooseCenterOfRotation function is able\n"
"to actually pick on plots, yes there must be plots in the vis window, then\n"
"the center of rotation is updated and the new value is printed to the\n"
"console.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/globe.silo\")\n"
"AddPlots(\"Pseudocolor\", \"u\")\n"
"DrawPlots()\n"
"\n"
"# Interactively choose the center of rotation\n"
"ChooseCenterOfRotation()\n"
"\n"
"# Choose a center of rotation using normalized screen \n"
"# coordinates and print the value.\n"
"ResetView()\n"
"ChooseCenterOfRotation(0.5, 0.3)\n"
"print \"The new center of rotation is:\", GetView3D().centerOfRotation\n"
;
const char *visit_ClearCache_doc = 
"ClearCache\n"
"-Clears the compute engine's network cache.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"ClearCache(host) -> integer\n"
"ClearCache(host, simulation) -> integer\n"
"ClearCacheForAllEngines() -> integer\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"host\n"
"The name of the computer where the compute engine is running.\n"
"simulation\n"
"The name of the simulation being processed by the compute engine.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The ClearCache and ClearCacheForAllEngines functions return 1 on success\n"
"and 0 on failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"Sometimes during extended VisIt runs, you might want to periodically clear\n"
"the compute engine's network cache to reduce the amount of memory being\n"
"used by the compute engine. Clearing the network cache is also useful when\n"
"you want to change what the compute engine is working on. For example, you\n"
"might process a large database and then decide to process another large\n"
"database. Clearing the network cache beforehand will free up more resources\n"
"for the compute engine so it can more efficiently process the new database.\n"
"The host argument is a string object containing the name of the computer on\n"
"which the compute engine is running. The simulation argument is optional\n"
"and only applies to when you want to instruct a simulation that is acting\n"
"as a VisIt compute engine to clear its network cache. If you want to tell\n"
"more than one compute engine to clear its cache without having to call\n"
"ClearCache multiple times, you can use the ClearCacheForAllEngines function.\n"
"\n"
"\n"
"Example:\n"
"\n"
"%visit -cli\n"
"OpenDatabase(\"localhost:very_large_database\")\n"
"# Do a lot of work\n"
"ClearCache(\"localhost\")\n"
"OpenDatabase(localhost:another_large_database\")\n"
"# Do more work\n"
"OpenDatabase(\"remotehost:yet_another_database\")\n"
"# Do more work\n"
"ClearCacheForAllEngines()\n"
;
const char *visit_Clear_doc = 
"Clear\n"
"-Clears visualization windows of plots.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
756 757
"ClearAllWindows() -> integer\n"
"ClearWindow() -> integer\n"
hrchilds's avatar
hrchilds committed
758 759 760 761
"\n"
"\n"
"Returns:\n"
"\n"
762
"1 on success, 0 on failure.\n"
hrchilds's avatar
hrchilds committed
763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
"\n"
"\n"
"Description:\n"
"\n"
"The ClearWindow function is used to clear out the plots from the active\n"
"visualization window. The plots are removed from the visualization window\n"
"but are left in the plot list so that subsequent calls to the DrawPlots\n"
"function regenerate the plots in the plot list. The ClearAllWindows\n"
"function preforms the same work as the ClearWindow function except that all\n"
"windows are cleared of their plots.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/globe.silo\")\n"
"AddPlot(\"Pseudocolor\", \"u\")\n"
"DrawPlots()\n"
"\n"
"AddWindow()\n"
"SetActiveWindow(2) # Make window 2 active\n"
"OpenDatabase(\"/usr/gapps/visit/data/globe.silo\")\n"
"AddPlot(\"Subset\", \"mat1\")\n"
"DrawPlots()\n"
"\n"
"ClearWindow() # Clear the plots in window 2.\n"
"DrawPlots() # Redraw the plots in window 2.\n"
"\n"
"ClearAllWindows() # Clear the plots from all windows.\n"
;
const char *visit_ClearPickPoints_doc = 
"ClearPickPoints\n"
"-Clears pick points from the visualization window\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"ClearPickPoints()\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The ClearPickPoints function does not return a value.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The ClearPickPoints function removes pick points from the active\n"
"visualization window. Pick points are the letters that are added to the\n"
"visualization window where the mouse is clicked when the visualization\n"
"window is in pick mode.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"# Put the visualization window into pick mode using the popup \n"
"# menu and add some pick points.\n"
"\n"
"# Clear the pick points.\n"
"ClearPickPoints()\n"
;
const char *visit_ClearReferenceLines_doc = 
"ClearReferenceLines\n"
"-Clears reference lines from the visualization window.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"ClearReferenceLines()\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The ClearReferenceLines function does not return a value.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The ClearReferenceLines function removes reference lines from the active\n"
"visualization window. Reference lines are the lines that are drawn on a\n"
"plot to show where you have performed lineouts.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/curv2d.silo\")\n"
"AddPlot(\"Pseudocolor\", \"d\")\n"
"Lineout((-3.0, 2.0), (2.0, 4.0), (\"default\", \"u\", \"v\"))\n"
"ClearReferenceLines()\n"
;
const char *visit_ClearViewKeyframes_doc = 
"ClearViewKeyframes\n"
"-Clears any view keyframes that have been set.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"ClearViewKeyframes() -> integer\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The ClearViewKeyframes function returns 1 on success and 0 on failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The ClearViewKeyframes function clears any view keyframes that may have\n"
"been set. View keyframes are used to create complex view behavior such as\n"
"fly-throughs when VisIt is in keyframing mode.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/globe.silo\")\n"
"AddPlot(\"Pseudocolor\", \"u\")\n"
"k = KeyframeAttributes()\n"
"k.enabled, k.nFrames, k.nFramesWasUserSet = 1,10,1\n"
"SetKeyframeAttributes(k)\n"
"DrawPlots()\n"
"\n"
"SetViewKeyframe()\n"
"v1 = GetView3D()\n"
"v1.viewNormal = (-0.66609, 0.337227, 0.665283)\n"
"v1.viewUp = (0.157431, 0.935425, -0.316537)\n"
"SetView3D(v1)\n"
"SetTimeSliderState(9)\n"
"SetViewKeyframe()\n"
"ToggleCameraViewMode()\n"
"\n"
"for i in range(10):\n"
"SetTimeSliderState(i)\n"
"ClearViewKeyframes()\n"
;
const char *visit_CloneWindow_doc = 
"CloneWindow\n"
"-Creates a new window that has the same plots, annotations, lights, and\n"
"view as the active window.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"CloneWindow() -> integer\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The CloneWindow function returns an integer value of 1 for success and 0\n"
"for failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The CloneWindow function tells the viewer to create a new window, based on\n"
"the active window, that contains the same plots, annotations, lights, and\n"
"view as the active window. This function is useful for when you have a\n"
"window set up like you want and then want to do the same thing in another\n"
"window using a different database. You can first clone the window and then\n"
"replace the database.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/globe.silo\")\n"
"AddPlot(\"Pseudocolor\", \"u\")\n"
"DrawPlots()\n"
"\n"
"v = ViewAttributes()\n"
"v.camera = (-0.505893, 0.32034, 0.800909)\n"
"v.viewUp = (0.1314, 0.946269, -0.295482)\n"
"v.parallelScale = 14.5472\n"
"v.nearPlane = -34.641\n"
"v.farPlane = 34.641\n"
"v.perspective = 1\n"
"SetView3D() # Set the view\n"
"\n"
"a = AnnotationAttributes()\n"
"a.backgroundColor = (0, 0, 255, 255)\n"
"SetAnnotationAttributes(a) # Set the annotation properties\n"
"CloneWindow() # Create a clone of the active window\n"
"DrawPlots() # Make the new window draw its plots\n"
;
const char *visit_CloseComputeEngine_doc = 
"CloseComputeEngine\n"
"-Closes the compute engine running on a specified host.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"CloseComputeEngine() -> integer\n"
"CloseComputeEngine(hostName) -> integer\n"
"CloseComputeEngine(hostName, simulation) -> integer\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"hostName\n"
"Optional name of the computer on which the compute engine is running.\n"
"simulation\n"
"Optional name of a simulation.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The CloseComputeEngine function returns an integer value of 1 for success\n"
"and 0 for failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The CloseComputeEngine function tells the viewer to close the compute\n"
"engine running a specified host. The hostName argument is a string that\n"
"contains the name of the computer where the compute engine is running. The\n"
"hostName argument can also be the name \"localhost\" if you want to close\n"
"the compute engine on the local machine without having to specify its name.\n"
"It is not necessary to provide the hostName argument. If the argument is\n"
"omitted, the first compute engine in the engine list will be closed. The\n"
"simulation argument can be provided if you want to close a connection to a\n"
"simulation that is acting as a VisIt compute engine. A compute engine can\n"
"be launched again by creating a plot or by calling the OpenComputeEngine\n"
"function.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/globe.silo\") # Launches an engine\n"
"AddPlot(\"Pseudocolor\", \"u\")\n"
"DrawPlots()\n"
"CloseComputeEngine() # Close the compute engine\n"
;
const char *visit_CloseDatabase_doc = 
"CloseDatabase\n"
"-Closes the specified database and frees up resources associated with it.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"CloseDatabase(name) -> integer\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"name\n"
"A string object containing the name of the database to close.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The CloseDatabase function returns 1 on success and 0 on failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The CloseDatabase function is used to close a specified database and free\n"
"all resources that were devoted to keeping the database open. This function\n"
whitlocb's avatar
whitlocb committed
1023
"has an effect similar to ClearCache but it does more in that\n"
hrchilds's avatar
hrchilds committed
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
"in addition to clearing the compute engine's cache, which it only does for\n"
"the specified database, it also removes all references to the specified\n"
"database from tables of cached metadata, etc. Note that the CloseDatabase\n"
"function will fail and the database will not be closed if any plots\n"
"reference the specified database.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"db = \"/usr/gapps/visit/data/globe.silo\"\n"
"OpenDatabase(db)\n"
"AddPlot(\"Pseudocolor\", \"u\")\n"
"DrawPlots()\n"
"\n"
"print \"This won't work: retval = %d\" % CloseDatabase(db)\n"
"DeleteAllPlots()\n"
"print \"Now it works: retval = %d\" % CloseDatabase(db)\n"
;
const char *visit_ColorTableNames_doc = 
"ColorTableNames\n"
"-Returns a tuple of color table names.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"ColorTableNames() -> tuple\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The ColorTableNames function returns a tuple of strings containing the\n"
"names of the color tables that have been defined.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The ColorTableNames function returns a tuple of strings containing the\n"
"names of the color tables that have been defined. This method can be used\n"
"in case you want to iterate over several color tables.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli \n"
"OpenDatabase(\"/usr/gapps/visit/data/curv2d.silo\")\n"
"AddPlot(\"Pseudocolor\", \"u\")\n"
"DrawPlots()\n"
"for ct in ColorTableNames():\n"
"p = PseudocolorAttributes()\n"
"p.colorTableName = ct\n"
"SetPlotOptions(p)\n"
;
1077 1078 1079
const char *visit_ConstructDataBinning_doc =
"ConstructDataBinning\n"
"-Constructs a data binning\n"
hrchilds's avatar
hrchilds committed
1080 1081 1082 1083
"\n"
"\n"
"Synopsis:\n"
"\n"
1084
"ConstructDataBinning(i) -> integer\n"
hrchilds's avatar
hrchilds committed
1085 1086 1087 1088 1089
"\n"
"\n"
"Arguments:\n"
"\n"
"i\n"
1090 1091
"An object of type ConstructDataBinningAttributes.  This object specifies the options\n"
"for constructing a data binning.\n"
hrchilds's avatar
hrchilds committed
1092 1093 1094 1095 1096 1097 1098 1099 1100
"\n"
"\n"
"Returns:\n"
"\n"
"Returns 1 on success, 0 on failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
1101 1102 1103
"The ConstructDataBinning function creates a data binning function for the active \n"
"plot.  Data Binnings place data from a data set into bins and reduce that data.  \n"
"They are used to either be incorporated with expressions to make new derived quantities \n"
hrchilds's avatar
hrchilds committed
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
"or to be directly visualized.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/curv3d.silo\")\n"
"AddPlot(\"Pseudocolor\", \"d\")\n"
"DrawPlots()\n"
"\n"
1114 1115 1116
"# Set the construct data binning attributes.\n"
"i = ConstructDataBinningAttributes()\n"
"i.name = \"db1\"\n"
hrchilds's avatar
hrchilds committed
1117 1118
"i.binningScheme = i.Uniform\n"
"i.varnames = (\"u\", \"w\")\n"
1119
"i.binBoundaries = (-1, 1, -1, 1) # minu, maxu, minw, maxw\n"
hrchilds's avatar
hrchilds committed
1120
"i.numSamples = (25, 25)\n"
1121 1122 1123
"i.reductionOperator = i.Average\n"
"i.varForReductionOperator = \"v\"\n"
"ConstructDataBinning(i)\n"
1124 1125 1126 1127
"\n"
"# Example of binning using spatial coordinates\n"
"i.varnames = (\"X\", \"u\") # X is added as a placeholder to maintain indexing\n"
"i.binType = (1, 0) # 1 = X, 2 = Y, 3 = Z, 0 = variable\n"
hrchilds's avatar
hrchilds committed
1128
;
hrchilds's avatar
hrchilds committed
1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
const char *visit_Copy_doc = 
"Copy\n"
"-Copies attributes from one visualization window to another visualization\n"
"window.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"CopyAnnotationsToWindow(source, dest) -> integer\n"
"CopyLightingToWindow(source, dest) -> integer\n"
"CopyViewTowindow(source, dest) -> integer\n"
"CopyPlotsToWindow(source, dest) -> integer\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"source\n"
"The index (an integer from 1 to 16) of the source window.\n"
"dest\n"
"The index (an integer from 1 to 16) of the destination window.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The Copy functions return an integer value of 1 for success and 0 for\n"
"failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The Copy functions copy attributes from one visualization window to\n"
"another visualization window. The CopyAnnotationsToWindow function copies\n"
"the annotations from a source visualization window to a destination\n"
"visualization window while the CopyLightingAttributes function copies\n"
"lighting and the CopyViewToWindow function copies the view. The\n"
"CopyPlotsToWindow function copies the plots from one visualization window\n"
"to another visualization window but does not also force plots to generate\n"
"so after copying plots with the CopyPlotsToWindow function, you should also\n"
"call the DrawPlots function.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/globe.silo\")\n"
"AddPlot(\"Pseudocolor\", \"u\")\n"
"DrawPlots()\n"
"\n"
"AddWindow()\n"
"SetActiveWindow(2)\n"
"OpenDatabase(\"/usr/gapps/visit/data/globe.silo\")\n"
"AddPlot(\"Mesh\", \"mesh1\")\n"
"\n"
"# Copy window 1's Pseudocolor plot to window 2.\n"
"CopyPlotsToWindow(1, 2) \n"
"DrawPlots() # Window 2 will have 2 plots\n"
"\n"
"# Spin the plots around in window 2 using the mouse.\n"
"CopyViewToWindow(2, 1) # Copy window 2's view to window 1.\n"
;
const char *visit_CreateAnnotationObject_doc = 
"CreateAnnotationObject\n"
"-Creates an annotation object that can directly manipulate annotations in\n"
"the vis window.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"CreateAnnotationObject(annotType) -> annotation object\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"annotType\n"
"A string containing the name of the type of annotation object to create.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"CreateAnnotationObject is a factory function that creates annotation\n"
"objects of different types. The return value, if a valid annotation type is\n"
"provided, is an annotation object. If the function fails, VisItException is\n"
"raised.\n"
"\n"
"\n"
"Description:\n"
"\n"
"CreateAnnotationObject is a factory function that creates different kinds\n"
"of annotation objects. The annotType argument is a string containing the\n"
"name of the type of annotation object to create. Each type of annotation\n"
"object has different properties that can be set. Setting the different\n"
"properties of an Annotation objects directly modifes annotations in the vis\n"
1221
"window. Currently there are 5 types of annotation objects:\n"
hrchilds's avatar
hrchilds committed
1222 1223
"Annotation type\tString\n"
"2D text annotation\t\"Text2D\"\n"
1224
"3D text annotation\t\"Text3D\"\n"
hrchilds's avatar
hrchilds committed
1225
"Time slider annotation\t\"TimeSlider\"\n"
hrchilds's avatar
hrchilds committed
1226 1227
"Image annotation\t\"Image\"\n"
"Line/arrow annotation\t\"Line2D\"\n"
hrchilds's avatar
hrchilds committed
1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
"\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/wave.visit\", 17)\n"
"AddPlot(\"Pseudocolor\", \"pressure\")\n"
"DrawPlots()\n"
"\n"
"slider = CreateAnnotationObject(\"TimeSlider\")\n"
"print slider\n"
"slider.startColor = (255,0,0,255)\n"
"slider.endColor = (255,255,0,255)\n"
;
const char *visit_CreateDatabaseCorrelation_doc = 
"CreateDatabaseCorrelation\n"
"-Creates a database correlation.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"CreateDatabaseCorrelation(name, databases, method) -> integer\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"name\n"
"String object containing the name of the database correlation to be\n"
"created.\n"
"databases\n"
"Tuple or list of string objects containing the names of the databases to\n"
"involve in the database correlation.\n"
"method\n"
"An integer in the range [0,3] that determines the correlation method.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The CreateDatabaseCorrelation function returns 1 on success and 0 on\n"
"failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The CreateDatabaseCorrelation function creates a database correlation,\n"
"which is a VisIt construct that relates the time states for two or more\n"
"databases in some way. You would use the CreateDatabaseCorrelation function\n"
"if you wanted to put plots from more than one time-varying database in the\n"
"same vis window and then move them both through time in some synchronized\n"
"way. The name argument is a string that is the name of the database\n"
"correlation to be created. You will use the name of the database\n"
"correlation to set the active time slider later so that you can change time\n"
"states. The databases argument is a list or tuple of string objects\n"
"containing the fully-qualified (host:/path/filename) names of the databases\n"
"to be involved in the database query. The method argument allows you to\n"
"specify a database correlation method.\n"
"Correlation method\t\tValue\n"
"IndexForIndexCorrelation\t0\n"
"StretchedIndexCorrelation\t1\n"
"TimeCorrelation\t\t\t2\n"
"CycleCorrelation\t\t3\n"
"\n"
"Each database correlation has its own time slider that can be used to set\n"
"the time state of databases that are part of a database correlation.\n"
"Individual time-varying databases have their own trivial database\n"
"correlation, consisting of only 1 database. When you call the\n"
"CreateDatabaseCorrelation function, VisIt creates a new time slider with\n"
"the same name as the database correlation and makes it be the active time\n"
"slider.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"dbs = (\"/usr/gapps/visit/data/dbA00.pdb\",\n"
"\"/usr/gapps/visit/data/dbB00.pdb\")\n"
"OpenDatabase(dbs[0])\n"
"AddPlot(\"FilledBoundary\", \"material(mesh)\")\n"
"OpenDatabase(dbs[1])\n"
"AddPlot(\"FilledBoundary\", \"material(mesh)\")\n"
"DrawPlots()\n"
"\n"
"CreateDatabaseCorrelation(\"common\", dbs, 1)\n"
"\n"
"# Creating a new database correlation also creates a new time \n"
"# slider and makes it be active.\n"
"w = GetWindowInformation()\n"
"print \"Active time slider: %s\" % w.timeSliders[w.activeTimeSlider]\n"
"\n"
"# Animate through time using the \"common\" database correlation's \n"
"# time slider.\n"
"for i in range(TimeSliderGetNStates()):\n"
"SetTimeSliderState(i)\n"
;
1323 1324
const char *visit_CreateNamedSelection_doc = 
"CreateNamedSelection \n"
1325
"-Creates a named selection.\n"
1326 1327 1328 1329 1330
"\n"
"\n"
"Synopsis:\n"
"\n"
"CreateNamedSelection(name) -> integer\n"
1331
"CreateNamedSelection(name, properties) -> integer\n"
1332 1333 1334 1335 1336
"\n"
"\n"
"Arguments:\n"
"\n"
"name\n"
1337 1338 1339 1340 1341 1342 1343
"    The name of a named selection.\n"
"properties\n"
"    This optional argument lets you pass a SelectionProperties object containing\n"
"    the properties that will be used to create the named selection. When this\n"
"    argument is omitted, the named selection will always be associated with\n"
"    the active plot. You can use this argument to set up more complex named\n"
"    selections that may be associated with plots or databases.\n"
1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372
"\n"
"Returns:\n"
"\n"
"The CreateNamedSelection function returns 1 for success and 0 for failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"Named Selections allow you to select a group of elements (or particles).\n"
"One typically creates a named selection from a group of elements and then\n"
"later applies the named selection to another plot (thus reducing the\n"
"set of elements displayed to the ones from when the named selection was\n"
"created).\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"db = \"/usr/gapps/visit/data/wave*.silo database\"\n"
"OpenDatabase(db)\n"
"AddPlot(\"Pseudocolor\", \"pressure\")\n"
"AddOperator(\"Clip\")\n"
"c = ClipAttributes()\n"
"c.plane1Origin = (0,0.6,0)\n"
"c.plane1Normal = (0,-1,0)\n"
"SetOperatorOption(c)\n"
"DrawPlots()\n"
"\n"
"CreateNamedSelection(\"els_above_at_time_0\")\n"
whitlocb's avatar
whitlocb committed
1373
"SetTimeSliderState(40)\n"
1374 1375 1376
"RemoveLastOperator()\n"
"ApplyNamedSelection(\"els_above_at_time_0\")\n"
;
hrchilds's avatar
hrchilds committed
1377 1378 1379 1380 1381 1382 1383
const char *visit_DefineExpression_doc = 
"DefineExpression\n"
"-Creates a expression variable.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
1384 1385 1386 1387 1388 1389 1390 1391
"DefineMaterialExpression(variableName, expression) -> integer\n"
"DefineMeshExpression(variableName, expression) -> integer\n"
"DefineScalarExpression(variableName, expression) -> integer\n"
"DefineSpeciesExpression(variableName, expression) -> integer\n"
"DefineTensorExpression(variableName, expression) -> integer\n"
"DefineVectorExpression(variableName, expression) -> integer\n"
"DefineArrayExpression(variableName, expression) -> integer\n"
"DefineCurveExpression(variableName, expression) -> integer\n"
hrchilds's avatar
hrchilds committed
1392 1393 1394 1395 1396
"\n"
"\n"
"Arguments:\n"
"\n"
"variableName\n"
1397
"    The name of the variable to be created.\n"
hrchilds's avatar
hrchilds committed
1398
"expression\n"
1399
"    The expression definition.\n"
hrchilds's avatar
hrchilds committed
1400 1401 1402 1403
"\n"
"\n"
"Returns:\n"
"\n"
1404
"The DefineExpression functions return 1 on success and 0 on failure.\n"
hrchilds's avatar
hrchilds committed
1405 1406 1407 1408 1409 1410 1411 1412
"\n"
"\n"
"Description:\n"
"\n"
"The DefineScalarExpression function creates a new scalar variable based on\n"
"other variables from the open database. Likewise, the\n"
"DefineMaterialExpression function creates new material variables,\n"
"DefineMeshExpression creates new mesh variables, DefineSpeciesExpression\n"
hrchilds's avatar
hrchilds committed
1413
"creates new species variables, DefineVectorExpression creates new\n"
1414
"vector variables, DefineTensorExpression creates new tensor variables, and\n"
hrchilds's avatar
hrchilds committed
1415
"DefineArrayExpression creates new array variables.\n"
1416 1417 1418 1419 1420 1421 1422 1423 1424
"Expression variables can be plotted like any other variable.\n"
"\n"
"The variableName argument is a string that contains the name of the new\n"
"variable. You can pass the name of an existing expression if you want\n"
"to provide a new expression definition.\n"
"\n"
"The expression argument is a string that contains the definition of the\n"
"new variable in terms of math operators and pre-existing variable names\n"
"Reference the VisIt User's Manual if you want more information on \n"
hrchilds's avatar
hrchilds committed
1425 1426
"creating expressions, such as expression syntax, or a list of built-in\n"
"expression functions.\n"
hrchilds's avatar
hrchilds committed
1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/globe.silo\")\n"
"DefineScalarExpression(\"myvar\", \"sin(u) + cos(w)\")\n"
"\n"
"# Plot the scalar expression variable.\n"
"AddPlot(\"Pseudocolor\", \"myvar\")\n"
"DrawPlots()\n"
"\n"
"# Plot a vector expression variable.\n"
"DefineVectorExpression(\"myvec\", \"{u,v,w}\")\n"
"AddPlot(\"Vector\", \"myvec\")\n"
"DrawPlots()\n"
;
const char *visit_DeIconifyAllWindows_doc = 
"DeIconifyAllWindows\n"
"-Unhides all of the hidden visualization windows.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"DeIconifyAllWindows()\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The DeIconifyAllWindows function does not return a value.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The DeIconifyAllWindows function unhides all of the hidden visualization\n"
"windows. This function is usually called after IconifyAllWindows as a way\n"
"of making all of the hidden visualization windows visible.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"SetWindowLayout(4) # Have 4 windows\n"
"IconifyAllWindows()\n"
"DeIconifyAllWindows()\n"
;
const char *visit_DeletePlots_doc = 
"DeletePlots\n"
"-Deletes plots from the active window's plot list.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"DeleteActivePlots() -> integer\n"
"DeleteAllPlots() -> integer\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The Delete functions return an integer value of 1 for success and 0 for\n"
"failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The Delete functions delete plots from the active window's plot list. The\n"
"DeleteActivePlots function deletes all of the active plots from the plot\n"
"list. There is no way to retrieve a plot once it has been deleted from the\n"
"plot list. The active plots are set using the SetActivePlots function. The\n"
"DeleteAllPlots function deletes all plots from the active window's plot\n"
"list regardless of whether or not they are active.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/curv2d.silo\")\n"
"AddPlot(\"Pseudocolor\", \"d\")\n"
"AddPlot(\"Contour\", \"u\")\n"
"AddPlot(\"Mesh\", \"curvmesh2d\")\n"
"DrawPlots()\n"
"DeleteActivePlots() # Delete the mesh plot\n"
"DeleteAllPlots() # Delete the pseudocolor and contour plots.\n"
;
const char *visit_DeleteDatabaseCorrelation_doc = 
"DeleteDatabaseCorrelation\n"
"-Deletes a database correlation.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"DeleteDatabaseCorrelation(name) -> integer\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"name\n"
"A string object containing the name of the database correlation to delete.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The DeleteDatabaseCorrelation function returns 1 on success and 0 on\n"
"failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The DeleteDatabaseCorrelation function deletes a specific database\n"
"correlation and its associated time slider. If you delete a database\n"
"correlation whose time slider is being used for the current time slider,\n"
"the time slider will be reset to the time slider of the next best suited\n"
"database correlation. You can use the DeleteDatabaseCorrelation function to\n"
"remove database correlations that you no longer need such as when you\n"
"choose to examine databases that have nothing to do with your current\n"
"databases.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"dbs = (\"dbA00.pdb\", \"dbB00.pdb\")\n"
"OpenDatabase(dbs[0])\n"
"AddPlot(\"FilledBoundary\", \"material(mesh)\")\n"
"OpenDatabase(dbs[1])\n"
"AddPlot(\"FilledBoundary\", \"material(mesh)\")\n"
"DrawPlots()\n"
"\n"
"CreateDatabaseCorrelation(\"common\", dbs, 1)\n"
"SetTimeSliderState(10)\n"
"DeleteAllPlots()\n"
"\n"
"DeleteDatabaseCorrelation(\"common\")\n"
"CloseDatabase(dbs[0])\n"
"CloseDatabase(dbs[1])\n"
;
const char *visit_DeleteExpression_doc = 
"DeleteExpression\n"
"-Deletes an expression variable from the expression list.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
1570
"DeleteExpression(variableName) -> integer\n"
hrchilds's avatar
hrchilds committed
1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601
"\n"
"\n"
"Arguments:\n"
"\n"
"variableName\n"
"The name of the expression variable to be deleted.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The DeleteExpression function returns 1 on success and 0 on failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The DeleteExpression function deletes the definition of an expression. The\n"
"variableName argument is a string containing the name of the variable\n"
"expression to be deleted. Any plot that uses an expression that has been\n"
"deleted will fail to regenerate if its attributes are changed.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/globe.silo\")\n"
"DefineScalarExpression(\"myvar\", \"sin(u) + cos(w)\")\n"
"AddPlot(\"Pseudocolor\", \"myvar\") # Plot the expression variable.\n"
"DrawPlots()\n"
"\n"
"DeleteExpression(\"myvar\") # Delete the expression variable myvar.\n"
;
1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646
const char *visit_DeleteNamedSelection_doc = 
"DeleteNamedSelection \n"
"-Deletes knowledge of a named selection.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"DeleteNamedSelection(name) -> integer\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"name\n"
"The name of a named selection.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The DeleteNamedSelection function returns 1 for success and 0 for failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"Named Selections allow you to select a group of elements (or particles).\n"
"One typically creates a named selection from a group of elements and then\n"
"later applies the named selection to another plot (thus reducing the\n"
"set of elements displayed to the ones from when the named selection was\n"
"created).  If you have created a named selection that you are no longer\n"
"interested in, you can delete it with the DeleteNamedSelection function.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"db = \"/usr/gapps/visit/data/wave*.silo database\"\n"
"OpenDatabase(db)\n"
"AddPlot(\"Pseudocolor\", \"pressure\")\n"
"AddOperator(\"Clip\")\n"
"c = ClipAttributes()\n"
"c.plane1Origin = (0,0.6,0)\n"
"c.plane1Normal = (0,-1,0)\n"
"SetOperatorOption(c)\n"
"DrawPlots()\n"
"\n"
"CreateNamedSelection(\"els_above_y\")\n"
whitlocb's avatar
whitlocb committed
1647
"SetTimeSliderState(40)\n"
1648 1649 1650
"DeleteNamedSelection(\"els_above_y\")\n"
"CreateNamedSelection(\"els_above_y\")\n"
;
hrchilds's avatar
hrchilds committed
1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900
const char *visit_DeletePlotDatabaseKeyframe_doc = 
"DeletePlotDatabaseKeyframe\n"
"-Deletes a database keyframe for a plot.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"DeletePlotDatabaseKeyframe(plotIndex, frame)\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"plotIndex\n"
"A zero-based integer value corresponding to a plot's index in the plot\n"
"list.\n"
"frame\n"
"A zero-based integer value corresponding to a database keyframe at a\n"
"particular animation frame.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"DeletePlotDatabaseKeyframe does not return a value.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The DeletePlotDatabaseKeyframe function removes a database keyframe from a\n"
"specific plot. A database keyframe represents the database time state that\n"
"will be used at a given animation frame when VisIt's keyframing mode is\n"
"enabled. The plotIndex argument is a zero-based integer that is used to\n"
"identify a plot in the plot list. The frame argument is a zero-based\n"
"integer that is used to identify the frame at which a database keyframe is\n"
"to be removed for the specified plot.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/wave.visit\")\n"
"k = GetKeyframeAttributes()\n"
"k.enabled,k.nFrames,k.nFramesWasUserSet = 1,20,1\n"
"SetKeyframeAttributes(k)\n"
"AddPlot(\"Pseudocolor\", \"pressure\")\n"
"SetPlotDatabaseState(0, 0, 60)\n"
"# Repeat time state 60 for the first few animation frames by adding a\n"
"keyframe at frame 3.\n"
"SetPlotDatabaseState(0, 3, 60)\n"
"SetPlotDatabaseState(0, 19, 0)\n"
"DrawPlots()\n"
"\n"
"ListPlots()\n"
"\n"
"# Delete the database keyframe at frame 3.\n"
"DeletePlotDatabaseKeyframe(0, 3)\n"
"ListPlots()\n"
;
const char *visit_DeletePlotKeyframe_doc = 
"DeletePlotKeyframe\n"
"-Deletes a plot keyframe at a specified frame.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"DeletePlotKeyframe(plotIndex, frame)\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"plotIndex\n"
"A zero-based integer value corresponding to a plot's index in the plot\n"
"list.\n"
"frame\n"
"A zero-based integer value corresponding to a plot keyframe at a\n"
"particular animation frame.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"DeletePlotKeyframe does not return a value.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The DeletePlotKeyframe function removes a plot keyframe from a specific\n"
"plot. A plot keyframe is the set of plot attributes at a specified frame.\n"
"Plot keyframes are used to determine what plot attributes will be used at a\n"
"given animation frame when VisIt's keyframing mode is enabled. The\n"
"plotIndex argument is a zero-based integer that is used to identify a plot\n"
"in the plot list. The frame argument is a zero-based integer that is used\n"
"to identify the frame at which a keyframe is to be removed.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/wave.visit\")\n"
"k = GetKeyframeAttributes()\n"
"k.enabled,k.nFrames,k.nFramesWasUserSet = 1,20,1\n"
"SetKeyframeAttributes(k)\n"
"AddPlot(\"Pseudocolor\", \"pressure\")\n"
"# Set up plot keyframes so the Pseudocolor plot's min will change\n"
"# over time.\n"
"p0 = PseudocolorAttributes()\n"
"p0.minFlag,p0.min = 1,0.0\n"
"p1 = PseudocolorAttributes()\n"
"p1.minFlag,p1.min = 1, 0.5\n"
"SetPlotOptions(p0)\n"
"SetTimeSliderState(19)\n"
"SetPlotOptions(p1)\n"
"SetTimeSliderState(0)\n"
"DrawPlots()\n"
"\n"
"ListPlots()\n"
"\n"
"# Iterate over all animation frames and wrap around to the first one.\n"
"for i in list(range(TimeSliderGetNStates())) + [0]:\n"
"SetTimeSliderState(i)\n"
"\n"
"# Delete the plot keyframe at frame 19 so the min won't \n"
"# change anymore.\n"
"DeletePlotKeyframe(19)\n"
"ListPlots()\n"
"SetTimeSliderState(10)\n"
;
const char *visit_DeleteViewKeyframe_doc = 
"DeleteViewKeyframe\n"
"-Deletes a view keyframe at a specified frame.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"DeleteViewKeyframe(frame)\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"frame\n"
"A zero-based integer value corresponding to a view keyframe at a\n"
"particular animation frame.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"DeleteViewKeyframe returns 1 on success and 0 on failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The DeleteViewKeyframe function removes a view keyframe at a specified\n"
"frame. View keyframes are used to determine what view will be used at a\n"
"given animation frame when VisIt's keyframing mode is enabled. The frame\n"
"argument is a zero-based integer that is used to identify the frame at\n"
"which a keyframe is to be removed.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/globe.silo\")\n"
"k = KeyframeAttributes()\n"
"k.enabled, k.nFrames, k.nFramesWasUserSet = 1,10,1\n"
"SetKeyframeAttributes(k)\n"
"AddPlot(\"Pseudocolor\", \"u\")\n"
"DrawPlots()\n"
"\n"
"# Set some view keyframes\n"
"SetViewKeyframe()\n"
"v1 = GetView3D()\n"
"v1.viewNormal = (-0.66609, 0.337227, 0.665283)\n"
"v1.viewUp = (0.157431, 0.935425, -0.316537)\n"
"SetView3D(v1)\n"
"SetTimeSliderState(9)\n"
"SetViewKeyframe()\n"
"ToggleCameraViewMode()\n"
"\n"
"# Iterate over the animation frames to watch the view change.\n"
"for i in list(range(10)) + [0]:\n"
"SetTimeSliderState(i)\n"
"# Delete the last view keyframe, which is on frame 9.\n"
"DeleteViewKeyframe(9)\n"
"# Iterate over the animation frames again. The view should stay \n"
"# the same.\n"
"for i in range(10):\n"
"SetTimeSliderState(i)\n"
;
const char *visit_DeleteWindow_doc = 
"DeleteWindow\n"
"-Deletes the active visualization window.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"DeleteWindow() -> integer\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The DeleteWindow function returns an integer value of 1 for success and 0\n"
"for failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The DeleteWindow function deletes the active visualization window and\n"
"makes the visualization window with the smallest window index the new\n"
"active window. This function has no effect when there is only one remaining\n"
"visualization window.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"DeleteWindow() # Does nothing since there is only one window\n"
"AddWindow()\n"
"DeleteWindow() # Deletes the new window.\n"
;
const char *visit_DemoteOperator_doc = 
"DemoteOperator\n"
"-Moves an operator closer to the database in the visualization pipeline.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"DemoteOperator(opIndex) -> integer\n"
"DemoteOperator(opIndex, applyToAllPlots) -> integer\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"opIndex\n"
"A zero-based integer corresponding to the operator that should be demoted.\n"
"applyAll\n"
"An integer flag that causes all plots in the plot list to be affected when\n"
"it is non-zero.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"DemoteOperator returns 1 on success and 0 on failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The DemoteOperator function moves an operator closer to the database in\n"
"the visualization pipeline. This allows you to change the order of\n"
"operators that have been applied to a plot without having to remove them\n"
"from the plot. For example, consider moving a Slice to before a Reflect\n"
"operator when it had been the other way around. Changing the order of\n"
"operators can result in vastly different results for a plot. The opposite\n"
whitlocb's avatar
whitlocb committed
1901
"function is PromoteOperator.\n"
hrchilds's avatar
hrchilds committed
1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/noise.silo\")\n"
"AddPlot(\"Pseudocolor\", \"hardyglobal\")\n"
"AddOperator(\"Slice\")\n"
"s = SliceAttributes()\n"
"s.project2d = 0\n"
"s.originPoint = (0,5,0)\n"
"s.originType=s.Point\n"
"s.normal = (0,1,0)\n"
"s.upAxis = (-1,0,0)\n"
"SetOperatorOptions(s)\n"
"AddOperator(\"Reflect\")\n"
"DrawPlots()\n"
"\n"
"# Now reflect before slicing. We'll only get 1 slice plane\n"
"# instead of 2.\n"
"DemoteOperator(1)\n"
"DrawPlots()\n"
;
const char *visit_DisableRedraw_doc = 
"DisableRedraw\n"
"-Prevents the active visualization window from redrawing itself.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"DisableRedraw()\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The DisableRedraw function does not return a value.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The DisableRedraw function prevents the active visualization window from\n"
"ever redrawing itself. This is a useful function to call when performing\n"
"many operations that would cause unnecessary redraws in the visualization\n"
"window. The effects of this function are undone by calling the RedrawWindow\n"
"function.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/globe.silo\")\n"
"AddPlot(\"Contour\", \"u\")\n"
"AddPlot(\"Pseudocolor\", \"w\")\n"
"DrawPlots()\n"
"\n"
"DisableRedraw()\n"
"AddOperator(\"Slice\")\n"
"\n"
"# Set the slice operator attributes\n"
"\n"
"# Redraw now that th operator attributes are set. This will \n"
"# prevent 1 redraw.\n"
"RedrawWindow()\n"
;
const char *visit_DrawPlots_doc = 
"DrawPlots\n"
"-Draws any new plots\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"DrawPlots() -> integer\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The DrawPlots function returns an integer value of 1 for success and 0 for\n"
"failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The DrawPlots function forces all new plots in the plot list to be drawn.\n"
"Plots are added and then their attributes are modified. Finally, the\n"
"DrawPlots function is called to make sure all of the new plots draw\n"
"themselves in the visualization window. This function has no effect if all\n"
"of the plots in the plot list are already drawn.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/globe.silo\")\n"
"AddPlot(\"Pseudocolor\", \"u\")\n"
"DrawPlots() # Draw the new pseudocolor plot.\n"
;
const char *visit_EnableTool_doc = 
"EnableTool\n"
"-Sets the enabled state of an interactive tool in the active visualization\n"
"window.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"EnabledTool(toolIndex, activeFlag)\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"toolIndex\n"
2012 2013 2014
"    This is an integer that corresponds to an interactive tool. \n"
"    (Plane tool = 0, Line tool = 1, Plane tool = 2, Box tool = 3, \n"
"     Sphere tool = 4, Axis Restriction tool = 5)\n"
hrchilds's avatar
hrchilds committed
2015
"activeFlag\n"
2016
"    A value of 1 enables the tool while a value of 0 disables the tool.\n"
hrchilds's avatar
hrchilds committed
2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139
"\n"
"\n"
"Returns:\n"
"\n"
"The EnableTool function returns 1 on success and 0 on failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The EnableTool function is used to set the enabled state of an interactive\n"
"tool in the active visualization window. The toolIndex argument is an\n"
"integer index that corresponds to a certain tool. The activeFlag argument\n"
"is an integer value (0 or 1) that indicates whether to turn the tool on or\n"
"off.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/globe.silo\")\n"
"AddPlot(\"Pseudocolor\", \"u\")\n"
"DrawPlots()\n"
"\n"
"EnableTool(0, 1) # Turn on the line tool.\n"
"EnableTool(1,1) # Turn on the plane tool.\n"
"EnableTool(2,1) # Turn on the sphere tool.\n"
"EnableTool(2,0) # Turn off the sphere tool.\n"
;
const char *visit_EvalCubic_doc = 
"EvalCubic\n"
"-Interpolates between four values using a cubic polynomial.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"EvalCubic(t, c0, c1, c2, c3) -> f(t)\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"t\n"
"A floating point number in the range [0., 1.] that represents the distance\n"
"from c0 to c3.\n"
"c0\n"
"The first control point. f(0) = c0. Any object that can be used in an\n"
"arithmetic expression can be passed for c0.\n"
"c1\n"
"The second control point. Any object that can be used in an arithmetic\n"
"expression can be passed for c1.\n"
"c2\n"
"The third control point. Any object that can be used in an arithmetic\n"
"expression can be passed for c2.\n"
"c3\n"
"The last control point. f(1) = c3. Any object that can be used in an\n"
"arithmetic expression can be passed for c3.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The EvalCubic function returns the interpolated value for t taking into\n"
"account the control points that were passed in.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The EvalCubic function takes in four objects and blends them using a cubic\n"
"polynomial and returns the blended value.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/globe.silo\")\n"
"AddPlot(\"Pseudocolor\", \"u\")\n"
"DrawPlots()\n"
"\n"
"v0 = GetView3D()\n"
"# rotate the plots \n"
"v1 = GetView3D()\n"
"# rotate the plots again.\n"
"v2 = GetView3D()\n"
"# rotate the plots one last time.\n"
"v3 = GetView3D()\n"
"# Fly around the plots using the views that have been specified.\n"
"nSteps = 100\n"
"\n"
"for i in range(nSteps):\n"
"t = float(i) / float(nSteps - 1)\n"
"newView = EvalCubic(t, v0, v1, v2, v3)\n"
"SetView3D(newView)\n"
;
const char *visit_EvalCubicSpline_doc = 
"EvalCubicSpline\n"
"-Interpolates between N values using piece-wise cubic splines.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"EvalCubicSpline(t, weights, values) -> f(t)\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"t\n"
"A floating point value in the range [0., 1.] that represents the distance\n"
"from the first control point to the last control point.\n"
"weights\n"
"A tuple of N floating point values in the range [0., 1.] that represent\n"
"how far along in parameterized space, the values will be located.\n"
"values\n"
"A tuple of N objects to be blended. Any objects that can be used in\n"
"arithmetic expressions can be passed.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The EvalCubicSpline function returns the interpolated value for t\n"
"considering the objects that were passed in.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The EvalCubicSpline function takes in N objects to be blended and blends\n"
whitlocb's avatar
whitlocb committed
2140
"them using piece-wise cubic polynomials and returns the blended value.\n"
hrchilds's avatar
hrchilds committed
2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250
;
const char *visit_EvalLinear_doc = 
"EvalLinear\n"
"-Interpolates linearly between two values.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"EvalLinear(t, value1, value2) -> f(t)\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"t\n"
"A floating point value in the range [0., 1.] that represents the distance\n"
"between the first and last control point in parameterized space.\n"
"value1\n"
"Any object that can be used in an arithmetic expression. f(0) = value1.\n"
"value2\n"
"Any object that can be used in an arithmetic expression. f(1) = value2.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The EvalLinear function returns an interpolated value for t based on the\n"
"objects that were passed in.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The EvalLinear function linearly interpolates between two values and\n"
"returns the result.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/globe.silo\")\n"
"AddPlot(\"Pseudocolor\", \"u\")\n"
"DrawPlots()\n"
"\n"
"c0 = GetView3D()\n"
"c1 = GetView3D()\n"
"c1.viewNormal = (-0.499159, 0.475135, 0.724629)\n"
"c1.viewUp = (0.196284, 0.876524, -0.439521)\n"
"\n"
"nSteps = 100\n"
"for i in range(nSteps):\n"
"t = float(i) / float(nSteps - 1)\n"
"v = EvalLinear(t, c0, c1)\n"
"SetView3D(v)\n"
;
const char *visit_EvalQuadratic_doc = 
"EvalQuadratic\n"
"-Interpolates between three values using a quadratic polynomial.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"EvalQuadratic(t, c0, c1, c2,) -> f(t)\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"t\n"
"A floating point number in the range [0., 1.] that represents the distance\n"
"from c0 to c3.\n"
"c0\n"
"The first control point. f(0) = c0. Any object that can be used in an\n"
"arithmetic expression can be passed for c0.\n"
"c1\n"
"The second control point. Any object that can be used in an arithmetic\n"
"expression can be passed for c1.\n"
"c2\n"
"The last control point. f(1) = c2. Any object that can be used in an\n"
"arithmetic expression can be passed for c2.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The EvalQuadratic function returns the interpolated value for t taking\n"
"into account the control points that were passed in.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The EvalQuadratic function takes in four objects and blends them using a\n"
"cubic polynomial and returns the blended value.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/globe.silo\")\n"
"AddPlot(\"Pseudocolor\", \"u\")\n"
"DrawPlots()\n"
"\n"
"v0 = GetView3D()\n"
"# rotate the plots \n"
"v1 = GetView3D()\n"
"# rotate the plots one last time.\n"
"v2 = GetView3D()\n"
"\n"
"# Fly around the plots using the views that have been specified.\n"
"nSteps = 100\n"
"for i in range(nSteps):\n"
"t = float(i) / float(nSteps - 1)\n"
"newView = EvalQuadratic(t, v0, v1, v2)\n"
"SetView3D(newView)\n"
;
hrchilds's avatar
hrchilds committed
2251 2252 2253 2254 2255 2256 2257
const char *visit_ExportDatabase_doc = 
"ExportDatabase\n"
"-Export a database\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
2258 2259
"ExportDatabase(e) -> integer\n"
"ExportDatabase(e, o) -> integer\n"
hrchilds's avatar
hrchilds committed
2260 2261 2262 2263 2264 2265 2266
"\n"
"\n"
"Arguments:\n"
"\n"
"e\n"
"An object of type ExportDBAttributes.  This object specifies the options\n"
"for exporting the database.\n"
2267 2268 2269 2270
"o (optional)\n"
"A dictionary containing a key/value mapping to set options needed by the\n"
"database exporter.  The default values can be obtained in the appropriate\n"
"format using GetExportOptions('plugin').\n"
hrchilds's avatar
hrchilds committed
2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303
"\n"
"\n"
"Returns:\n"
"\n"
"Returns 1 on success, 0 on failure.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The ExportDatabase function exports the active plot for the current window\n"
"to a file.  The format of the file, name, and variables to be saved are\n"
"specified using the ExportDBAttributes argument.\n"
"\n"
"Note that this functionality is distinct from the geometric formats of\n"
"SaveWindow, such as STL.  SaveWindow can only save surfaces (triangle\n"
"meshes), while ExportDatabase can export an entire three dimensional data\n"
"set.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/curv3d.silo\")\n"
"AddPlot(\"Pseudocolor\", \"d\")\n"
"DrawPlots()\n"
"\n"
"# Set the export database attributes.\n"
"e = ExportDBAttributes()\n"
"e.db_type = \"Silo\"\n"
"e.variables = (\"u\", \"v\")\n"
"e.filename = \"test_ex_db\"\n"
"ExportDatabase(e)\n"
;
hrchilds's avatar
hrchilds committed
2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492
const char *visit_Expressions_doc = 
"Expressions\n"
"-Returns a tuple of expression names and definitions.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"Expressions() -> tuple of expression tuples\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The Expressions function returns a tuple of tuples that contain two\n"
"strings that give the expression name and definition. \n"
"\n"
"\n"
"Description:\n"
"\n"
"The Expressions function returns a tuple of tuples that contain two\n"
"strings that give the expression name and definition. This function is\n"
"useful for listing the available expressions or for iterating through a\n"
"list of expressions in order to create plots.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"SetWindowLayout(4)\n"
"DefineScalarExpression(\"sin_u\", \"sin(u)\")\n"
"DefineScalarExpression(\"cos_u\", \"cos(u)\")\n"
"DefineScalarExpression(\"neg_u\", \"-u\")\n"
"DefineScalarExpression(\"bob\", \"sin_u + cos_u\")\n"
"for i in range(1,5):\n"
"SetActiveWindow(i)\n"
"OpenDatabase(\"/usr/gapps/visit/data/globe.silo\")\n"
"exprName = Expressions()[i-1][0]\n"
"AddPlot(\"Pseudocolor\", exprName)\n"
"DrawPlots()\n"
;
const char *visit_GetActiveColorTable_doc = 
"GetActiveColorTable\n"
"-Returns the name of the active color table.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"GetActiveContinuousColorTable() -> string\n"
"GetActiveDiscreteColorTable() -> string\n"
"\n"
"\n"
"Returns:\n"
"\n"
"Both functions return a string object containing the name of a color table.\n"
"\n"
"\n"
"Description:\n"
"\n"
"A color table is a set of color values that are used as the colors for\n"
"plots. VisIt supports two flavors of color table: continuous and discrete.\n"
"A continuous color table is defined by a small set of color control points\n"
"and the colors specified by the color control points are interpolated\n"
"smoothly to fill in any gaps. Continuous color tables are used for plots\n"
"that need to be colored smoothly by a variable (e.g. Pseudocolor plot). A\n"
"discrete color table is a set of color control points that are used to\n"
"color distinct regions of a plot (e.g. Subset plot). VisIt supports the\n"
"notion of default continuous and default discrete color tables so plots can\n"
"just use the \"default\" color table. This lets you change the color table\n"
"used by many plots by just changing the \"default\" color table. The\n"
"GetActiveContinuousColorTable function returns the name of the default\n"
"continuous color table. The GetActiveDiscreteColorTable function returns\n"
"the name of the default discrete color table.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"print \"Default continuous color table: %s\" % \\\n"
"GetActiveContinuousColorTable()\n"
"\n"
"print \"Default discrete color table: %s\" % \\\n"
"GetActiveDiscreteColorTable()\n"
;
const char *visit_GetActiveTimeSlider_doc = 
"GetActiveTimeSlider\n"
"-Returns the name of the active time slider.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"GetActiveTimeSlider() -> string\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The GetActiveTimeSlider function returns a string containing the name of\n"
"the active time slider.\n"
"\n"
"\n"
"Description:\n"
"\n"
"VisIt can support having multiple time sliders when you have opened more\n"
"than one time-varying database. You can then use each time slider to\n"
"independently change time states for each database or you can use a\n"
"database correlation to change time states for all databases\n"
"simultaneously. Every time-varying database has a database correlation and\n"
"every database correlation has its own time slider. If you want to query to\n"
"determine which time slider is currently the active time slider, you can\n"
"use the GetActiveTimeSlider function.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"dbA00.pdb\")\n"
"AddPlot(\"FilledBoundary\", \"material(mesh)\")\n"
"OpenDatabase(\"dbB00.pdb\")\n"
"AddPlot(\"FilledBoundary\", \"materials(mesh)\")\n"
"print \"Active time slider: %s\" % GetActiveTimeSlider()\n"
"CreateDatabaseCorrelation(\"common\", (\"dbA00.pdb\", \"dbB00.pdb\"), 2)\n"
"print \"Active time slider: %s\" % GetActiveTimeSlider()\n"
;
const char *visit_GetAnimationTimeout_doc = 
"GetAnimationTimeout\n"
"-Returns the animation timeout in milliseconds.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"GetAnimationTimeout() -> integer\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The GetAnimationTimeout function returns an integer that contains the time\n"
"interval, measured in milliseconds, between the rendering of animation\n"
"frames.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The GetAnimationTimeout returns an integer that contains the time\n"
"interval, measured in milliseconds, between the rendering of animation\n"
"frames.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"print \"Animation timeout = %d\" % GetAnimationTimeout()\n"
;
const char *visit_GetAnnotationAttributes_doc = 
"GetAnnotationAttributes\n"
"-Returns an object containing the active visualization window's annotation\n"
"attributes.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"GetAnnotationAttributes() -> AnnotationAttributes object\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The GetAnnotationAttributes function returns an AnnotationAttributes\n"
"object that contains the annotation settings for the active visualization\n"
"window.\n"
"\n"
"\n"
"Description:\n"
"\n"
"The GetAnnotationAttributes function returns an AnnotationAttributes\n"
"object that contains the annotation settings for the active visualization\n"
"window. It is often useful to retrieve the annotation settings and modify\n"
"them to suit the visualization.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/globe.silo\")\n"
"AddPlot(\"Pseudocolor\", \"u\")\n"
"DrawPlots()\n"
"\n"
"a = GetAnnotationAttributes()\n"
"print a\n"
"a.backgroundMode = a.BACKGROUNDMODE_GRADIENT\n"
"a.gradientColor1 = (0, 0, 255)\n"
"SetAnnotationAttributes(a)\n"
;
2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514
const char *visit_GetAnnotationObjectNames_doc =
"GetAnnotationObjectNames\n"
"-Returns a tuple of names of all currently defined annotation objects\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"GetAnnotationObjectNames() -> tuple of strings\n"
"\n"
"\n"
"Returns:\n"
"\n"
"\n"
"GetAnnotationObjectNames returns a tuple of strings of the names of all\n"
"annotation objects defined for the currently active window.\n"
"\n"
"Example:\n"
"\n"
"names = GetAnnotationObjectNames()\n"
"names\n"
"[\"plot0000\", \"Line2D1\", \"TimeSlider1\"]\n"
;
hrchilds's avatar
hrchilds committed
2515 2516 2517 2518 2519 2520 2521 2522
const char *visit_GetAnnotationObject_doc = 
"GetAnnotationObject\n"
"-Returns a reference to the annotation object at the specified index in\n"
"the annotation object list.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
2523
"GetAnnotationObject(string) -> Annotation object\n"
hrchilds's avatar
hrchilds committed
2524 2525 2526 2527
"\n"
"\n"
"Arguments:\n"
"\n"
2528 2529
"string\n"
"The name of the annotation object as returned by GetAnnotationObjectNames.\n"
hrchilds's avatar
hrchilds committed
2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540
"\n"
"\n"
"Returns:\n"
"\n"
"GetAnnotationObject returns a reference to an annotation object that was\n"
"created using the CreateAnnotationObject function.\n"
"\n"
"\n"
"Description:\n"
"\n"
"GetAnnotationObject returns a reference to an annotation object that was\n"
whitlocb's avatar
whitlocb committed
2541
"created using the CreateAnnotationObject function. The string\n"
2542 2543 2544
"argument specifies the name of the desired annotation object. It must be\n"
"one of the names returned by GetAnnotationObjectNames. This function is not\n"
"currently necessary unless the annotation object that you used to create an\n"
hrchilds's avatar
hrchilds committed
2545
"annotation has gone out of scope and you need to create another reference\n"
2546 2547 2548
"to the object to set its properties. Also note that although this function\n"
"will apparently also accept an integer index, that mode of access is not\n"
"reliably and should be avoided.\n"
hrchilds's avatar
hrchilds committed
2549 2550 2551 2552 2553 2554 2555 2556 2557 2558
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/wave.visit\")\n"
"AddPlot(\"Pseudocolor\", \"pressure\")\n"
"DrawPlots()\n"
"\n"
"a = CreateAnnotationObject(\"TimeSlider\")\n"
2559 2560 2561
"GetAnnotationObjectNames()\n"
"[\"plot0000\", \"TimeSlider1\"]\n"
"ref = GetAnnotationObject(\"TimeSlider1\")\n"
hrchilds's avatar
hrchilds committed
2562 2563
"print ref\n"
;
2564 2565 2566 2567 2568 2569 2570
const char *visit_GetCallbackNames_doc = 
"GetCallbackNames\n"
"-Returns a list of allowable callback names for use with RegisterCallback().\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
2571
"GetCallbackNames() -> tuple of string objects\n"
2572 2573 2574 2575
"\n"
"\n"
"Returns:\n"
"\n"
2576 2577
"GetCallbackNames returns a tuple containing the names of valid callback \n"
"function identifiers for use in RegisterCallback().\n"
2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588
"\n"
"\n"
"Description:\n"
"\n"
"The GetCallbackNames function returns a tuple containing the names of valid \n"
"callback function identifiers for use in RegisterCallback().\n"
"\n"
"\n"
"Example:\n"
"\n"
"import visit\n"
2589
"print visit.GetCallbackNames()\n"
2590
;
hrchilds's avatar
hrchilds committed
2591 2592
const char *visit_GetDatabaseNStates_doc = 
"GetDatabaseNStates\n"
2593
"-Returns the number of time states in the active database.\n"
hrchilds's avatar
hrchilds committed
2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621
"\n"
"\n"
"Synopsis:\n"
"\n"
"GetDatabaseNStates() -> integer\n"
"\n"
"\n"
"Returns:\n"
"\n"
"Returns the number of time states in the active database or 0 if there is\n"
"no active database.\n"
"\n"
"\n"
"Description:\n"
"\n"
"GetDatabaseNStates returns the number of time states in the active\n"
"database, which is not the same as the number of states in the active time\n"
"slider. Time sliders can have different lengths due to database\n"
"correlations and keyframing. Use this function when you need the actual\n"
"number of time states in the active database.\n"
"\n"
"\n"
"Example:\n"
"\n"
"% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/wave*.silo database\")\n"
"print \"Number of time states: %d\" % GetDatabaseNStates()\n"
;
2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657
const char *visit_GetDefaultFileOpenOptions_doc = 
"GetDefaultFileOpenOptions\n"
"-Returns the current default options used when opening files for a\n"
"specific type of plugin.\n"
"\n"
"\n"
"Synopsis:\n"
"\n"
"GetDefaultFileOpenOptions(pluginName) -> Dictionary\n"
"\n"
"Arguments:\n"
"\n"
"pluginName\n"
"The name of a plugin.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"Returns a dictionary containing the options.\n"
"\n"
"\n"
"Description:\n"