Perform DAT

From Derivative
Jump to: navigation, search

Summary
[edit]

The Perform DAT logs various performance times in a Table DAT format. These benchmarks are similar to those reported by the Performance Monitor.

PythonIcon.pngperformDAT_Class


Parameters - Perform Page

Active active - Turns logging on/off. The DAT will continuously log while Active is On. Use resetpulse button to the right to grab a single frame snapshot.

Active Pulse activepulse -

Trigger Mode triggermode - - Offers two options for when to trigger a refresh of the logs.

  • When Frame Length Exceeds Threshold threshold - Use the Trigger Threshold parameter below to set a maximum frame time to wait before refreshing the log.
  • When a Frame is Dropped droppedframe - Refresh the log as soon as a frame is dropped.

Trigger Threshold triggerthreshold - This is the amount of time, in milliseconds, that a frame must exceed to cause the DAT to log and output the frame's timing. For example to see what happens when a frame takes more that 33 ms to cook, put this parameter to 33.  

Cook Time logcook - Logs the cook time of operators.

Export Time logexport - Logs time spent exporting CHOP channels.

Viewport Draw Time logviewport - Logs time to draw 3D geometry and SOP viewers.

Movie Time logmovie - Logs time taken to read video and audio from movie files.

Draw Channels Time logdrawchannels - Logs time to draw channels in CHOP viewers.

Object View Time logobjectview -

Custom Panel Time logcustompanel - Logs time taken by custom panels build with Panel Components.

MIDI Time logmidi - Logs time spent on MIDI.

Graphics Time loggraphics - Logs various graphics system calls, such as time spent waiting for the graphics card, calls to the graphic driver, converting TOP data to CHOPs, etc.

Frame Length logframelength - Logs total frame time in milliseconds (ms).

Misc logmisc - Logs miscellaneous times that do not fit into other categories.

Script logscript - Logs time spent running scripts.

Render logrender - Logs time spend by Render or Renderpass TOPs.


Parameters - Common Page

Language language - - Select how the DAT decides which script language to operate on.

  • Input input - The DAT uses the inputs script language.
  • Node node - The DAT uses it's own script language.


Edit/View Extension extension - - Select the file extension this DAT should expose to external editors.

  • dat dat - various common file extensions.
  • From Language language - pick extension from DATs script language.
  • Custom Extension custom - Specify a custom extension.


Custom Extension customext - Specifiy the custom extension.


Word Wrap wordwrap - - Enable Word Wrap for Node Display.

  • Input input - The DAT uses the inputs setting.
  • On on - Turn on Word Wrap.
  • Off off - Turn off Word Wrap.


DATs
Art-Net • CHOP Execute • CHOP to • Clip • Convert • Experimental:CPlusPlus • DAT•  Execute • DAT xport• Error • EtherDream • Evaluate • Examine • Execute • FIFO • File In • File Out • Folder • In • Indices • Info • Insert • Introduction To DATs id• Keyboard In • Experimental:Lookup • Merge • MIDI Event • MIDI In • Monitors • MQTT Client • Multi Touch In • Experimental:NDI • Null • OP Execute • OP Find • OSC In • OSC Out • Out • Panel Execute • Experimental:Parameter • Parameter Execute • Perform • Render Pick • Reorder • Script • Select • Serial • SOP to • Sort • Substitute • Switch • Table • TCP/IP • Text • Touch In • Touch Out • Transpose • TUIO In • UDP In • UDP Out • UDT In • UDT Out • Web • WebSocket • XML

An Operator Family that manipulates text strings: multi-line text or tables. Multi-line text is often a command Script, but can be any multi-line text. Tables are rows and columns of cells, each containing a text string.

To pulse a parameter is to send it a signal from a CHOP or python or a mouse click that causes a new action to occur immediately. A pulse from a CHOP is typically a 0 to 1 to 0 signal in a channel, and a pulse via python is via a .pulse() call on a pulse-type parameter, such as Reset in a Speed CHOP.

To re-compute the output data of the Operators. An operator cooks when (1) its inputs change, (2) its Parameters change, (3) when the timeline moves forward in some cases, or (4) Scripting commands are run on the node. When the operator is a Gadget, it also cooks when a user interacts with it. When an operator cooks, it usually causes operators connected to its output to re-cook. When TouchDesigner draws the screen, it re-cooks all the necessary operators in all Networks, contributing to a frame's total "cook time".

Exporting is the connection of CHOP channels to parameters of operators. The output of each exporting CHOP is one or more channels, active only while the CHOP Viewer is on. The current value of a channel can be exported to a parameter of any operator, overriding that parameter's value. See Parameter.

An Operator Family which operate on Channels (a series of numbers) which are used for animation, audio, mathematics, simulation, logic, UI construction, and many other applications.

An Operator Family that reads, creates and modifies 3D polygons, curves, NURBS surfaces, spheres, meatballs and other 3D surface data.

The component types that are used to render 3D scenes: Geometry Component contain the 3D shapes to render, plus Camera, Light, Ambient Light, Null, Bone, Handle and other component types.

An Operator Family that creates, composites and modifies images, and reads/writes images and movies to/from files and the network. TOPs run on the graphics card's GPU.

A set of commands located in a Text DAT that are triggered to run under certain conditions. There are two scripting languages in TouchDesigner: Python and the original Tscript. Scripts and single-line commands can also be run in the Textport.

The generic thing that holds an Operator, and includes Flags (display, bypass, lock, render, immune) and its position/size in the network. Whether you "lay down an Operator" or "lay down an Node", you're doing the same thing.