Method

This node is used to read colour and depth data from a Kinect Or RealSense camera. This node carries both colour and depth information. Post Effect nodes and Video Processing nodes attached to this node will operate on the colour data only, unless specifically designed to read the depth data – such as the Depth Camera / Kinect Colour Key node. The RGB channel is read from the camera directly, or set to white if the camera does not provide colour data. The alpha channel is set to a mask value based on the depth, using the near and far clip plane parameters. If “Output Depth” is selected the depth data is output in the colour channel as luminance values.

Where multiple Kinect cameras are connected they may be selected via the “Kinect Camera Index” parameter. A pre-recorded stream may be used instead of live Kinect camera data by setting its resource via the Kinect Stream parameter.
Multiple Nodes can be used for streaming both Kinect 2 and Kinect 4 sources together on the same PC.

For the output node to work, the correct sensor type has to be selected and enabled within Devices/VideoIn/Kinect settings.

When Kinect 4 Sensor Type is selected, additional options are enabled: Depth Sensor Mode and Colour Sensor Mode as Kinect 4 supports a number of range/FOV and colour sensor resolutions. Typically Near/narrow range/FOV depth modes have lower noise characteristics and therefore higher quality than Far/Wide range/FOV depth modes.

Colour modes supported on Kinect 4 can go up to 3072p 4k resolution but the higher the resolution the higher real-time cost. We recommend 1080p colour resolution for real-time.

You can find out more about setting up notch for Kinect here.

Attributes

Name Description
Preview In Viewport Preview the effect blended with alpha in the viewport.
Preview RGB In Viewport Preview the RGB values in the viewport.
Preview Alpha In Viewport Preview the alpha values in the viewport.
Depth Sensor Mode (Kinect 4 only) The depth sensor mode affecting range and FOV
Colour Sensor Mode (Kinect 4 only) The colour sensor mode affecting resolution of Colour sensor output
Near Clip Plane The closest distance that will be rendered. NB: Reducing this value too low can reduce the accuracy of aspects of the render.
Far Clip Plane The furthest distance that will be rendered by this camera. NB: Increasing this value too high, without increasing the Near Clip, can reduce the accuracy of aspects of the render.
Depth Clip Hardness How harsh the falloff is for depth data.
Edge Fade Width Refinement width for depth edge mask
Kinect Depth Scale Scaling of the Kinect Z depth
Colour Image Offset X/Y Manual alignment of the colour image to align with depth.
Output Depth Toggle whether only the depth image is output.
Camera Type Choose the camera type: Kinect 1, Kinect 2, Kinect 4, Realsense, Realsense 2 or First Detected to choose the first sensor Notch detects (has specific sensor type ordering)
Camera Index Choose which Kinect sensor to use as a source.
Kinect Stream Choose which Kinect stream to use as source.
Align Colour And Depth Attempts to align the Colour and Depth data so they match when generated into a surface.
Canvas Width The width of the source image.
Canvas Height The height of the source image.
Auto Offset Automatically offset the output image.
Hole Fill Iterations How many iterations will be made to fill gaps in the Kinect image.

Filtering

Name Description
Kinect Alpha Mask Disparity Cutoff (Kinect 2 only) The cut off point for the alpha mask of the kinects disparity.
Depth Edge Dilation Passes Number of dilation passes to fill in the edge of the depth mask, useful for Kinect 2 depth refinement due to noise statistic of the sensor.
Visualize Targets Turn on visualization of Colour, Depth and Depth disparity mask within the viewport when node is selected.
Temporal Filter Depth Turn on temporal averaging to reduce sensor noise from the resulting depth image.

Stream Attributes

Name Description
Stream Start Frame Select the stream start frame.
Stream End Frame Select the stream end frame.
Stream Frame Rate Change the frame rate of the stream.

Inputs

Name Description Typical Node Input
Effect Mask Mask out areas the effect wont affect the image. Image Plane
Alpha Image Add an image to control the alpha values of the image. Video Loader

Outputs

The outputs section for this node is currently being worked on.