C_AlphaGenerator

C_AlphaGenerator creates a rectangular or elliptical mask in the alpha channel. It's primarily used for manual stitching and is included in the Manual 2D and 3D Stitching toolsets included in C_CameraSolver's Export dropdown.

Inputs and Controls

Connection Type

Connection Name

Function

Input

src

The image sequence to which the alpha mask is added.

Control (UI)

Knob (Scripting)

Default Value

Function

C_AlphaGenerator Tab

Local GPU

gpuName

N/A

Displays the GPU used for rendering when Use GPU if available is enabled. Local GPU displays Not available when:

Use CPU is selected as the GPU device in the Preferences.

no suitable GPU was found on your system.

it was not possible to create a context for processing on the selected GPU, such as when there is not enough free memory available on the GPU.

You can select a different GPU device, if available, by navigating to the Preferences and selecting an alternative from the GPU Device dropdown.

Note:  Selecting a different GPU requires you to restart Nuke before the change takes effect.

Use GPU if available

useGPUIfAvailable

enabled

When enabled, rendering occurs on the Local GPU specified, if available, rather than the CPU.

Note:  Enabling this option with no local GPU allows the script to run on the GPU whenever the script is opened on a machine that does have a GPU available.
You should also select this if you wish to render from the command line with the --gpu option.

See Windows, Mac OS X and macOS, or Linux for more information on the GPUs Nuke supports.

Shape

alphaShape

Rectangular

Sets the shape of the alpha mask generated, either Rectangular or Elliptical.

Size (w,h)

alphaSize

1,1

Sets the width and height of the of the mask relative to the image width and height, where 1,1 is equal to the whole image, minus the feathering.

Feather

alphaFeather

0.4

Controls the feathering at the edges of the mask, where 0 is equal to no feathering.