VisIt2.2.2-Cli Function Reference

8/6/2019 VisIt2.2.2-Cli Function Reference

1/380

VisIt Python CLI function reference for VisIt

2.2.2

Generated from visitdoc.py

June 7, 2011

Contents i

1 Functions available before Launch() 1AddArgument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1GetDebugLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Launch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3SetDebugLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2 General functions 5ActivateDatabase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5AddOperator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

AddPlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7AddWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8AlterDatabaseCorrelation . . . . . . . . . . . . . . . . . . . . . . . . . 9ApplyNamedSelection . . . . . . . . . . . . . . . . . . . . . . . . . . . 10ChangeActivePlotsVar . . . . . . . . . . . . . . . . . . . . . . . . . . . 11CheckForNewStates . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12ChooseCenterOfRotation . . . . . . . . . . . . . . . . . . . . . . . . . 13ClearAllWindows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14ClearCache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15ClearCacheForAllEngines . . . . . . . . . . . . . . . . . . . . . . . . . 16ClearPickPoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17ClearReferenceLines . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18ClearViewKeyframes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

ClearWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20CloneWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22CloseComputeEngine . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23CloseDatabase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24ColorTableNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

i


2/380

ConstructDDF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26ConstructDataBinning . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

CopyAnnotationsToWindow . . . . . . . . . . . . . . . . . . . . . . . . 28CopyLightingToWindow . . . . . . . . . . . . . . . . . . . . . . . . . . 29CopyPlotsToWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30CopyViewToWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31CreateAnnotationObject . . . . . . . . . . . . . . . . . . . . . . . . . . 32CreateDatabaseCorrelation . . . . . . . . . . . . . . . . . . . . . . . . 33CreateNamedSelection . . . . . . . . . . . . . . . . . . . . . . . . . . . 35DeIconifyAllWindows . . . . . . . . . . . . . . . . . . . . . . . . . . . 36DefineArrayExpression . . . . . . . . . . . . . . . . . . . . . . . . . . . 37DefineCurveExpression . . . . . . . . . . . . . . . . . . . . . . . . . . . 38DefineMaterialExpression . . . . . . . . . . . . . . . . . . . . . . . . . 39DefineMeshExpression . . . . . . . . . . . . . . . . . . . . . . . . . . . 40DefinePythonExpression . . . . . . . . . . . . . . . . . . . . . . . . . . 41DefineScalarExpression . . . . . . . . . . . . . . . . . . . . . . . . . . . 42DefineSpeciesExpression . . . . . . . . . . . . . . . . . . . . . . . . . . 43DefineTensorExpression . . . . . . . . . . . . . . . . . . . . . . . . . . 44DefineVectorExpression . . . . . . . . . . . . . . . . . . . . . . . . . . 45DeleteActivePlots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46DeleteAllPlots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47DeleteDatabaseCorrelation . . . . . . . . . . . . . . . . . . . . . . . . 48DeleteExpression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49DeleteNamedSelection . . . . . . . . . . . . . . . . . . . . . . . . . . . 50DeletePlotDatabaseKeyframe . . . . . . . . . . . . . . . . . . . . . . . 51DeletePlotKeyframe . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52DeleteViewKeyframe . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

DeleteWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54DemoteOperator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55DisableRedraw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56DrawPlots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57EnableTool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58ExportDatabase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60GetActiveContinuousColorTable . . . . . . . . . . . . . . . . . . . . . 61GetActiveDiscreteColorTable . . . . . . . . . . . . . . . . . . . . . . . 62GetActiveTimeSlider . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63GetAnimationTimeout . . . . . . . . . . . . . . . . . . . . . . . . . . . 64GetAnnotationObject . . . . . . . . . . . . . . . . . . . . . . . . . . . 65GetAnnotationObjectNames . . . . . . . . . . . . . . . . . . . . . . . . 66

GetCallbackNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67GetDatabaseNStates . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68GetDefaultFileOpenOptions . . . . . . . . . . . . . . . . . . . . . . . . 69GetDomains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70GetEngineList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71GetLastError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

ii


3/380

GetLight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73GetLocalHostName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

GetLocalUserName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75GetMaterials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76GetNumPlots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77GetPickOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78GetPipelineCachingMode . . . . . . . . . . . . . . . . . . . . . . . . . 79GetPlotInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80GetPreferredFileFormats . . . . . . . . . . . . . . . . . . . . . . . . . . 81GetQueryOutputObject . . . . . . . . . . . . . . . . . . . . . . . . . . 82GetQueryOutputString . . . . . . . . . . . . . . . . . . . . . . . . . . 83GetQueryOutputValue . . . . . . . . . . . . . . . . . . . . . . . . . . . 84GetQueryOutputXML . . . . . . . . . . . . . . . . . . . . . . . . . . . 85GetTimeSliders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86GetView2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87GetView3D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88GetViewAxisArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89GetViewCurve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90GetWindowInformation . . . . . . . . . . . . . . . . . . . . . . . . . . 91HideActivePlots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92HideToolbars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93IconifyAllWindows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94InvertBackgroundColor . . . . . . . . . . . . . . . . . . . . . . . . . . 95LaunchNowin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Lineout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97ListDomains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98ListMaterials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

ListPlots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100LoadAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101LoadNamedSelection . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102LoadUltra . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103LocalNameSpace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104LongFileName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105MoveAndResizeWindow . . . . . . . . . . . . . . . . . . . . . . . . . . 106MovePlotDatabaseKeyframe . . . . . . . . . . . . . . . . . . . . . . . . 107MovePlotKeyframe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108MoveViewKeyframe . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109MoveWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110NodePick . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111NumColorTableNames . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

