View source for VariableBlur/Unsharp

{{FilterCat4|External_filters|Plugin_functions|Adjustment_filters|Sharpeners}}
'''Back to [[VariableBlur#Filters|VariableBlur]] &larr;'''
== Description ==
Sharpens the image using unsharp filtering (see [http://homepages.inf.ed.ac.uk/rbf/HIPR2/unsharp.htm Unsharp Filter] for an explanation).
<br>
<br>

== Requirements ==
* [[FAQ_different_types_content#How_do_I_recognize_progressive.2C_interlaced.2C_telecined.2C_hybrid_and_blended_content.3F|Progressive]] input only 
* Supported color formats: [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
<br>

== [[Script variables|Syntax and Parameters]] ==
:{{Template:FuncDef|Unsharp (clip, float "varY", float "varC", float "strength", int "border", bool "integrate", int "Y", int "U", int "V", int "gfunc", int "gfuncc", int "pcr", int "pcrc", int "nthreads")}}
<br>
::{{Par2||clip| }}
:::Input clip.
<br>
::{{Par2|varY|float|1.5}}
::{{Par2|varC|float|1.5}}
:::Variance to use; this will not be rounded.
:::{{Template:FuncDef|<tt>varY</tt>}} is for luma, {{Template:FuncDef|<tt>varC</tt>}} is for chroma (U/V). For [[RGB]] input {{Template:FuncDef|<tt>varC</tt>}} is ignored and {{Template:FuncDef|<tt>varY</tt>}} is used for all planes.
<br>
::{{Par2|strength|float|0.7}}
:::Strength of the sharpener, best values are between 0 (no sharpen) to 1 (more sharpen). Values outside this will produce strange results.
<br>
::{{Par2|border|int|4}}
:::Setup how the border of the image is treated.
:::Possible values:
::::*-255 to 0 : The area outside the image is filled with the absolute value.
::::*1 : Wrap around. The right border will be blurred with the left border and the top border with the bottom border. 
::::: This is the default behavior when doing convolution in the frequency domain so this will be the fastest option.
::::*2 : Don't process borders.
::::*3 : Fill the area outside the border by replication of border value.
::::*4 : fill the area outside the border by mirroring. (Default value)
::: 3/4 are slightly slower but give much nicer results.
<br>
::{{Par2|integrate|bool|false}}
:::If true the coefficient used will be a mean value of the area the pixel covers. Use this if you consider each pixel 
:::to be made of an infinite number of infinite small pixels or if you like the result :-). If integration is used the image will be softer.
<br>
::{{Par2|Y|int|3}}
::{{Par2|U|int|2}}
::{{Par2|V|int|2}}
:::Controls which planes the filter is applied to:
::::*3 : corresponding plane will be filtered
::::*2 : corresponding plane will be copied from the source
::::*1 : corresponding plane will be ignored
::::*from 0 to -255 : corresponding plane will be assigned the absolute value. 
:::For [[RGB]] input the Y value is used for all planes (RGB for [[RGB24]] and RGBA for [[RGB32]]) and U/V are ignored.
<br>
::{{Par2|gfunc|int|-1}}
::{{Par2|gfuncc|int|-1}}
:::Set the gamma function to use for Y and U/V planes. Possible values:
::::*-1 = do not correct gamma (same processing as version 0.4) - Default
::::*0 = sRGB
::::*1 = BT.709, SMPTE 170M
::::*2 = SMPTE 240M
::::*3 = BT.470-2 System M   (straight 2.2 gamma, no linear segment)
::::*4 = BT.470-2 System B,G (straight 2.8 gamma, no linear segment)
::::*5 = (straight 2.22222 gamma, no linear segment)
::::*6 = (straight 1.8 gamma, no linear segment)
::::*7 = linear, no gamma compensation

:::Gamma-correction will be undone (forward gamma transfer function) prior to filtering, and then reapplied (inverse gamma transfer function) after filtering.
:::{{Template:FuncDef|<tt>gfunc</tt>}} is for luma, {{Template:FuncDef|<tt>gfuncc</tt>}} is for chroma (U/V). For [[RGB]] input {{Template:FuncDef|<tt>gfunc</tt>}} is used for all planes and {{Template:FuncDef|<tt>gfuncc</tt>}} is ignored.
<br>
::{{Par2|pcr|int|0}}
::{{Par2|pcrc|int|0}}
:::Set the pixel value range for Y and U/V planes. Only used if {{Template:FuncDef|<tt>gfunc</tt>}} or {{Template:FuncDef|<tt>gfuncc</tt>}} is greater than or equal to 0. 
:::Possible values:
::::*0 = [0,255]
::::*1 = [16,235]
::::*2 = [16,240]
:::{{Template:FuncDef|<tt>pcr</tt>}} is for luma, {{Template:FuncDef|<tt>pcrc</tt>}} is for chroma (U/V). For [[RGB]] input {{Template:FuncDef|<tt>pcr</tt>}} is used for all planes and {{Template:FuncDef|<tt>pcrc</tt>}} is ignored.
<br>
::{{Par2|nthreads|int|1}}
:::Set the number of threads for processing.
<br>

== Examples ==
Unsharp with default values:
 [[AviSource]]("Blah.avi")
 Unsharp(varY=1.5, varC=1.5, strength=0.7, border=4, integrate=false, Y=3, U=2, V=2, gfunc=-1, gfuncc=-1, pcr=0, pcrc=0, nthreads=1)
<br>
<br>
-----------------------------------------------
'''Back to [[VariableBlur#Filters|VariableBlur]] &larr;'''