You are here: Reference Guide > Filter Nodes > Bilateral

Bilateral

A bilateral filter is a smoothing filter that is particularly good at preserving edges, though it can be computationally expensive.

Inputs and Controls

Connection Type	Connection Name	Function
Input	unnamed	The image sequence to filter.
mask	An optional image to use as a mask. By default, the filter effect is limited to the non-black areas of the mask. At first, the mask input appears as triangle on the right side of the node, but when you drag it, it turns into an arrow labeled mask. If you cannot see the mask input, ensure that the mask control is disabled or set to none.

Connection Type

Connection Name

Function

Input

unnamed

The image sequence to filter.

mask

An optional image to use as a mask. By default, the filter effect is limited to the non-black areas of the mask.

At first, the mask input appears as triangle on the right side of the node, but when you drag it, it turns into an arrow labeled mask. If you cannot see the mask input, ensure that the mask control is disabled or set to none.

Control (UI)	Knob (Scripting)	Default Value	Function
Bilateral Tab
size (w, h)	size	3	Sets the height and width of the area within which pixels are compared to calculate the blur. Higher values widen the compare area, producing greater effect.
Positional Sigma	PositionalSigma	0.4	Controls the amount that nearby pixels affect the overall blur.
Color Sigma	ColorSigma	0.4	Controls the amount of blur that occurs over edges in the image, lower values preserve edges more reliably.
mask	N/A	disabled	Enables the associated mask channel to the right. Disabling this checkbox is the same as setting the channel to none.
mask	maskChannelInput	none	The channel to use as a mask. By default, the filter effect is limited to the non-black areas of this channel.
inject	inject	disabled	Copies the mask input to the predefined mask.a channel. Injecting the mask allows you to use the same mask further downstream.
invert	invert_mask	disabled	Inverts the use of the mask channel so that the filter effect is limited to the non-white areas of the mask.
fringe	fringe	disabled	Blurs the edges of the mask.
mix	mix	1	Dissolves between the original image at 0 and the full effect at 1.