NumOperatorPlugins . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113NumPlotPlugins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114OpenComputeEngine . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115OpenDatabase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116OpenMDServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117OperatorPlugins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

iii


4/380

OverlayDatabase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120Pick . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

PickByGlobalNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122PickByGlobalZone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123PickByNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124PickByZone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125PlotPlugins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126PointPick . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127PrintWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128PromoteOperator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129PythonQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131QueriesOverTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133QueryOverTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134ReOpenDatabase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135RecenterView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136RedoView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137RedrawWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138RegisterCallback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139RemoveAllOperators . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140RemoveLastOperator . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141RemoveOperator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142ReplaceDatabase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143ResetLineoutColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144ResetOperatorOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . 145ResetPickLetter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

ResetPlotOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147ResetView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148ResizeWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149RestoreSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150RestoreSessionWithDifferentSources . . . . . . . . . . . . . . . . . . . 151SaveAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152SaveNamedSelection . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153SaveSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154SaveWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155SendSimulationCommand . . . . . . . . . . . . . . . . . . . . . . . . . 156SetActiveContinuousColorTable . . . . . . . . . . . . . . . . . . . . . . 157SetActiveDiscreteColorTable . . . . . . . . . . . . . . . . . . . . . . . 158SetActivePlots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

SetActiveTimeSlider . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160SetActiveWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161SetAnimationTimeout . . . . . . . . . . . . . . . . . . . . . . . . . . . 162SetAnnotationAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . 163SetCenterOfRotation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164SetCreateMeshQualityExpressions . . . . . . . . . . . . . . . . . . . . 165

iv


5/380

SetCreateTimeDerivativeExpressions . . . . . . . . . . . . . . . . . . . 166SetCreateVectorMagnitudeExpressions . . . . . . . . . . . . . . . . . . 167

SetDatabaseCorrelationOptions . . . . . . . . . . . . . . . . . . . . . . 168SetDefaultAnnotationAttributes . . . . . . . . . . . . . . . . . . . . . 170SetDefaultFileOpenOptions . . . . . . . . . . . . . . . . . . . . . . . . 171SetDefaultInteractorAttributes . . . . . . . . . . . . . . . . . . . . . . 172SetDefaultMaterialAttributes . . . . . . . . . . . . . . . . . . . . . . . 173SetDefaultMeshManagementAttributes . . . . . . . . . . . . . . . . . . 174SetDefaultOperatorOptions . . . . . . . . . . . . . . . . . . . . . . . . 175SetDefaultPickAttributes . . . . . . . . . . . . . . . . . . . . . . . . . 177SetDefaultPlotOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . 178SetGlobalLineoutAttributes . . . . . . . . . . . . . . . . . . . . . . . . 179SetInteractorAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . 180SetKeyframeAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . 181SetLight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182SetMaterialAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . 183SetMeshManagementAttributes . . . . . . . . . . . . . . . . . . . . . . 184SetOperatorOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185SetPickAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187SetPipelineCachingMode . . . . . . . . . . . . . . . . . . . . . . . . . . 188SetPlotDatabaseState . . . . . . . . . . . . . . . . . . . . . . . . . . . 189SetPlotFrameRange . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190SetPlotOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191SetPlotSILRestriction . . . . . . . . . . . . . . . . . . . . . . . . . . . 192SetPreferredFileFormats . . . . . . . . . . . . . . . . . . . . . . . . . . 193SetPrinterAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194SetQueryFloatFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

SetQueryOverTimeAttributes . . . . . . . . . . . . . . . . . . . . . . . 196SetRenderingAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . 197SetSaveWindowAttributes . . . . . . . . . . . . . . . . . . . . . . . . . 198SetTimeSliderState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199SetTreatAllDBsAsTimeVarying . . . . . . . . . . . . . . . . . . . . . . 200SetTryHarderCyclesTimes . . . . . . . . . . . . . . . . . . . . . . . . . 201SetView2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202SetView3D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203SetViewAxisArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204SetViewCurve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205SetViewExtentsType . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206SetViewKeyframe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207SetWindowArea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

SetWindowLayout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209SetWindowMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210ShowAllWindows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211ShowToolbars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213SuppressMessages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

v


6/380

SuppressQueryOutputOff . . . . . . . . . . . . . . . . . . . . . . . . . 215SuppressQueryOutputOn . . . . . . . . . . . . . . . . . . . . . . . . . 216

TimeSliderGetNStates . . . . . . . . . . . . . . . . . . . . . . . . . . . 217TimeSliderNextState . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218TimeSliderPreviousState . . . . . . . . . . . . . . . . . . . . . . . . . . 219TimeSliderSetState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220ToggleBoundingBoxMode . . . . . . . . . . . . . . . . . . . . . . . . . 221ToggleCameraViewMode . . . . . . . . . . . . . . . . . . . . . . . . . . 223ToggleFullFrameMode . . . . . . . . . . . . . . . . . . . . . . . . . . . 225ToggleLockTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227ToggleLockTools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229ToggleLockViewMode . . . . . . . . . . . . . . . . . . . . . . . . . . . 231ToggleMaintainViewMode . . . . . . . . . . . . . . . . . . . . . . . . . 233ToggleSpinMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235TurnDomainsOff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237TurnDomainsOn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238TurnMaterialsOff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239TurnMaterialsOn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240UndoView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242WriteConfigFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243ZonePick . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

