Profile

The Profile node allows you to measure the performance of a script by inserting the node at any point in the node tree and then using the Profile pane to determine the output. If you have more than one Profile node in a script, use the profile node dropdown in the Profile pane to choose which point in the script to calculate.

See Using Visual Diagnostics for more information.

Inputs and Controls

Control (UI)

Knob (Scripting)

Default Value

Function

Profile Tab

channels

channels

rgba

The profiling data is only calculated for these channels.

If you set this to something other than all or none, you can use the checkboxes on the right to select individual channels.

frame range

frame_range

Dependent on Project Settings

Sets the frame range for which the profiling data is calculated.

open profile panel

open_profile_panel

N/A

Click to open the Profile pane, which determines what profiling data is collected.

Python Tab (These controls are for Python callbacks and can be used to have Python functions automatically called when various events happen in Nuke.)

before render

beforeRender

none

These functions run prior to starting rendering in execute(). If they throw an exception, the render aborts.

before each frame

beforeFrameRender

none

These functions run prior to starting rendering of each individual frame. If they throw an exception, the render aborts.

after each frame

afterFrameRender

none

These functions run after each frame is finished rendering. They are not called if the render aborts. If they throw an exception, the render aborts.

after render

afterRender

none

These functions run after rendering of all frames is finished. If they throw an error, the render aborts.

render progress

renderProgress

none

These functions run during rendering to determine progress or failure.