GMImage.Unsharpmask
-------------------

Replace image with a sharpened version of the original image using the unsharp mask algorithm.

| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
|---|---|---|---|---|---|---|
| [GraphicsMagick](component_GraphicsMagick.md) | [2.0](newinversion20.md) | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |

MBS( "GMImage.Unsharpmask"; ImageRef; Radius; sigma; amount; threshold ) 

**MBS**( **"GMImage.Unsharpmask";** /\* Replace image with a sharpened version of the original image using the unsharp mask algorithm. \*/  
**$ImageRef**; /\* The image reference number.e.g. $Image \*/   
**$Radius**; /\* the radius of the Gaussian, in pixels, not counting the center pixel.e.g. 0 \*/   
**$sigma**; /\* the standard deviation of the Gaussian, in pixels.e.g. 1 \*/   
**$amount**; /\* the percentage of the difference between the original and the blur image that is added back into the original.  
1 = 100%e.g. 1 \*/   
**$threshold**) /\* the threshold in pixels needed to apply the diffence amount.e.g. 0.05 \*/ 

### Parameters

| Parameter | Description | Example |
|---|---|---|
| ImageRef | The image reference number. | $Image |
| Radius | the radius of the Gaussian, in pixels, not counting the center pixel. | 0 |
| sigma | the standard deviation of the Gaussian, in pixels. | 1 |
| amount | the percentage of the difference between the original and the blur image that is added back into the original.   1 = 100% | 1 |
| threshold | the threshold in pixels needed to apply the diffence amount. | 0.05 |

### Result

Returns "OK" on success.

### Description

Replace image with a sharpened version of the original image using the unsharp mask algorithm.  
### Examples

Try it:

 # Load from container   
Set Variable \[ $ImageRef ; Value: MBS ("[GMImage.NewFromContainer](GMImageNewFromContainer.md)"; Test::BigImage ) \]   
\# apply unsharp mask   
Set Variable \[ $Result ; Value: MBS ("GMImage.Unsharpmask"; $ImageRef ; 2; 1; 1; ,05) \]   
\# Store output and release the image   
Set Field \[ Test::Result ; MBS ( "[GMImage.WriteToPNGContainer](GMImageWriteToPNGContainer.md)"; $ImageRef ) \]   
Set Variable \[ $Error ; Value: MBS ("[GMImage.Free](GMImageFree.md)";$ImageRef ) \]  
### See also

- [GMImage.Free](GMImageFree.md)
- [GMImage.New](GMImageNew.md)
- [GMImage.NewFromContainer](GMImageNewFromContainer.md)
- [GMImage.WriteToPNGContainer](GMImageWriteToPNGContainer.md)

This function checks for a license.

Created 18th August 2014 , last changed 27th September 2022

  
[GMImage.Trim](GMImageTrim.md) - [GMImage.UnsharpmaskChannel](GMImageUnsharpmaskChannel.md)

[HTML Version](GMImageUnsharpmask.shtml)