3 Attribute functions 245ConstructDDFAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . 245GetAnnotationAttributes . . . . . . . . . . . . . . . . . . . . . . . . . 246GetGlobalAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247GetGlobalLineoutAttributes . . . . . . . . . . . . . . . . . . . . . . . . 248GetInteractorAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . 249GetKeyframeAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . 250GetMaterialAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . 251GetMeshManagementAttributes. . . . . . . . . . . . . . . . . . . . . . 252GetPickAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253GetQueryOverTimeAttributes . . . . . . . . . . . . . . . . . . . . . . . 254GetRenderingAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . 255GetSaveWindowAttributes . . . . . . . . . . . . . . . . . . . . . . . . . 256

4 Undocumented functions 257AddColorTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257AnimationAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

AnimationSetNFrames . . . . . . . . . . . . . . . . . . . . . . . . . . . 257AnnotationAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . 257Argv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257Axes2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257Axes3D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257AxisAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

vi


7/380

AxisLabels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257AxisTickMarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

AxisTitles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257BoundaryAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257BoundaryOpAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . 257BoxAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257ClearMacros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257ClientMethod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257ClipAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257ColorAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257ColorAttributeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257ColorControlPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257ColorControlPointList . . . . . . . . . . . . . . . . . . . . . . . . . . . 257ConeAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257ConnectedComponentsAttributes . . . . . . . . . . . . . . . . . . . . . 257ConstructDataBinningAttributes . . . . . . . . . . . . . . . . . . . . . 257ContourAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257CoordSwapAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . 257CreateBondsAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . 257CurveAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257CylinderAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257DataBinningAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . 257DeferExpressionAttributes . . . . . . . . . . . . . . . . . . . . . . . . . 257DisplaceAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257DualMeshAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257EdgeAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257ElevateAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

EvalCubic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257EvalCubicSpline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257EvalLinear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257EvalQuadratic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257ExecuteMacro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257ExportDBAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257ExternalSurfaceAttributes . . . . . . . . . . . . . . . . . . . . . . . . . 257FilledBoundaryAttributes . . . . . . . . . . . . . . . . . . . . . . . . . 257FluxAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257FontAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257GaussianControlPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . 258GaussianControlPointList . . . . . . . . . . . . . . . . . . . . . . . . . 258GetAnimationAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . 258

GetCallbackArgumentCount . . . . . . . . . . . . . . . . . . . . . . . . 258GetColorTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258GetDatabaseCorrelation . . . . . . . . . . . . . . . . . . . . . . . . . . 258GetDatabaseCorrelationNames . . . . . . . . . . . . . . . . . . . . . . 258GetExportOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258GetMetaData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

vii


8/380

GetOperatorOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258GetPlotList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

GetPlotOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258GetProcessAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . 258GetUltraScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258GlobalAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258HistogramAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258IndexSelectAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . 258InverseGhostZoneAttributes . . . . . . . . . . . . . . . . . . . . . . . . 258IsosurfaceAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258IsovolumeAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258LabelAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258LaunchProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258LightAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258LineSamplerAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . 258LineoutAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258MachineProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258MaterialAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258MeshAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258MeshManagementAttributes . . . . . . . . . . . . . . . . . . . . . . . . 258MoleculeAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258MovePlotOrderTowardFirst . . . . . . . . . . . . . . . . . . . . . . . . 258MovePlotOrderTowardLast . . . . . . . . . . . . . . . . . . . . . . . . 258MultiresControlAttributes . . . . . . . . . . . . . . . . . . . . . . . . . 258OnionPeelAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258OpenCLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258OpenClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

OpenGUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258ParallelCoordinatesAttributes . . . . . . . . . . . . . . . . . . . . . . . 258PersistentParticlesAttributes . . . . . . . . . . . . . . . . . . . . . . . 258PoincareAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258PrinterAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258ProcessAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258ProjectAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258PseudocolorAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . 258ReflectAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258RegisterMacro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258RemoveColorTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259RenamePickLabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259RenderingAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

ReplicateAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259ResampleAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259ResetPickAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259ResetQueryOverTimeAttributes . . . . . . . . . . . . . . . . . . . . . . 259RevolveAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259SILRestriction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

viii


9/380

SaveWindowAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . 259ScatterAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

SetAnimationAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . 259SetCloneWindowOnFirstRef. . . . . . . . . . . . . . . . . . . . . . . . 259SetColorTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259SetColorTexturingEnabled . . . . . . . . . . . . . . . . . . . . . . . . . 259SetDefaultQueryOverTimeAttributes . . . . . . . . . . . . . . . . . . . 259SetNamedSelectionAutoApply . . . . . . . . . . . . . . . . . . . . . . . 259SetPlotDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259SetPlotOrderToFirst . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259SetPlotOrderToLast . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259SetUltraScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259SliceAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259SmoothOperatorAttributes . . . . . . . . . . . . . . . . . . . . . . . . 259SphereSliceAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . 259SpreadsheetAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . 259StreamlineAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259SubsetAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259SurfaceNormalAttributes . . . . . . . . . . . . . . . . . . . . . . . . . 259TensorAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259ThreeSliceAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259ThresholdAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259TransformAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259TriangulateRegularPointsAttributes . . . . . . . . . . . . . . . . . . . 259TruecolorAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259TubeAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259UpdateNamedSelection . . . . . . . . . . . . . . . . . . . . . . . . . . 259

UserActionFinished . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259VectorAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259View2DAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259View3DAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259ViewAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259ViewAxisArrayAttributes . . . . . . . . . . . . . . . . . . . . . . . . . 259ViewCurveAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259VisItException . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259VisItInterrupt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259VolumeAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259WindowInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

