JOS JOS Compositor

Node reference

Deep nodes

Deep Channel Blanker

Type name: DeepChannelBlanker (scripts, MCP and Nuke import use it).

Sets one channel of every deep sample to 0.

Inputs: input (deep).

Setting Default Range or choices What it does
channel none The channel set to 0 in every sample; none: no change.

Deep Clip Z

Type name: DeepClipZ (scripts, MCP and Nuke import use it).

Keeps the deep samples in front of the second input's depth (ours: Nuke's not measured).

Inputs: input (deep), depth.

No settings.

Deep Color Correct

Type name: DeepColorCorrect (scripts, MCP and Nuke import use it).

ColorCorrect on deep samples, optionally only in a depth range.

Inputs: input (deep).

Setting Default Range or choices What it does
saturation 1 0 to 4 Colour strength: 0 grey, 1 unchanged, above 1 more vivid, across the whole picture.
contrast 1 0 to 4 Contrast about mid grey (0.18): above 1 more, below 1 less, across the whole picture.
gamma 1 0.2 to 5 Gamma: above 1 brightens the mid tones, below 1 darkens them, across the whole picture.
gain 1 0 to 4 Multiplies the colour (1: unchanged), across the whole picture.
offset 0 -1 to 1 Adds to the colour (0: unchanged), across the whole picture.
shadows saturation 1 0 to 4 Colour strength: 0 grey, 1 unchanged, above 1 more vivid, in the shadows only.
shadows contrast 1 0 to 4 Contrast about mid grey (0.18): above 1 more, below 1 less, in the shadows only.
shadows gamma 1 0.2 to 5 Gamma: above 1 brightens the mid tones, below 1 darkens them, in the shadows only.
shadows gain 1 0 to 4 Multiplies the colour (1: unchanged), in the shadows only.
shadows offset 0 -1 to 1 Adds to the colour (0: unchanged), in the shadows only.
midtones saturation 1 0 to 4 Colour strength: 0 grey, 1 unchanged, above 1 more vivid, in the midtones only.
midtones contrast 1 0 to 4 Contrast about mid grey (0.18): above 1 more, below 1 less, in the midtones only.
midtones gamma 1 0.2 to 5 Gamma: above 1 brightens the mid tones, below 1 darkens them, in the midtones only.
midtones gain 1 0 to 4 Multiplies the colour (1: unchanged), in the midtones only.
midtones offset 0 -1 to 1 Adds to the colour (0: unchanged), in the midtones only.
highlights saturation 1 0 to 4 Colour strength: 0 grey, 1 unchanged, above 1 more vivid, in the highlights only.
highlights contrast 1 0 to 4 Contrast about mid grey (0.18): above 1 more, below 1 less, in the highlights only.
highlights gamma 1 0.2 to 5 Gamma: above 1 brightens the mid tones, below 1 darkens them, in the highlights only.
highlights gain 1 0 to 4 Multiplies the colour (1: unchanged), in the highlights only.
highlights offset 0 -1 to 1 Adds to the colour (0: unchanged), in the highlights only.
limit z off Only samples whose depth is in the range below.
zmap a 0 0 to 1000 The depth range (Nuke's zmap): fully corrected from b to c, fading in from a and out to d.
zmap b 1 0 to 1000 The depth range (Nuke's zmap): fully corrected from b to c, fading in from a and out to d.
zmap c 1 0 to 1000 The depth range (Nuke's zmap): fully corrected from b to c, fading in from a and out to d.
zmap d 1 0 to 1000 The depth range (Nuke's zmap): fully corrected from b to c, fading in from a and out to d.
mix 1 0 to 1 How much of the result shows over the input: 0 is the input, 1 the full effect.

Deep Crop

Type name: DeepCrop (scripts, MCP and Nuke import use it).

Keeps the deep samples inside a box and a depth range (or outside them).

Inputs: input (deep).

Setting Default Range or choices What it does
znear 1 0 to 1000 Samples nearer than this go (with use znear).
use znear on Crop at znear (off: no near limit).
zfar 2 0 to 1000 Samples farther than this go (with use zfar).
use zfar on Crop at zfar (off: no far limit).
keep outside zrange off Keep what's out of the depth range instead.
box left 384 0 to 4096 The box's left edge, in pixels.
box bottom 216 0 to 4096 The box's bottom edge, in pixels.
box right 1536 0 to 4096 The box's right edge, in pixels.
box top 864 0 to 4096 The box's top edge, in pixels.
use box on Keep only the pixels whose centre is in the box (off: the box isn't used).
keep outside bbox off Keep what's out of the box instead.

Deep De-Overlap

Type name: DeepDeOverlap (scripts, MCP and Nuke import use it).

Splits overlapping volume samples where they meet, merging the pieces.

Inputs: input (deep).

No settings.

Deep Expression

Type name: DeepExpression (scripts, MCP and Nuke import use it).

Expressions computing deep samples' channels from their colour, alpha and depths.

Inputs: input (deep).

Setting Default Range or choices What it does
temp name 0 A name for a temporary value the expressions below can use.
temp expr 0 The temporary's value, worked out for every sample from the same names as the channels' expressions.
temp name 1 A name for a temporary value the expressions below can use.
temp expr 1 The temporary's value, worked out for every sample from the same names as the channels' expressions.
temp name 2 A name for a temporary value the expressions below can use.
temp expr 2 The temporary's value, worked out for every sample from the same names as the channels' expressions.
temp name 3 A name for a temporary value the expressions below can use.
temp expr 3 The temporary's value, worked out for every sample from the same names as the channels' expressions.
red This channel of every sample from r, g, b, a, front, back, x, y, width, height and the temporaries (empty: unchanged).
green This channel of every sample from r, g, b, a, front, back, x, y, width, height and the temporaries (empty: unchanged).
blue This channel of every sample from r, g, b, a, front, back, x, y, width, height and the temporaries (empty: unchanged).
alpha This channel of every sample from r, g, b, a, front, back, x, y, width, height and the temporaries (empty: unchanged).
front This channel of every sample from r, g, b, a, front, back, x, y, width, height and the temporaries (empty: unchanged).
back This channel of every sample from r, g, b, a, front, back, x, y, width, height and the temporaries (empty: unchanged).

Deep From Image

Type name: DeepFromImage (scripts, MCP and Nuke import use it).

A flat image as a deep one: a sample per pixel, at a set depth or its depth.Z.

Inputs: input.

Setting Default Range or choices What it does
premult off The input is premultiplied already (off: its colour is multiplied by alpha).
set z off Use the z below instead of depth.Z.
z 0 0 to 1000 The samples' depth (distance).
keep zero alpha off A sample for pixels with alpha 0 too.

Deep Holdout

Type name: DeepHoldout (scripts, MCP and Nuke import use it).

The main deep image cut out by the holdout one in front of it, flattened.

Inputs: main (deep), holdout (optional, deep).

No settings.

Deep Merge

Type name: DeepMerge (scripts, MCP and Nuke import use it).

Combines deep images by depth (B and every A), or holds B out by them.

Inputs: B (deep), A (optional, deep); more as you connect them.

Setting Default Range or choices What it does
operation combine combine, holdout combine: both, sorted by depth; holdout: B cut out by A in front of it.
drop hidden samples off Leave out samples behind an opaque one (smaller, same picture).

Deep Omit

Type name: DeepOmit (scripts, MCP and Nuke import use it).

Keeps the deep samples by a depth keyer (0 outside its ramps drops them).

Inputs: input (deep).

Setting Default Range or choices What it does
mix 1 0 to 1 How much of the result shows over the input: 0 is the input, 1 the full effect.
zmap from 0 0 to 100 The depth where the keyer starts rising from 0 (a sample keyed 0 is dropped).
zmap full 0 0 to 100 The depth where the keyer reaches 1.
zmap full to 0 0 to 100 The depth where the keyer starts falling from 1.
zmap to 0 0 to 100 The depth where the keyer is back to 0 (a sample keyed 0 is dropped).
limit z off Kept for Nuke scripts, not used.

Deep Read

Type name: DeepRead (scripts, MCP and Nuke import use it).

Reads a deep OpenEXR file or sequence (#### or %04d for the frame number).

Inputs: none (it makes its own picture).

Setting Default Range or choices What it does
file The deep EXR, optionally with a frame placeholder (####, %04d).

Deep Recolor

Type name: DeepRecolor (scripts, MCP and Nuke import use it).

Gives a deep image's samples the colour of a flat image (a render's beauty on its deep samples).

Inputs: depth (deep), color.

Setting Default Range or choices What it does
channels rgb rgb, rgba, all The flat image's channels put on the samples (or a layer: mask); the samples keep their others.
target input alpha off Scale the samples' alphas so it flattens to the colour input's alpha.

Deep Reformat

Type name: DeepReformat (scripts, MCP and Nuke import use it).

A deep image to a new format or scale (each new pixel takes the input pixel's samples under it).

Inputs: input (deep).

Setting Default Range or choices What it does
type to format to format, scale to format: a new width and height; scale: the format times a factor.
width 1920 1 to 4096 New format width.
height 1080 1 to 4096 New format height.
scale 1 0.1 to 4 Format times this.
resize width none, width, height, fit, fill, distort How the image fits the new format, as Reformat's.
center on Centre the image in the new format; off: bottom-left corners meet.
flip off Upside down.
flop off Mirrored left to right.

Deep Sample

Type name: DeepSample (scripts, MCP and Nuke import use it).

Lists the deep samples under a point (its handle in the viewer), front to back.

Inputs: input (deep).

Setting Default Range or choices What it does
pos x 960 0 to 4096 The point whose samples are listed, x in pixels (the handle in the viewer).
pos y 540 0 to 4096 The point whose samples are listed, y in pixels.

Deep Shift

Type name: DeepShift (scripts, MCP and Nuke import use it).

Moves deep samples across the frame and in depth (z + translate z) / zscale.

Inputs: input (deep), mask (optional).

Setting Default Range or choices What it does
translate x 0 -100 to 100 Moves the picture across, in pixels.
translate y 0 -100 to 100 Moves the picture up, in pixels.
translate z 0 -100 to 100 Added to every sample's depth (before the z scale).
zscale 1 0 to 10 Divides every sample's depth after the translate (0 counts as 1).
mask channel alpha The mask input's channel that scales the change of depth per pixel.

Deep To Image

Type name: DeepToImage (scripts, MCP and Nuke import use it).

Flattens a deep image: its samples composited front to back.

Inputs: deep (deep).

Setting Default Range or choices What it does
volumetric composition on Split overlapping volume samples and merge them before compositing (off: each sample whole, in depth order).

Deep Transform

Type name: DeepTransform (scripts, MCP and Nuke import use it).

Moves deep samples across the frame and in depth, and scales their depth.

Inputs: input (deep).

Setting Default Range or choices What it does
translate x 0 -1000 to 1000 Pixels (rounded to whole ones).
translate y 0 -1000 to 1000 Pixels (rounded to whole ones).
translate z 0 -100 to 100 Added to every sample's depth.
zscale 1 0 to 10 Every sample's depth multiplied (before z).

Deep Volume Maker

Type name: DeepVolumeMaker (scripts, MCP and Nuke import use it).

A deep volume over the format: slices across a depth range, together half opaque.

Inputs: none (it makes its own picture).

Setting Default Range or choices What it does
samples 1000 1 to 1000 The number of slices in each pixel; together they are half opaque.
range from 100 0 to 1000 The depth where the volume starts.
range to 200 0 to 1000 The depth where the volume ends.

Deep Write

Type name: DeepWrite (scripts, MCP and Nuke import use it).

Writes a deep image to deep OpenEXR files (Render, as a Write).

Inputs: input (deep).

Setting Default Range or choices What it does
file The .exr to write, with #### or %04d for the frame number.
channels rgba rgba, all rgba: the colour, alpha and depths; all: every channel of the samples.
compression Zip (1 scanline) none, Zip (1 scanline), RLE Deep OpenEXR compression (Nuke's): all lossless.
first 1 0 to 1000 The first frame (with limit to range).
last 1 0 to 1000 The last frame (with limit to range).
limit to range off Write first..last instead of the project's range.

TimeToDepth

The picture as deep volume slices from zmin to zmax, its alpha split between them.

Inputs: input.

Setting Default Range or choices What it does
samples 5 1 to 10 The number of deep slices each pixel is split into.
frame range 1 0 to 100 Kept for Nuke scripts (see docs/nuke-compat.md).
range last 9 0 to 100 Kept for Nuke scripts (see docs/nuke-compat.md).
premult on Each slice's colour times its alpha (off: the colour is also divided by the input's alpha).
split alpha mode multiplicative additive, multiplicative How the alpha is shared: additive gives each slice alpha / samples; multiplicative gives each 1 - (1 - alpha)^(1/samples), so the slices over each other give the alpha back.
zmin 1 0 to 10 The depth where the first slice starts.
zmax 2 0 to 10 The depth where the last slice ends.