Read

This node loads images from disk, using the native resolution and the frame range for the sequence. It converts all imported sequences to Nuke’s native 32-bit linear RGB colorspace.

The Read node supports multiple file formats, such as Cineon, TIFF, Alembic, PSD, OpenEXR, HDRI, DPX, R3D, ARRIRAW, DNG, and RAW camera data. It uses the file name extension to determine the format.

You can also create a Read node by pressing R on the Node Graph.

See also DeepRead, ReadGeo, AudioRead, and UDIM Import.

Inputs and Controls

Control (UI)

Knob (Scripting)

Default Value

Function

Read Tab

File

file

dependent on file

Sets the file path and name of the file to read. For frame numbers, you can use #### for each digit or the printf-style formatting %04d.

Localization Policy

localizationPolicy

from auto-localize path

Sets the local file caching behavior. Copies of the files are stored in a specified local folder for faster access times:

on - the files are cached, regardless of location, as long as the limit to (GB) limit is not breached.

from auto-localize path - the files are cached if they reside in the auto-localize from directory, as long as the limit to (GB) limit is not breached.

on demand - only localize these source clips when you manually update them. See Localizing Files for Better Performance for more information.

off - the files are never cached, regardless of location.

Update

updateLocalization

N/A

When this Read node is set to Localization Policy > on demand, click Update to manually localize the files from the source files.

Format

format

dependent on file

Sets the size of the file. Typically it is guessed correctly from the file header, but you can change it to set a different pixel aspect ratio if required.

Proxy

proxy

none

Sets the file path and name of a relevant proxy image. This proxy image is used if proxy mode is on and the required resolution is less than or equal to the proxy format.

Proxy Format

proxy_format

1024x778

The file specified in proxy is read if the down-rez of the format is smaller or equal to this value. Typically it is guessed correctly from the file header, but you can change it to set a different pixel aspect ratio if required.

Frame Range

first

dependent on file

The first frame number of a sequence to display.

before

hold

Sets the behavior of frames before the first frame specified:

hold - select to show a still picture of the first frame of the frame range.

loop - select to start over and keep looping the span of the frame range outside the first frame of the frame range.

bounce - select to play the span of the frame range backwards and forwards between the frame range limits.

black - select to display a black frame outside of the first frame.

last

dependent on file

The last frame number of a sequence to display.

after

hold

Sets the behavior of frames after the last frame specified:

hold - select to show a still picture of the last frame of the frame range.

loop - select to start over and keep looping the span of the frame range outside the last frame of the frame range.

bounce - select to play the span of the frame range backwards and forwards between the frame range limits.

black - select to display a black frame outside of the last frame.

Frame

frame_mode

expression

Sets the frame mode:

expression - Lets you enter an expression in the field on the right. The expression changes the relation between the current frame and the frame read in. For example, if your clip begins from image.0500.rgb and you want to place this first frame at frame 1 rather than frame 500, you can use the expression frame+499. This way, 499 frames are added to the current frame to get the number of the frame that’s read in. At frame 1, image.0500.rgb is read in; at frame 2, image.0501.rgb is read in; and so on. Another example of an expression is frame*2. This expression multiplies the current frame by two to get the number of the frame that’s read in. This way, only every other frame in the clip is used. At frame 1, image.0002.rgb is read in; at frame 2, image.0004.rgb is read in; at frame 3, image.0006.rgb is read in; and so on.

startat - Lets you enter a start frame number in the field on the right. This specifies the frame where the first frame in the sequence is read in. In other words, all frames are offset so that the clip starts at the specified frame. For example, if your sequence begins from image.0500.rgb and you enter 1 in the field, image0500.rgb is read in at frame 1. Similarly, if you enter 100 in the field, image0500.rgb is read in at frame 100.

offset - Lets you enter a constant offset in the field on the right. This constant value is added to the current frame to get the number of the frame that’s read in. For example, if your clip begins from image.0500.rgb and you want to place this first frame at frame 1 rather than frame 500, you can use 499 as the constant offset. This way, 499 is added to the current frame to get the frame that’s read in. At frame 1, image.0500.rgb is read in; at frame 2, image.0501 is read in, and so on. You can also use negative values as the constant offset. For example, if you use the value -10, Nuke will subtract ten from the current frame to get the frame that’s read in. At frame 20, image.0010.rgb is read in; at frame 21, image.0011.rgb is read in; and so on.

frame

none

Depending on the frame mode, you can enter a start frame, an offset, or an expression here.

Original Range

origfirst

dependent on file