5 Attribute listings 261

Animation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261Annotation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269Boundary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270BoundaryOp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

ix


10/380

Clip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273Cone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

ConnectedComponents . . . . . . . . . . . . . . . . . . . . . . . . . . . 275ConstructDDF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276ConstructDataBinning . . . . . . . . . . . . . . . . . . . . . . . . . . . 277Contour . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278CoordSwap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281CreateBonds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282Curve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283Cylinder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284DataBinning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285DeferExpression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286Displace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287DualMesh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288Edge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289Elevate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290ExportDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291ExternalSurface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292FilledBoundary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293Flux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294Font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295Global . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296GlobalLineout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297Histogram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298IndexSelect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299Interactor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300InverseGhostZone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

Isosurface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302Isovolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303Keyframe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306LineSampler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307Lineout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308Material . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309Mesh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310MeshManagement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311Molecule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312MultiresControl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314OnionPeel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

ParallelCoordinates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316PersistentParticles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317Pick . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318Poincare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323

x


11/380

Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324Pseudocolor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325

QueryOverTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326Reflect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327Rendering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328Replicate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329Resample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330Revolve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331SaveWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332Scatter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335Slice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337SmoothOperator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338SphereSlice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339Spreadsheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340Streamline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341Subset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345SurfaceNormal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346Tensor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347ThreeSlice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348Threshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349Transform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350TriangulateRegularPoints . . . . . . . . . . . . . . . . . . . . . . . . . 352Truecolor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353Tube . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354Vector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356View2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357

View3D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358ViewAxisArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359ViewCurve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360Volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

6 VisIt CLI Events 364

xi


12/380

1 Functions available before Launch()

These are functions that are available after importing the visit module:

from visit import * # either this way

import visit # or this way

# (Eval* functions will fail to load this way though)

AddArgument: add an argument to the viewers command line argument list.

Synopsis:AddArgument(argument)

Arguments:argument A string object that is added to the viewers command line

argument list.Returns:

AddArgument does not return a value.

Description:The AddArgument function is used to add extra command line arguments toVisIts viewer. This is only useful when VisIts Python interface is importedinto a standalone Python interpreter because the AddArgument functionmust be called before the viewer is launched. The AddArgument functionhas no effect when used in VisIts cli program because the viewer is auto-matically launched before any commands are processed.

Example:

import visit

visit.AddArgument("-nowin") # Add the -nowin argument to the viewer.

1


13/380

GetDebugLevel: set or Get the VisIt modules debug level.

Synopsis:GetDebugLevel() -> integer

SetDebugLevel(level)

Arguments:level An integer in the range [1,5]. A value of 1 is a low debug

level, whichshould be used to produce little output while avalue of 5 should produce alot of debug output.

Returns:The GetDebugLevel function returns the debug level of the VisIt module.

Description:The GetDebugLevel and SetDebugLevel functions are used when debuggingVisIt Python scripts. The SetDebugLevel function sets the debug level forVisIts viewer thus it must be called before a Launch method. The debug

level determines how much detail is written to VisIts execution logs whenit executes. The GetDebugLevel function can be used in Python scripts toalter the behavior of the script. For instance, the debug level can be used toselectively print values to the console.

Example:

% visit -cli -debug 2

print "VisIts debug level is: %d" % GetDebugLevel()

2


14/380

Launch: launches VisIts viewer

Synopsis:Launch()

LaunchNowin()

Arguments:none

Returns:The Launch functions do not return a value

Description:The Launch function is used to launch VisIts viewer when the VisIt moduleis imported into a standalone Python interpreter. The Launch functionhas no effect when a viewer already exists. The difference between Launchand LaunchNowin is that LaunchNowin prevents the viewer from ever creat-

ing onscreen visualization windows. The LaunchNowin function is primarilyused in Python scripts that want to generate visualizations using VisIt with-out the use of a display such as when generating movies.

Example 1:

import visit

visit.AddArgument("-geometry")

visit.AddArgument("1024x1024")

visit.LaunchNowin()

Example 2:

import visit

visit.AddArgument("-nowin")

visit.Launch()

3


15/380

SetDebugLevel: set or Get the VisIt modules debug level.

Synopsis:GetDebugLevel() -> integer

SetDebugLevel(level)

Arguments:level An integer in the range [1,5]. A value of 1 is a low debug

level, whichshould be used to produce little output while avalue of 5 should produce alot of debug output.

Returns:The GetDebugLevel function returns the debug level of the VisIt module.

Description:The GetDebugLevel and SetDebugLevel functions are used when debuggingVisIt Python scripts. The SetDebugLevel function sets the debug level forVisIts viewer thus it must be called before a Launch method. The debug

level determines how much detail is written to VisIts execution logs whenit executes. The GetDebugLevel function can be used in Python scripts toalter the behavior of the script. For instance, the debug level can be used toselectively print values to the console.

Example:

% visit -cli -debug 2

print "VisIts debug level is: %d" % GetDebugLevel()

4


16/380

2 General functions

After setting up the correct options for the compute engine, one issues theLaunch() command:

Launch() # after from visit import *

visit.Launch() # after import visit

After launching the compute engine, all functions in this and the following sec-tions become available.

ActivateDatabase: activates a database that has been previously opened.

Synopsis:ActivateDatabase(argument) -> integer

Arguments:argument A string object containing the name of the database to be

activated.Returns:

ActivateDatabase returns 1 on success and 0 on failure.

