hugo/docs/content/en/functions/images/UnsharpMask.md
2023-12-04 15:24:01 +01:00

1 KiB

title description categories keywords action toc
images.UnsharpMask Returns an image filter that sharpens an image.
aliases related returnType signatures
functions/images/Filter
methods/resource/Filter
images.filter
images.UnsharpMask SIGMA AMOUNT THRESHOLD
true

The sigma parameter is used in a gaussian function and affects the radius of effect. Sigma must be positive. The sharpen radius is approximately 3 times the sigma value.

The amount parameter controls how much darker and how much lighter the edge borders become. Typically between 0.5 and 1.5.

The threshold parameter controls the minimum brightness change that will be sharpened. Typically between 0 and 0.05.

Usage

Create the filter:

{{ $filter := images.UnsharpMask 10 0.4 0.03 }}

{{% include "functions/images/_common/apply-image-filter.md" %}}

Example

{{< img src="images/examples/zion-national-park.jpg" alt="Zion National Park" filter="UnsharpMask" filterArgs="10,0.4,0.03" example=true

}}