Displays the original first frame.

origlast

dependent on file

Displays the original last frame.

Missing Frames

on_error

error

Sets Nuke’s behavior when there is a problem with frames in the file:

error - display an error in the Viewer.

black - replace suspect frames with a black frame.

checkerboard - replace suspect frames with a checkerboard.

nearestframe - replace suspect frames with the nearest good frame.

reload

reload

N/A

Click to re-read the image from disk.

Colorspace

colorspace

dependent on file

Sets the lookup table (LUT) used to convert from this file to the internal values used by Nuke.

default determines the LUT from the size and type of data in the file, and other information from the file header.

Premultiplied

premultiplied

disabled

When enabled, Nuke corrects the color of the partially transparent pixels produced by most renderers by dividing color data by the alpha channel before converting from the colorspace, and then multiplying by the alpha channel afterwards.

Raw Data

raw

disabled

When enabled, Nuke does not convert the data.

For most file formats this is the same as linear colorspace but, for some, it may disable other processing such as conversion from YUV.

Auto Alpha

auto_alpha

disabled

When enabled, if the Read produces RGB but no alpha channel, then assume the alpha should be 1 if it's requested later on.

OCIO Tab

Context

key1

key1

none

OCIO Contexts allow you to apply specific LUTs to individual shots.

See Changing the Viewer Color Space for more information.

value1

value1

none

key2

key2

none

value2

value2

none

key3

key3

none

value3

value3

none

key4

key4

none

value4

value4

none

Sequence Tab

import sequence

import sequence

N/A

Click to display a browser to locate an import sequence script which builds a frame sequence list from the contents of an EDL file.

These are not standard EDL files, such as CMX. Each line in the file simply defines a separate image sequence to import in the form:

imagesequence.%04d.ext in out head tail

Where in and out are the start/end frame numbers of the clip and head/tail are the number of frames to trim from the start and end.

Each sequence in the list is expanded into the sequence control so that each line contains the name of the file to read for that frame:

line 1 = frame 1, line 10 = frame 10.

Finally, the script replaces the Read > file text with:

[lindex [knob sequence] [frame]]

This looks up the file name from the sequence control and sets the first frame to 1 through to the last frame in the expanded list.

frame sequence

sequence

none

Most easily used in conjunction with the import sequence button. Each line contains the name of the file to read for that frame:

line 1 = frame 1, line 10 = frame 10.

Set the Read > file control to [lindex [knob sequence] [frame]] to look up the file name from this control. This allows you to use a single Read to access multiple sequences of files where the naming does not follow any set numeric sequence, rather than using multiple Read nodes with a single file sequence per Read.

Metadata Tab

metadata viewer

shownmetadata

N/A

Displays the metadata of any file read in using a Read node. Once you know which keys exist in the file, you can reference them in expressions.

The metadata displayed depends on the file type. For example, a .jpg might only contain input/ keys, whereas QuickTimes contain input/ and quicktime/ keys.

search metadata for

metadatafilter

N/A

Filter the metadata by entering text in this field. By default, only metadata containing the keys and values entered are displayed. You can change this behavior using the within control.

File Type Specific Controls

These controls are context sensitive depending on which format you intend to render out.

ARI

Control (UI)

Knob (Scripting)

Default Value

Function

ARI Options (ARI and MXF)

Load settings from metadata

arriReset

N/A

Click to reset the ARI Options to those from the file metadata.

Local GPU

arriLocalGPUName

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 default blink 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, if available, by navigating to the Preferences and selecting an alternative from the default blink device dropdown.

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

Use GPU if available

arriUseCuda

disabled

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.

Clip Settings

Colorspace

arriColorspace

dependent on clip

Sets the colorspace used to convert from raw data into the Viewer colorspace.

Exposure Index (ISO)

arriExposureIndex

Sets the overall sensitivity of pixels from the raw image.

White Balance (K)

arriWhiteBalance

Controls the relative RGB coolness and warmth. Higher values increase the warmth.

Tint

arriTint

Adjusts the level of tints to compliment the White Balance control.

Lens Squeeze

arriLensSqueeze

Sets the amount of anamorphic lens squeeze applied to the image.

Unsqueeze Anamorphic

arriUnsqueezeAnamorphic

disabled

When enabled, unsqueezes the raw file while converting it to the Viewer colorspace.

Note:  This control is generally not required because the file metadata sets the pixel aspect ratio automatically.

Processing

Debayer Mode

arriDebayerMode

dependent on clip

Sets the debayering mode applied to reads. If Proxy Playback is enabled, the debayer is ignored.