Description:The ActivateDatabase function is used to set the active database to a databasethat has been previously opened. The ActivateDatabase function only workswhen you are using it to activate a database that you have previously opened.You do not need to use this function unless you frequently toggle betweenmore than one database when making plots or changing time states. Whilethe OpenDatabase function on page 117 can also be used to set the active

database, the ActivateDatabase function does not have any side effects thatwould cause the time state for the new active database to be changed.

Example:

% visit -cli

dbs = ("/usr/gapps/visit/data/wave.visit", \

"/usr/gapps/visit/data/curv3d.silo")

OpenDatabase(dbs[0], 17)

AddPlot("Pseudocolor", "u")

DrawPlots()

OpenDatabase(dbs[1])


DrawPlots()

# Lets add another plot from the first database.ActivateDatabase(dbs[0])

AddPlot("Mesh", "quadmesh")

DrawPlots()

5


17/380


18/380

AddPlot: creates a new plot.

Synopsis:AddPlot(plotType, variableName) -> integer

Arguments:plotType This is a string containing the name of a valid plot plugin

type.variableName This is a string containing a valid variable name for the

open database.Returns:

The AddPlot function returns an integer value of 1 for success and 0 forfailure.

Description:The AddPlot function creates a new plot of the specified type using a variablefrom the open database. The plotType argument is a string that contains

the name of a valid plot plugin type which must be a member of the stringtuple that is returned by the PlotPlugins function (see page 127). The vari-ableName argument is a string that contains the name of a variable in theopen database. After the AddPlot function is called, a new plot is createdand it is made the sole active plot.

Example:

% visit -cli

OpenDatabase("/usr/gapps/visit/data/globe.silo")

AddPlot("Subset", "mat1") # Create a subset plot

DrawPlots()

7


19/380

AddWindow: creates a new visualization window.

Synopsis:AddWindow()

Returns:The AddWindow function does not a return value.

Description:The AddWindow function creates a new visualization window and makes itthe active window. This function can be used to create up to 16 visualizationwindows. After that, the AddWindow function has no effect.

Example:

import visit

visit.Launch()

visit.AddWindow() # Create window #2

visit.AddWindow() # Create window #3

8


20/380

AlterDatabaseCorrelation: alters a specific database correlation.

Synopsis:AlterDatabaseCorrelation(name, databases, method) -> integer

Arguments:name The name argument must be a string object containing the

name of thedatabase correlation to be altered.databases The databases argument must be a tuple or list of strings

containing thefully qualified database names to be used inthe database correlation.

method The method argument must be an integer in the range [0,3].Returns:

The AlterDatabaseCorrelation function returns 1 on success and 0 on failure.

Description:The AlterDatabaseCorrelation method alters an existing database correla-

tion. A database correlation is a VisIt construct that relates the time statesfor two or more databases in some way. You would use the AlterDatabaseC-orrelation function if you wanted to change the list of databases used ina database correlation or if you wanted to change how the databases arerelated the correlation method. The name argument is a string that isthe name of the database correlation to be altered. If the name that youpass is not a valid database correlation then the AlterDatabaseCorrelationfunction fails. The databases argument is a list or tuple of string objectscontaining the fullyqualified (host:/path/filename) names of the databasesto be involved in the database query. The method argument allows you tospecify a database correlation method.

Correlation method Value

IndexForIndexCorrelation 0StretchedIndexCorrelation 1TimeCorrelation 2CycleCorrelation 3

Example:

dbs = ("/usr/gapps/visit/data/wave.visit", \

"/usr/gapps/visit/data/wave*.silo database")


AddPlot("Pseudocolor", "pressure")


AddPlot("Pseudocolor", "d")

# VisIt created an index for index database correlation but we

# want a cycle correlation.AlterDatabaseCorrelation("Correlation01", dbs, 3)

9


21/380

ApplyNamedSelection: applies a named selection to the active plot.

Synopsis:ApplyNamedSelection(name) -> integer

Arguments:name The name of a named selection. (This should have been

previously createdwith a CreateNamedSelection call.)Returns:

The ApplyNamedSelection function returns 1 for success and 0 for failure.

Description:Named Selections allow you to select a group of elements (or particles). Onetypically creates a named selection from a group of elements and then laterapplies the named selection to another plot (thus reducing the set of ele-ments displayed to the ones from when the named selection was created).

Example:% visit -cli

db = "/usr/gapps/visit/data/wave*.silo database"

OpenDatabase(db)


AddOperator("Clip")

c = ClipAttributes()

c.plane1Origin = (0,0.6,0)

c.plane1Normal = (0,-1,0)

SetOperatorOption(c)

DrawPlots()

CreateNamedSelection("els_above_at_time_0")

TimeSliderSetState(40)

RemoveLastOperator()ApplyNamedSelection("els_above_at_time_0")

10


22/380

ChangeActivePlotsVar : changes the variable for the active plots

Synopsis:ChangeActivePlotsVar(variableName) -> integer

Arguments:variableName The name of the new plot variable.

Returns:The ChangeActivePlotsVar function returns an integer value of 1 for successand 0 for failure.

Description:The ChangeActivePlotsVar function changes the plotted variable for the ac-tive plots. This is a useful way to change what is being visualized withouthaving to delete and recreate the current plots. The variableName argumentis a string that contains the name of a variable in the open database.




DrawPlots()

SaveWindow()

ChangeActivePlotsVar("v")

11


23/380

CheckForNewStates: checks the specified database for new time states.

Synopsis:CheckForNewStates(name) -> integer

Arguments:name The name argument must be a string that contains the

