Swirl Copernicus node

Twists an image layer into a spiral shape.

On this page	Parameters Uniform controls Random controls Swirl Match Attributes Names Inputs Outputs
Since	21.0

This node twists an image layer into a spiral shape. The node supports multiple deformation regions (swirls) through either the Swirl parameters or a geometry layer when you wire in a points input. Wire additional mono layers into the other inputs to further configure these regions. Noise layers, such as Fractal Noise, can introduce organic variations through randomized parameters.

When you wire geometry into the points input, the Match Attributes Names parameters replace the Swirl parameters. The default values in the string fields correspond to the internal names of the Swirl parameters, and all scale values default to 1 unless overridden by attributes. Use custom point attributes to control the scale of each parameter for each swirl’s center. If you replace a default parameter name with a custom attribute name, the node uses that attribute’s value as a scale for each point. For example, set Strength to pscale to drive the strength scale for each point by the pscale attribute.

For example, use this node to create natural forms such as tides, tree knots, or lichens on rocks.

Parameters ¶

Signature

The layer type that the source accepts.

See Signatures for more information.

Wrap Mode

The wrapping behavior of the deformation at the boundary.

Auto

Inherits the wrap mode setting from the input layer.

Off

Clamps deformation at the boundary.

Wraps deformation at the boundary.

Tile Size

The size of the base deformation region.

Parameter Mode

Set whether to use the uniform or random parameters.

Uniform

Use the uniform parameter controls.

Random

Activate random variation for parameters, which the standard deviation controls. This adds natural variation when applying the effect to multiple swirl centers.

Uniform controls ¶

Translation

The amount in image space to translate the deformation regions.

Strength

The strength with which to apply the spiral deformation. Positive values create a counterclockwise spiral and negative values create a clockwise spiral.

Bulge

The amount of deformation to apply along radial directions from the center. This produces lens distortion deformation.

Radius

The radius of the deformation, which defines the actual distance from each swirl’s center in image space.

Blend Region

The radius of the blended region between the deformed area and the background. This specifies the distance (in image space) from the boundary that the Radius parameter defines.

Rotate

The amount in degrees to rotate the areas that the Bulge and Strength parameters deform. This parameter allows for full control over the ellipses orientation.

Roundness

The elliptical shape of the deformation. A value of 1 produces a circular (disk-shaped) deformation. Values less than 1 create elliptical shapes, where the Y-axis is the semi-major axis and the X-axis is the semi-minor axis.

Random controls ¶

Seed

The seed used to generate the random numbers.

Central Position

The center point (mean) of the random position offsets.

Central Value

The center point (mean) of the randomized swirl parameters.

Scatter

The standard deviation of randomized parameter offsets.

Swirl ¶

Number of Points

The number of swirl centers, and therefore swirls.

Position #

The position of an individual swirl’s center.

Strength Scale #

The amount to scale the strength of an individual swirl’s center.

Bulge Scale #

The amount to scale the bulge of an individual swirl’s center.

Radius Scale #

The amount to scale the radius of an individual swirl’s center.

Blend Region Scale #

The amount to scale the blend region of an individual swirl’s center.

Rotate Scale #

The amount to scale the rotation of an individual swirl’s center.

Roundness Scale #

The amount to scale the roundness of an individual swirl’s center.

Match Attributes Names ¶

Strength

The attribute name to use for the strength scale.

Bulge

The attribute name to use for the bulge scale.

Radius

The attribute name to use for the radius scale.

Blend Region

The attribute name to use for the blend scale.

Rotate

The attribute name to use for the rotate scale.

Roundness

The attribute name to use for the roundness scale.

Inputs ¶

size_ref

A representative layer that determines the size of the output image and controls the metadata.

source

The layer to twist into a spiral shape.

points

A geometry layer to control swirl centers and scale parameters. When wired in, the Match Attributes Names parameters replace the Swirl parameters.

stength

An optional layer that controls the strength scale. The node samples the value at each swirl center’s position.

bulge

An optional layer that controls the bulge scale. The node samples the value at each swirl center’s position.

radius

An optional layer that controls the radius scale. The node samples the value at each swirl center’s position.

blendregion

An optional layer that controls the blend region scale. The node samples the value at each swirl center’s position.

rotate

An optional layer that controls the rotate scale. The node samples the value at each swirl center’s position.

roundness

An optional layer that controls the roundness scale. The node samples the value at each swirl center’s position.

Outputs ¶

swirl

The spiraled image.

mask

The layer that separates the spiraled regions from the background.