ADA 5 Fine-tuning

arriAda5FinetuningRed

arriAda5FinetuningGreen

arriAda5FinetuningBlue

Fine-tunes the ADA 5 debayering in the red, green, and blue channels.

Aspect Ratio

arriAspectRatio

Sets the output aspect ratio independent of the pixel aspect ratio.

Resolution

arriResolution

Set the resolution and aspect ratio that the clip is scaled to, cropping the image if required.

Sharpness

arriSharpness

Adjusts the sharpness of the image by introducing contrast at edges.

Detail

arriDetail

Adjusts the amount of detail by affecting fine structures.

Note:  The Detail control can introduce aliasing at higher values.

Look Editor

Use Look Editor

arriUseLookEditor

enabled

When enabled, the Look Editor settings can be used to modify the image.

Note:  The Look Editor settings cannot be enabled when the Colorspace control is set to LogC or Scene Linear. Only Video color spaces use Look Editor settings.

Saturation

arriSaturation

1

Increases or decreases the overall saturation of the image.

Slope/Offset/Power

Slope

arriSlope

1,1,1

Adjusts overall the Slope, Offset, and Power.

Offset

arriOffset

0,0,0

Power

arriPower

1,1,1

Proxy Playback

arriProxyPlayback

Off

Setting proxy to anything other than Off speeds up read times, but the Debayer Mode is ignored.

DNG

Control (UI)

Knob (Scripting)

Default Value

Function

DNG Options

color space

dng_colorspace

sRGB

Sets the colorspace used during debayering. The standard Read node colorspace control is changed to match this setting automatically.

Note:  To view the data before debayering, enable the raw data control.

force linear transfer function

dng_force_linear

disabled

When enabled, overrides the specified color space transfer function to force it to use linear.

For some cases, such as sRGB, this results in slightly faster read times and sets the colorspace on the Read to linear as well.

As a result of forcing linear, all render settings are applied in linear space, rather than the native space, so there may be differences in how the controls respond.

white balance

dng_white_balance

As Shot

Applies preset values to the temperature and tint controls, depending on the setting chosen:

As Shot - attempts to read the temperature and tint values from the source file's metadata.

Daylight to Flash - standard presets in common usage.

Custom - adjusting the temperature and tint controls manually sets white balance to this value.

temperature

dng_temperature

dependent on file

Defines the temperature, in Kelvin, and tint of the image white point:

temperature - in general, runs from blues at low values to yellows at high values.

tint - in general, runs from greens at low values to purples at high values.

tint

dng_tint

exposure

dng_exposure

0

Controls the amount of exposure data available on top of the baseline exposure.

shadows

dng_shadows

0

Controls the amount of low-level image data available at render time.

EXR

Control (UI)

Knob (Scripting)

Default Value

Function

EXR Options

offset negative display window

offset_negative_display_window

enabled

The .exr format allows the image’s lower left corner to start at any position, including negative x axis values. Nuke does not support this type of format, but compensates by offsetting the image or reducing the format size on both sides:

enabled - the image is offset so that the .exr image’s left side start at x=0.

disabled - the format is reduced on both sides by the negative x amount, as if that area was overscan.

do not attach prefix

noprefix

disabled

When enabled, metadata keys are read as they are, without attaching a prefix to them.

When disabled, the prefix exr is attached to metadata keys to make them distinct from other metadata in the tree.

edge pixels

edge_pixels

plate detect

Sets how to treat pixels at the edges of the data window, or bounding box in Nuke terms, when reading .exr files:

plate detect - if the bounding box and format match exactly, then repeat all edges. Otherwise, add black at the edges.

edge detect - for each matching edge, repeat the edge pixels. Add black at mismatched edges.

repeat - always repeat the edge pixels outside the bounding box.

black - always add black pixels outside the bounding box.

MOV

Control (UI)

Knob (Scripting)

Default Value

Function

MOV Options

Note:  The mov32Reader and Writer has been removed for macOS Catalina (10.15) and deprecated under Windows, Linux, and macOS Mojave (10.14). The mov32: prefix is still currently available on deprecated OS, but unsupported. We recommend using the standard Nuke Read/Write controls, as mov32 is scheduled for removal in a future release.

YCbCr matrix

mov64_ycbcr_matrix

dependent on the file

Sets the way Y’CbCr is converted to RGB. Rec 601 and Rec 709 follow the ITU.BC specifications.

Data Range

mov64_decode_video_levels

default