name of a databasethat has been opened previously.Returns:

The CheckForNewStates function returns 1 for success and 0 for failure.

Description:Calculations are often run at the same time as some of the preliminary visu-alization work is being performed. That said, you might be visualizing theleading time states of a database that is still being created. If you want toforce VisIt to add any new time states that were added since you openedthe database, you can use the CheckForNewStates function. The name ar-

gument must contain the name of a database that has been opened before.

Example:

% visit -cli

db = "/usr/gapps/visit/data/wave*.silo database"

OpenDatabase(db)


DrawPlots()

SetTimeSliderState(TimeSliderGetNStates() - 1)

# More files appear on disk

CheckForNewStates(db)

SetTimeSliderState(TimeSliderGetNStates() - 1)

12


24/380

ChooseCenterOfRotation: allows you to interactively pick a new center ofrotation.

Synopsis:ChooseCenterOfRotation() -> integer

ChooseCenterOfRotation(screenX, screenY) -> integer

Arguments:screenX The X coordinate of the pick point in normalized [0,1]

screen space.screenY The Y cooridinate of the pick point in normalized [0,1]

screen space.Returns:

The ChooseCenterOfRotation function returns 1 if successful and 0 if it fails.

Description:The ChooseCenterOfRotation function allows you to pick a new center of

rotation, which is the point about which plots are rotated when you in-teractively rotate plots. The function can either take zero arguments, inwhich case you must interactively pick on plots, or it can take two argu-ments that correspond to the X and Y coordinates of the desired pick pointin normalized screen space. When using the two argument version of theChooseCenterOfRotation function, the X and Y values are floating pointvalues in the range [0,1]. If the ChooseCenterOfRotation function is able toactually pick on plots, yes there must be plots in the vis window, then thecenter of rotation is updated and the new value is printed to the console.

Example:

% visit -cli


AddPlots("Pseudocolor", "u")DrawPlots()

# Interactively choose the center of rotation

ChooseCenterOfRotation()

# Choose a center of rotation using normalized screen

# coordinates and print the value.

ResetView()

ChooseCenterOfRotation(0.5, 0.3)

print "The new center of rotation is:", GetView3D().centerOfRotation

13


25/380

ClearAllWindows: clears visualization windows of plots.

Synopsis:ClearAllWindows()

ClearWindow()

Returns:The Clear functions do not return values.

Description:The ClearWindow function is used to clear out the plots from the activevisualization window. The plots are removed from the visualization windowbut are left in the plot list so that subsequent calls to the DrawPlots func-tion regenerate the plots in the plot list. The ClearAllWindows functionpreforms the same work as the ClearWindow function except that all win-dows are cleared of their plots.




DrawPlots()

AddWindow()

SetActiveWindow(2) # Make window 2 active


AddPlot("Subset", "mat1")

DrawPlots()

ClearWindow() # Clear the plots in window 2.

DrawPlots() # Redraw the plots in window 2.

ClearAllWindows() # Clear the plots from all windows.

14


26/380

ClearCache: clears the compute engines network cache.

Synopsis:ClearCache(host) -> integer

ClearCache(host, simulation) -> integer

ClearCacheForAllEngines() -> integer

Arguments:host The name of the computer where the compute engine is

running.simulation The name of the simulation being processed by the compute

engine.Returns:

The ClearCache and ClearCacheForAllEngines functions return 1 on successand 0 on failure.

Description:

Sometimes during extended VisIt runs, you might want to periodically clearthe compute engines network cache to reduce the amount of memory beingused by the compute engine. Clearing the network cache is also useful whenyou want to change what the compute engine is working on. For example,you might process a large database and then decide to process another largedatabase. Clearing the network cache beforehand will free up more resourcesfor the compute engine so it can more efficiently process the new database.The host argument is a string object containing the name of the computeron which the compute engine is running. The simulation argument is op-tional and only applies to when you want to instruct a simulation that isacting as a VisIt compute engine to clear its network cache. If you wantto tell more than one compute engine to clear its cache without having tocall ClearCache multiple times, you can use the ClearCacheForAllEnginesfunction.

Example:

%visit -cli

OpenDatabase("localhost:very_large_database")

# Do a lot of work

ClearCache("localhost")

