Artifact 9538f12f196b43463cd552fb70778f3e4c4690d4f3a0119bc08174bbff4a5101:
- File doc/ref/transform_effect.md — part of check-in [cc363bac05] at 2024-12-12 23:11:15 on branch trunk — chore: regenerated embedded documentation. tweak: package builder to update the doc/ref add/miss information. (user: aku size: 17655)

| Project ↗ | Documentation ↗ | — | Tutorials ↗ | How To's ↗ | Explanations ↗ | References |
| Entry ↗ | — | Sections ↘ | Permuted Sections ↘ | Names ↘ | Permuted Names ↘ | Strict ↘ | Implementations ↘ |
Documentation -- Reference Pages -- transform effect
<anchor='top'> Table Of Contents
Operators
- aktive effect blur
- aktive effect charcoal
- aktive effect emboss
- aktive effect jitter gauss
- aktive effect jitter uniform
- aktive effect max-rgb
- aktive effect min-rgb
- aktive effect sharpen
- aktive effect sketch
- aktive effect swirl
- aktive effect wobble
Operators
↑ aktive effect blur
Syntax: aktive effect blur src ?(param value)...? [→ definition]
Returns blurred input, per the specified blur radius.
| Input | Description |
|---|---|
| src | Source image |
| Parameter | Type | Default | Description |
|---|---|---|---|
| radius | double | 2 | Blur kernel radius. Defaults to 2. |
Examples
| @1
|
aktive effect blur @1 radius 16
|
|---|---|
geometry(0 0 128 128 1) |
geometry(16 0 96 128 1) |
| @1
|
aktive effect blur @1 radius 16
|
|---|---|
geometry(0 0 128 128 1) |
geometry(16 0 96 128 1) |
↑ aktive effect charcoal
Syntax: aktive effect charcoal src ?(param value)...? [→ definition]
Returns a grey image with a charcoal-like sketch of the sRGB input.
| Input | Description |
|---|---|
| src | Source image |
| Parameter | Type | Default | Description |
|---|---|---|---|
| light | bool | no | Artistic choice between stronger and lighter sketch lines. |
Examples
| @1
(assets/butterfly.ppm) |
aktive effect charcoal @1
|
|---|---|
geometry(0 0 380 250 3) |
geometry(0 0 380 250 1) |
| @1
(assets/butterfly.ppm) |
aktive effect charcoal @1 light yes
|
|---|---|
geometry(0 0 380 250 3) |
geometry(0 0 380 250 1) |
↑ aktive effect emboss
Syntax: aktive effect emboss src [→ definition]
Returns embossed input.
| Input | Description |
|---|---|
| src | Source image |
Examples
| @1
|
aktive effect emboss @1
|
|---|---|
geometry(0 0 128 128 1) |
geometry(1 1 126 126 1) |
↑ aktive effect jitter gauss
Syntax: aktive effect jitter gauss src ?(param value)...? [→ definition]
Returns the input with a jitter effect based on gaussian noise applied to it. Visually this looks like frosted glass.
The underlying operation is aktive warp noise gauss.
| Input | Description |
|---|---|
| src | Source image |
| Parameter | Type | Default | Description |
|---|---|---|---|
| interpolate | str | bilinear | Interpolation method to use |
| seed | uint | [expr {int(4294967296*rand())}] | Randomizer seed. Needed only to force fixed results. |
| mean | double | 0 | Mean of the desired gauss distribution. |
| sigma | double | 1 | Sigma of the desired gauss distribution. |
Examples
| @1
|
aktive effect jitter gauss @1 sigma 4 seed 703011174
|
|---|---|
geometry(0 0 128 128 1) |
geometry(0 0 128 128 1) |
| @1
(assets/sines.ppm) |
aktive effect jitter gauss @1 sigma 4 seed 703011174
|
|---|---|
geometry(0 0 256 256 3) |
geometry(0 0 256 256 3) |
| @1
(assets/butterfly.ppm) |
aktive effect jitter gauss @1 sigma 4 seed 703011174
|
|---|---|
geometry(0 0 380 250 3) |
geometry(0 0 380 250 3) |
↑ aktive effect jitter uniform
Syntax: aktive effect jitter uniform src ?(param value)...? [→ definition]
Returns the input with a jitter effect based on uniform noise applied to it. Visually this looks like frosted glass.
The underlying operation is aktive warp noise uniform.
| Input | Description |
|---|---|
| src | Source image |
| Parameter | Type | Default | Description |
|---|---|---|---|
| interpolate | str | bilinear | Interpolation method to use |
| seed | uint | [expr {int(4294967296*rand())}] | Randomizer seed. Needed only to force fixed results. |
| min | double | 0 | Minimal noise value |
| max | double | 1 | Maximal noise value |
Examples
| @1
|
aktive effect jitter uniform @1 min 1 max 6 seed 703011174
|
|---|---|
geometry(0 0 128 128 1) |
geometry(0 0 128 128 1) |
| @1
(assets/sines.ppm) |
aktive effect jitter uniform @1 min 1 max 6 seed 703011174
|
|---|---|
geometry(0 0 256 256 3) |
geometry(0 0 256 256 3) |
| @1
(assets/butterfly.ppm) |
aktive effect jitter uniform @1 min 1 max 6 seed 703011174
|
|---|---|
geometry(0 0 380 250 3) |
geometry(0 0 380 250 3) |
↑ aktive effect max-rgb
Syntax: aktive effect max-rgb src [→ definition]
Returns an image suppressing at each pixel of the input the bands not reaching the max of the bands at that location.
For a single-band input this is a no-op.
Despite the use of rgb in the operator name this operator works on all multi-band images, regardless of the exact number or their semantic interpretation.
Idea from https://docs.gimp.org/2.8/en/plug-in-max-rgb.html
| Input | Description |
|---|---|
| src | Source image |
Examples
| @1
(assets/butterfly.ppm) |
aktive effect max-rgb @1
|
|---|---|
geometry(0 0 380 250 3) |
geometry(0 0 380 250 3) |
↑ aktive effect min-rgb
Syntax: aktive effect min-rgb src [→ definition]
Returns an image suppressing at each pixel of the input the bands not falling to the min of the bands at that location.
For a single-band input this is a no-op.
Despite the use of rgb in the operator name this operator works on all multi-band images, regardless of the exact number or their semantic interpretation.
Idea from https://docs.gimp.org/2.8/en/plug-in-max-rgb.html
| Input | Description |
|---|---|
| src | Source image |
Examples
| @1
(assets/butterfly.ppm) |
aktive effect min-rgb @1
|
|---|---|
geometry(0 0 380 250 3) |
geometry(0 0 380 250 3) |
↑ aktive effect sharpen
Syntax: aktive effect sharpen src [→ definition]
Returns sharpened input.
| Input | Description |
|---|---|
| src | Source image |
Examples
| @1
|
aktive effect sharpen @1
|
|---|---|
geometry(0 0 128 128 1) |
geometry(1 1 126 126 1) |
↑ aktive effect sketch
Syntax: aktive effect sketch src [→ definition]
Returns image with a general sketch of the input.
| Input | Description |
|---|---|
| src | Source image |
Examples
| @1
|
aktive effect sketch @1
|
|---|---|
geometry(0 0 128 128 1) |
geometry(0 0 128 128 1) |
| @1
|
aktive effect sketch @1
|
|---|---|
geometry(0 0 128 128 1) |
geometry(0 0 128 128 1) |
↑ aktive effect swirl
Syntax: aktive effect swirl src ?(param value)...? [→ definition]
Returns the input with a swirling effect applied to it.
This effect applies around the specified center, with fixed rotation phi, a base rotation from, and a decay factor.
The rotation angle added to a pixel is given by phi + from * exp(-radius * decay), where radius is the distance of the pixel from the center. A large decay reduces the swirl at shorter radii. A decay of zero disables the decay.
All swirl parameters are optional.
The underlying operation is aktive warp swirl.
| Input | Description |
|---|---|
| src | Source image |
| Parameter | Type | Default | Description |
|---|---|---|---|
| interpolate | str | bilinear | Interpolation method to use. |
| center | point | {} | Center of the swirl, default center of the image. |
| phi | double | 0 | In degrees, fixed rotation to apply. Default none. |
| from | double | 45 | In degrees, swirl rotation at distance 0 from center. |
| decay | double | 0.1 | Rotation decay with distance from center. |
Examples
| @1
|
aktive effect swirl @1 decay 0.05 from 135
|
|---|---|
geometry(0 0 128 128 1) |
geometry(0 0 128 128 1) |
| @1
(assets/sines.ppm) |
aktive effect swirl @1 decay 0.01 from 135
|
|---|---|
geometry(0 0 256 256 3) |
geometry(0 0 256 256 3) |
| @1
(assets/butterfly.ppm) |
aktive effect swirl @1 decay 0.01 from 135
|
|---|---|
geometry(0 0 380 250 3) |
geometry(0 0 380 250 3) |
↑ aktive effect wobble
Syntax: aktive effect wobble src ?(param value)...? [→ definition]
Returns the input with a swirling effect applied to it.
This effect applies around the specified center, with base amplitude, frequency, chirp, and attenuation powers.
The effect modulates the distance from the center based on the formula sin (radius^chirp * frequency) * amplitude / (1+radius)^attenuation, where radius is the original distance.
All parameters, including the center are optional.
The underlying operation is aktive warp wobble.
| Input | Description |
|---|---|
| src | Source image |
| Parameter | Type | Default | Description |
|---|---|---|---|
| center | point | {} | Center of the wobble, relative to the image location. Defaults to the image center. |
| amplitude | double | 500 | Base amplitude of the displacement. |
| frequency | double | 2 | Base wave frequency. |
| chirp | double | 0.5 | Chirp (power) factor modulating the frequency. |
| attenuation | double | 0.6 | Power factor tweaking the base 1/x attenuation. |
| interpolate | str | bilinear | Interpolation method to use. |
Examples
| @1
|
aktive effect wobble @1 center {100 50}
|
|---|---|
geometry(0 0 380 250 3) |
geometry(0 0 380 250 3) |