Sets the minimum and maximum color range values for decoded DNxHD files. If your source file was encoded with a reduced range (0-240 for 8-bit or 0-960 for 10-bit), set source range to Video Range to decode the full range (0-255 for 8-bit or 0-1023 for 10-bit).

first track only

mov64_first_track_only

enabled

When enabled, only the first view present in the file is displayed, regardless of how many views the file contains.

When disabled, and there is more than one view set up in the project settings, you can switch between views using the buttons above the Viewer.

[Metadata] Do not attach prefix

mov64_no_prefix

disabled

When enabled, the metadata accompanying the file is saved without the quicktime prefix.

Note:  QuickTime container-specific metadata always carries the prefix.

When disabled, all metadata is prefixed with quicktime for easy identification.

[Metadata] Match key format

mov64_match_meta_format

enabled

When enabled, Nuke attempts to clean up meta keys into the standard Nuke metadata format.

When disabled, the metadata is passed down the Node Graph unchanged.

Video Codec

mov64_codec_name

N/A

Displays the codec used to encode the clip.

PSD

Control (UI)

Knob (Scripting)

Default Value

Function

PSD Options

Breakout Layers

breakout

N/A

Breaks out the .psd file into separate layers and recombines them with a number of PSDmerge nodes. The blend modes/operations in the merge nodes are approximated and do not match Photoshop® exactly.

It’s recommended that all masks and adjustment layers are rasterized in Photoshop® before they’re imported into Nuke.

R3D

Control (UI)

Knob (Scripting)

Default Value

Function

R3D Options

Image Pipeline

r3dImagePipeline

dependent on file

Sets the image pipeline to use in the Read node, IPP2, IPP2 Custom, or legacy. The selected Image Pipeline defines which controls are available in the Properties panel and is initially set by the file's metadata.

See IPP2 Controls and Legacy Controls.

Load Settings from RMD

r3dLoadRMD

N/A

Click to reload control values from the .rmd file metadata.

Local GPU

r3dLocalGPUName

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 default blink 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, if available, by navigating to the Preferences and selecting an alternative from the default blink device dropdown.

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

Use GPU if available

r3dUseCUDA

disabled

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.

Decoding

Decode Resolution

r3dDecodeResolution

full high

Sets the output resolution decoded from the source file. High quality takes longer to decode.

Rocket Resolution

r3dRocketResolution

dependent on format

When Decode Resolution is set to rocket custom, sets the resolution values if you're using a Red Rocket card for decoding. The default values are equal to the source image.

Use ROCKET

r3dUseROCKET

disabled

When enabled, an installed Red Rocket card is used for decoding if available.

HDRx

HDR Mode

r3dHDRMode

A frame

Sets how the high and low exposure tracks are blended for HDR clips:

A frame - only displays the normally exposed track with standard motion blur.

X frame - only displays the under exposed, sharper reference track.

simple blend - enables the Blend Bias control allowing you to blend of high and low exposure according to the bias.

magic motion - a more sophisticated automatic blend mode with a sharper image and more natural motion blur.

Blend Bias

r3dBlendBias

0

When HDR Mode is set to simple blend, controls the bias between low and standard exposure values, where -1 is fully the X frame and +1 is fully the A frame.

IPP2 Controls

Demosaic

Denoise

r3dIPP2Denoise

0

Controls the amount of noise reduction applied to the image if Chroma Noise Reduction is disabled.

Chroma Noise Reduction

r3dIPP2Cnr

enabled

When enabled, applies chroma noise reduction instead of the standard .r3d Denoise.

Note:  Chroma Noise Reduction is only available with Decode Resolution set to full high or half high.

Primary

Color Space

r3dIPP2Colorspace

REDWideGamutRGB

This control is display only for the IPP2 Image Pipeline.

Gamma Curve

r3dIPP2GammaCurve

Log3G10

This control is display only for the IPP2 Image Pipeline.

ISO

r3dIPP2ISO

800

Sets the overall sensitivity of pixels from the raw image.

Exposure Adjust

r3dExposureAdjust

0

Increases or decreases the overall exposure. This control is identical to FLUT Control in the legacy Image Pipeline.

Kelvin

r3dIPP2Kelvin

5600

Controls the relative RGB coolness and warmth. Higher values increase the warmth.

Tint

r3dIPP2Tint

0

Adjusts the level of yellow and green tints. This control can help in environments where the ambient light source contains high levels of yellow and green, such as fluorescent lights.

Grading

3D LUT

r3d3DLUT

N/A

Specifies the path to a LUT file.

Enable 3D LUT

