Palette:probe

From Derivative
Jump to navigation Jump to search

Summary
[edit]

Probe is a visual performance monitor for TouchDesigner processes, measuring CPU times (circles), and GPU times (diamonds), plus, via the selector on the left, CPU memory, GPU memory and the number of children in a component.

There are forum posts at https://www.derivative.ca/Forum/viewtopic.php?p=30059

See also the non-graphical monitor: Performance Monitor

How to Use probe

Drag-drop the probe component from the Palette anywhere in your TouchDesigner process, preferably in /.

Pressing Ctrl-p (it may be Cmd-p on macOS) will display and un-display the probe panel: You will be able to see the probe when you are in Designer Mode as a floating window, or in Perform Mode. In Perform Mode it is a panel embedded in your main UI (to minumize effect of having 2 windows open).

The probe panel looks a bit like your network. For CPU Times, each stack of circles represents the recent time-history of a node. There is one stack for every node in your current network. The color and size of the circles gives the cook time... use the color legend at the bottom left, expressed in milliseconds.

probe CPU performance monitor

Each stack is 10 circles, the top being the most recent Time Slice that cooked, the bottom being the tenth most-recent Time Slice. However if a node hasn't cooked in the last 10 time slices, the bottom circle represents the most recent time it actually cooked.

Navigating the networks is a bit different that the Network Editor. by left-clicking on a node's box, if it is a component, will go into that component.. Click on the background to go back up the network hierarchy.

You can use the roller wheel to zoom into a part of a network. But there is no scroll left-right.

Middle click on the node to bring up its parameter dialog. Right-click on a node to bring up another window containing the network editor for that node.

The stacks that look like donuts or Tootsie Roll (USA) that have a circle within a circle are components. The inner circle represents the children cooking time inside the component, the outer circle representing the sum of the node's cook time and its children's cook time.

a component

The large colored box around all the nodes represents, through its color, the cook time of all the nodes in the network, including all children.

Rolling over a node or stack will show the numeric value of the metric, and in the spectrum graphic on the left (the white line shows the value of the current node's metric, otherwise the parent's value).

The network has a colored bounding box around the nodes. The color of the bounding box represents the total cook time or memory of the component that you are in. Again, refer to the color legend on the left to translate the color into the metric's value.

When you are displaying probe, the buttons at the top right (1) Par+ opens the parameters of probe, where you can, for example, adjust its position in your Perform window, and (2) Help gets this wiki page.

Note

Like in the standard Performance monitor, the OP cooking you see with "CPU TIme" selected is for the CPU times. TOPs and panels are the only OP families that uses GPU, and the cook time you see for them is only the CPU set-up time. (same is true for the Dialogs -> Performance Monitor)

Click on "GPU Time" to get GPU times, etc. Memory is expressed in Megabytes.

This component consumes its own minimal cook time, sometimes up to a few milliseconds, so it will slow your process down a bit when it is being displayed. Undilplaying it (Ctrl-P) stops all cooking of Probe.

PythonIcon.pngPalette:probe Ext


Parameters - Probe Page

Help Help -

Version Version -

Data Type Datatype - -

  • CPU Time cputime -
  • GPU Time gputime -
  • CPU Memory cpumemory -
  • GPU Memory gpumemory -
  • Children children -

Open Open -

Close Close -

Open/Close with Ctrl-p Ctrlp -

Embedded in Perform Performembed -

Position in Perform Performpos - -

  • Position in Perform Performposu -
  • Position in Perform Performposv -

Scale in Perform Performscale -

Opacity in Perform Opacity -

Render Resolution Renderres - -

  • Render Resolution Renderresw -
  • Render Resolution Renderresh -

Render Aspect Renderaspect -

Listen Listen -

TouchDesigner Build:

Palette
Palette • Palette:arcBallCamera • Palette:arcBallGeometry • Palette:audioAnalysis • Palette:audioSet • Palette:battery • Palette:bitwigClip • Palette:bitwigClipSlot • Palette:bitwigDeviceRemotes • Palette:bitwigMain • Palette:bitwigNote • Palette:bitwigProjectRemotes • Palette:bitwigRemotesDevice • Palette:bitwigRemotesProject • Palette:bitwigRemotesTrack • Palette:bitwigSelect • Palette:bitwigSong • Palette:bitwigTrack • Palette:bitwigTrackRemotes • Palette:blendModes • Palette:bloom • Palette:camera • Palette:cameraBrowser • Palette:cameraViewport • Palette:camSchnappr • Palette:changeColor • Palette:changeToColor • Palette:checker • Palette:chromaKey • Palette:colorThreshold • Palette:compareComp • Palette:convolve • Palette:cornerPinSOP • Palette:cppParsTemplateGen • Palette:customAttributes • Palette:debugControl • Palette:dent • Palette:depthExtract • Palette:dilate • Palette:encoder • Palette:equalizer • Palette:feedback • Palette:feedbackEdge • Palette:firmata • Palette:gal • Palette:geoPanel • Palette:gestureCapture • Palette:graphPlot • Palette:histogram • Palette:hsvBlur • Palette:imageSearch • Palette:julia • Palette:kantanMapper • Palette:kinectCalibration • Palette:kinectPointcloud • Palette:leapPaint • Palette:lightTunnel • Palette:logger • Palette:mandelbrot • Palette:materialDesignIcons • Palette:mesh • Palette:monochrome • Palette:motionSense • Palette:movieEngine • Palette:moviePlayer • Palette:moviePlaylist • Palette:multiLevel • Palette:multiMix • Palette:noise • Palette:onScreenKeyboard • Palette:operatorPath • Palette:opticalFlow • Palette:pixelate • Palette:pixelRelocator • Palette:pointGenerator • Palette:pointillize • Palette:pointMerge • Palette:pointRender • Palette:pointRepack • Palette:pointTransform • Palette:pointWeight • Palette:popDialog • Palette:probe • Palette:projectorBlend • Palette:pushPins • Palette:puzzle • Palette:quadReproject • Palette:radialBlur • Palette:recorder • Palette:remotePanel • Palette:rgbaBlur • Palette:rgbaDelay • Palette:rgbContrast • Palette:sceneChanger • Palette:search • Palette:searchReplace • Palette:sharpen • Palette:sickEngine • Palette:signalingClient • Palette:signalingServer • Palette:softenAlpha • Palette:solarize • Palette:sopRender • Palette:splitter • Palette:stitcher • Palette:stoner • Palette:superFormula • Palette:SVG • Palette:sweetSpot • Palette:sweetSpotPreviz • Palette:synchroCache • Palette:synchroClient • Palette:synchroFrameIn • Palette:synchroFrameOut • Palette:synchroNDIIn • Palette:synchroSDIIn • Palette:synchroVideoOut • Palette:tdBitwigPackage • Palette:TDVR • Palette:transitMap • Palette:twirl • Palette:vectorScope • Palette:virtualFile • Palette:waveformMonitor • Palette:webBrowser • Palette:webRTC • Palette:webRTCPanel • Palette:webRTCPanelRcv • Palette:xyScope