API: Img

Filename:
fwpImg_unsharp.ctag

Released With:
5.0.0

Current Version:
1.1.1

Status: Active

Min Lasso Tested: 8.1.0

Max Lasso Tested: 8.5.3

Related:

API Reference

fwpImg_unsharp (Tag)

Description

Uses ImageMagick and PassThru to process an unsharp mask on a specified image file.

Use this custom tag format, or the fwp_imageFile custom type format.

Syntax

fwpImg_unsharp:
   -srcfile = path,
   -destfile = path,
   -radius = decimal,
   -sigma = decimal,
   -amount = decimal,
   -threshold = decimal;

Parameters & Member Tags

-srcFile - required : a qualified pathname to the image file to be modified

-destFile - required : a qualified pathname for the new image file

-radius - optional : default is 0.0

-sigma - optional : default is 1.0

-amount - optional : default is 1.0

-threshold - optional : default is 0.05

The default values will provide a practical unsharpen mask result for images which have been downsized for thumbnails on webpages. Refer to the ImageMagick documentation for guidelines in using the parameters. Generally, specifying -amount from 0.5 to 4.0 yields the most practical results. All others can be left at their defaults.

Examples

[fwpImg_unsharp:
   -srcFile = $imgSmNm,
   -destFile = $imgSmNm,
   -amount = 0.6]

[fwpImg_unsharp:
   -srcfile =  $testImage,
   -destfile = 'ford-gt40-UNSHARP.jpg',
   -radius = 0.0,
   -sigma = 1.0,
   -amount = 2.0,
   -threshold = 0.05]