r3dEnable3DLUT

disabled

When enabled, the LUT file specified in the 3D LUT field is applied to the image.

CDL

r3dCDL

N/A

Specifies the path to an ASC CDL file.

CC ID

r3dCCID

N/A

Specifies which color correction should be applied from CDL files containing more than one correction.

Enable CDL

r3dEnableCdl

N/A

When enabled, the CDL file specified in the CDL field is applied to the image.

Slope

r3dSlope

1,1,1,0

Adjusts the Slope, Offset, Power, and Saturation manually.

If you have applied a CDL to the image, these values are set from the selected CC ID.

 

Offset

r3dOffset

0,0,0,0

Power

r3dPower

1,1,1,0

Saturation

r3dCDLSaturation

1

Contrast

r3dIPP2Contrast

0

Increases or decreases the overall contrast.

Note:  Contrast is disabled when Gamma Curve is set to Half Float Linear.

Export Pipeline

r3dExportPipeline

full graded IPP2 mode

Controls whether or not creative color decisions are applied on export:

primary raw development - all Grading settings are ignored on export.

full graded IPP2 mode - all Grading settings are applied on export.

Legacy Controls

Look

Color Version

r3dColorVersion

v2

Sets the color version used by the decoder.

Color Space

r3dColorSpace

dependent on clip

Sets the colorspace used to convert from raw data into the Viewer colorspace.

Note:  Colorspaces listed in brackets are deprecated in the current R3D SDK and may be removed in subsequent releases.

Gamma Curve

r3dGammaCurve

dependent on clip

Sets the gamma curve applied to the raw image data from the .r3d file.

Note:  Gamma Curves listed in brackets are deprecated in the current R3D SDK and may be removed in subsequent releases.

D.E.B.

r3dDEB

enabled

When enabled, reduces the red grain that can affect midtones, darks, and shadows using DRAGON Enhanced Blacks.

Note:  D.E.B. is only available for clips shot with a DRAGON sensor, or later, with Decode Resolution set to full high or half high.

Kelvin

r3dKelvin

5600

Controls the relative RGB coolness and warmth. Higher values increase the warmth.

Tint

r3dTint

0

Adjusts the level of yellow and green tints. This control can help in environments where the ambient light source contains high levels of yellow and green, such as fluorescent lights.

ISO

r3dISO

800

Sets the overall sensitivity of pixels from the raw image.

FLUT Control

r3dFLUTControl

0

Allows you to adjust the ISO value without clipping highlights or crushing shadows.

Note:  FLUT Control is only available with Color Version v2 or higher.

Shadow

r3dShadow

0

Sets the image black point.

Note:  Shadow is only available with Color Version v2 or higher. Setting Gamma Curve to Half Float Linear disables Shadow.

DRX

r3dDRX

0

Dynamic Range Extension (DRX) can be adjusted to recover clipped highlights.

Note:  DRX is disabled for clips shot with a DRAGON sensor.

Saturation

r3dSaturation

1

Increases or decreases the overall saturation, contrast, and brightness of the image.

Contrast

r3dContrast

0

Contrast

Brightness

r3dBrightness

0

Brightness

Note:  Saturation, Contrast, and Brightness are disabled when Gamma Curve is set to Half Float Linear.

Exposure

r3dExposure

0

Increases or decreases the overall exposure.

RGB

r3dRGBGain

1,1,1

Increases or decreases the gain for the red, green, and blue channels.

Note:  RGB gain is disabled when Gamma Curve is set to Half Float Linear.

Sharpness

r3dSharpness

0

Sharpens the image to compensate for the OLPF low pass filter.

Note:  Sharpness is only applicable when Decode Resolution is set to full high or half high.

Denoise

r3dDenoise

0

Controls the amount of noise reduction applied to the image.

Detail

r3dDetail

2

Sets the amount of detail extracted from the image, separate from the Sharpness control.

Note:  Denoise and Detail are only applicable when Decode Resolution is set to full high.

Lift/Gamma/Gain

Lift

r3dLift

0,0,0,0

Adjusts the overall black level (dark tones and shadows).

Gamma

r3dGamma

1,1,1,0

Adjusts the overall mid tones.

Gain

r3dGain

1,1,1,0

Adjusts the overall highlights.

Note:  Lift, Gamma, and Gain are only available with Color Version v2 or higher. Setting Gamma Curve to Half Float Linear disables Lift, Gamma, and Gain.

Step-by-Step Guides

Loading Image Sequences

Video Tutorials

Related Topics Link IconRelated Topics