OpenDatabase(localhost:another_large_database")

# Do more work

OpenDatabase("remotehost:yet_another_database")

# Do more work

ClearCacheForAllEngines()

15


27/380

ClearCacheForAllEngines: clears the compute engines network cache.

Synopsis:ClearCache(host) -> integer

ClearCache(host, simulation) -> integer

ClearCacheForAllEngines() -> integer

Arguments:host The name of the computer where the compute engine is

running.simulation The name of the simulation being processed by the compute

engine.Returns:

The ClearCache and ClearCacheForAllEngines functions return 1 on successand 0 on failure.

Description:

Sometimes during extended VisIt runs, you might want to periodically clearthe compute engines network cache to reduce the amount of memory beingused by the compute engine. Clearing the network cache is also useful whenyou want to change what the compute engine is working on. For example,you might process a large database and then decide to process another largedatabase. Clearing the network cache beforehand will free up more resourcesfor the compute engine so it can more efficiently process the new database.The host argument is a string object containing the name of the computeron which the compute engine is running. The simulation argument is op-tional and only applies to when you want to instruct a simulation that isacting as a VisIt compute engine to clear its network cache. If you wantto tell more than one compute engine to clear its cache without having tocall ClearCache multiple times, you can use the ClearCacheForAllEnginesfunction.

Example:

%visit -cli

OpenDatabase("localhost:very_large_database")

# Do a lot of work

ClearCache("localhost")

OpenDatabase(localhost:another_large_database")

# Do more work

OpenDatabase("remotehost:yet_another_database")

# Do more work

ClearCacheForAllEngines()

16


28/380

ClearPickPoints: clears pick points from the visualization window

Synopsis:ClearPickPoints()

Returns:The ClearPickPoints function does not return a value.

Description:The ClearPickPoints function removes pick points from the active visualiza-tion window. Pick points are the letters that are added to the visualizationwindow where the mouse is clicked when the visualization window is in pickmode.

Example:

% visit -cli

# Put the visualization window into pick mode using the popup

# menu and add some pick points.# Clear the pick points.

ClearPickPoints()

17


29/380

ClearReferenceLines: clears reference lines from the visualization window.

Synopsis:ClearReferenceLines()

Returns:The ClearReferenceLines function does not return a value.

Description:The ClearReferenceLines function removes reference lines from the activevisualization window. Reference lines are the lines that are drawn on a plotto show where you have performed lineouts.

Example:

% visit -cli

OpenDatabase("/usr/gapps/visit/data/curv2d.silo")


Lineout((-3.0, 2.0), (2.0, 4.0), ("default", "u", "v"))ClearReferenceLines()

18


30/380

ClearViewKeyframes: clears any view keyframes that have been set.

Synopsis:ClearViewKeyframes() -> integer

Returns:The ClearViewKeyframes function returns 1 on success and 0 on failure.

Description:The ClearViewKeyframes function clears any view keyframes that may havebeen set. View keyframes are used to create complex view behavior such asflythroughs when VisIt is in keyframing mode.

Example:

% visit -cli



k = KeyframeAttributes()k.enabled, k.nFrames, k.nFramesWasUserSet = 1,10,1

SetKeyframeAttributes(k)

DrawPlots()

SetViewKeyframe()

v1 = GetView3D()

v1.viewNormal = (-0.66609, 0.337227, 0.665283)

v1.viewUp = (0.157431, 0.935425, -0.316537)

SetView3D(v1)

SetTimeSliderState(9)

SetViewKeyframe()

ToggleCameraViewMode()

for i in range(10):

SetTimeSliderState(i)ClearViewKeyframes()

19


31/380

ClearWindow: clears visualization windows of plots.

Synopsis:ClearAllWindows()

ClearWindow()

Returns:The Clear functions do not return values.

Description:The ClearWindow function is used to clear out the plots from the activevisualization window. The plots are removed from the visualization windowbut are left in the plot list so that subsequent calls to the DrawPlots func-tion regenerate the plots in the plot list. The ClearAllWindows functionpreforms the same work as the ClearWindow function except that all win-dows are cleared of their plots.




DrawPlots()

AddWindow()

SetActiveWindow(2) # Make window 2 active


AddPlot("Subset", "mat1")

DrawPlots()

ClearWindow() # Clear the plots in window 2.

DrawPlots() # Redraw the plots in window 2.

ClearAllWindows() # Clear the plots from all windows.

20


32/380

CloneWindow: creates a new window that has the same plots, annotations,lights, and

Synopsis:CloneWindow() -> integer

Returns:The CloneWindow function returns an integer value of 1 for success and 0for failure.

Description:The CloneWindow function tells the viewer to create a new window, basedon the active window, that contains the same plots, annotations, lights, andview as the active window. This function is useful for when you have a win-dow set up like you want and then want to do the same thing in anotherwindow using a different database. You can first clone the window and thenreplace the database.

Example:

% visit -cli



DrawPlots()

v = ViewAttributes()

v.camera = (-0.505893, 0.32034, 0.800909)

v.viewUp = (0.1314, 0.946269, -0.295482)

v.parallelScale = 14.5472

v.nearPlane = -34.641

v.farPlane = 34.641

v.perspective = 1

SetView3D() # Set the viewa = AnnotationAttributes()

a.backgroundColor = (0, 0, 255, 255)

SetAnnotationAttributes(a) # Set the annotation properties

CloneWindow() # Create a clone of the active window

DrawPlots() # Make the new window draw its plots

21


33/380

Close: closes the viewer.

Synopsis:Close()

Arguments:none

Returns:The Close function does not return a value.

Description:The Close function terminates VisIts viewer. This is useful for Pythonscripts that only need access to VisIts capabilties for a short time beforeclosing VisIt.

Example:

import visit

visit.Launch()

visit.Close() # Close the viewer

22


34/380

CloseComputeEngine: closes the compute engine running on a specified host.

Synopsis:CloseComputeEngine() -> integer

CloseComputeEngine(hostName) -> integer

CloseComputeEngine(hostName, simulation) -> integer

Arguments:hostName Optional name of the computer on which the compute en-

gine is running.simulation Optional name of a simulation.

Returns:The CloseComputeEngine function returns an integer value of 1 for successand 0 for failure.

Description:The CloseComputeEngine function tells the viewer to close the compute

engine running a specified host. The hostName argument is a string thatcontains the name of the computer where the compute engine is running.The hostName argument can also be the name localhost if you want toclose the compute engine on the local machine without having to specify itsname. It is not necessary to provide the hostName argument. If the argu-ment is omitted, the first compute engine in the engine list will be closed.The simulation argument can be provided if you want to close a connec-tion to a simulation that is acting as a VisIt compute engine. A computeengine can be launched again by creating a plot or by calling the OpenCom-puteEngine function.

Example:

% visit -cli

OpenDatabase("/usr/gapps/visit/data/globe.silo") # Launches an engineAddPlot("Pseudocolor", "u")

DrawPlots()

CloseComputeEngine() # Close the compute engine

23


35/380

CloseDatabase: closes the specified database and frees up resources associatedwith it.

Synopsis:CloseDatabase(name) -> integer

Arguments:name A string object containing the name of the database to

close.Returns:

The CloseDatabase function returns 1 on success and 0 on failure.

Description:The CloseDatabase function is used to close a specified database and freeall resources that were devoted to keeping the database open. This functionhas an effect similar to ClearCache (see page 40) but it does more in that inaddition to clearing the compute engines cache, which it only does for the

specified database, it also removes all references to the specified databasefrom tables of cached metadata, etc. Note that the CloseDatabase functionwill fail and the database will not be closed if any plots reference the speci-fied database.

Example:

% visit -cli

db = "/usr/gapps/visit/data/globe.silo"

OpenDatabase(db)


DrawPlots()

print "This wont work: retval = %d" % CloseDatabase(db)

DeleteAllPlots()

print "Now it works: retval = %d" % CloseDatabase(db)

24


36/380

ColorTableNames: returns a tuple of color table names.

Synopsis:ColorTableNames() -> tuple

Returns:The ColorTableNames function returns a tuple of strings containing thenames of the color tables that have been defined.

Description:The ColorTableNames function returns a tuple of strings containing thenames of the color tables that have been defined. This method can be usedin case you want to iterate over several color tables.

Example:

% visit -cli


AddPlot("Pseudocolor", "u")DrawPlots()

for ct in ColorTableNames():

p = PseudocolorAttributes()

p.colorTableName = ct

SetPlotOptions(p)

25


37/380

ConstructDDF: constructs a data binning

Synopsis:ConstructDataBinning(i) -> int

Arguments:i An ob ject of type ConstructDataBinningAttributes. This

object specifies the optionsfor constructing a data binning.Returns:

Returns 1 on success, 0 on failure.

Description:The ConstructDataBinning function creates a data binning function for theactive plot. Data Binnings place data from a data set into bins and reducethat data. They are used to either be incorporated with expressions to makenew derived quantities or to be directly visualized.




DrawPlots()

# Set the construct data binning attributes.

i = ConstructDataBinningAttributes()

i.name = "db1"

i.binningScheme = i.Uniform

i.varnames = ("u", "w")

i.binBoundaries = (-1, 1, -1, 1) # minu, maxu, minw, maxw

i.numSamples = (25, 25)

i.reductionOperator = i.Average

i.varForReductionOperator = "v"ConstructDataBinning(i)

26


38/380

ConstructDataBinning: constructs a data binning

Synopsis:ConstructDataBinning(i) -> int

Arguments:i An ob ject of type ConstructDataBinningAttributes. This

object specifies the optionsfor constructing a data binning.Returns:

Returns 1 on success, 0 on failure.

Description:The ConstructDataBinning function creates a data binning function for theactive plot. Data Binnings place data from a data set into bins and reducethat data. They are used to either be incorporated with expressions to makenew derived quantities or to be directly visualized.




DrawPlots()

# Set the construct data binning attributes.

i = ConstructDataBinningAttributes()

i.name = "db1"

i.binningScheme = i.Uniform

i.varnames = ("u", "w")

i.binBoundaries = (-1, 1, -1, 1) # minu, maxu, minw, maxw

i.numSamples = (25, 25)

i.reductionOperator = i.Average

i.varForReductionOperator = "v"ConstructDataBinning(i)

27


39/380

CopyAnnotationsToWindow : copies attributes from one visualization win-dow to another visualization

Synopsis:CopyAnnotationsToWindow(source, dest) -> integer

CopyLightingToWindow(source, dest) -> integer

CopyViewTowindow(source, dest) -> integer

CopyPlotsToWindow(source, dest) -> integer

Arguments:source The index (an integer from 1 to 16) of the source window.dest The index (an integer from 1 to 16) of the destination win-

dow.Returns:

The Copy functions return an integer value of 1 for success and 0 for failure.

Description:

The Copy functions copy attributes from one visualization window to an-other visualization window. The CopyAnnotationsToWindow function copiesthe annotations from a source visualization window to a destination visu-alization window while the CopyLightingAttributes function copies light-ing and the CopyViewToWindow function copies the view. The CopyPlot-sToWindow function copies the plots from one visualization window to an-other visualization window but does not also force plots to generate so aftercopying plots with the CopyPlotsToWindow function, you should also callthe DrawPlots function.

Example:

% visit -cli



AddWindow()

SetActiveWindow(2)


AddPlot("Mesh", "mesh1")

# Copy window 1s Pseudocolor plot to window 2.

CopyPlotsToWindow(1, 2)

DrawPlots() # Window 2 will have 2 plots

# Spin the plots around in window 2 using the mouse.

CopyViewToWindow(2, 1) # Copy window 2s view to window 1.

28


40/380

CopyLightingToWindow: copies attributes from one visualization windowto another visualization






dow.Returns:


Description:


Example:

% visit -cli



AddWindow()

SetActiveWindow(2)








29


41/380

CopyPlotsToWindow: copies attributes from one visualization window toanother visualization






dow.Returns:


Description:


Example:

% visit -cli



AddWindow()

SetActiveWindow(2)








30


42/380

CopyViewToWindow: copies attributes from one visualization window toanother visualization






dow.Returns:


Description:


Example:

% visit -cli



AddWindow()

SetActiveWindow(2)





DrawPlots() # Wind

Documents

VisIt2.2.2-Cli Function Reference