Reel.Deal: mt_hysteresis: add docs

2021-12-07T22:17:36Z

mt_hysteresis: add docs

New page

{{FilterCat4|External_filters|Plugin_functions|Other_filters|Support_filters}}

-----------------------------------------------
'''Back to [[MaskTools2#Filters|MaskTools2]] ←'''
-----------------------------------------------
 
== Description ==
'''mt_hysteresis''' combines masks by growing the small mask into the big mask by connecting components. This makes it possible to build more robust edge masks.
 
 
== [[Script variables|Syntax and Parameters]] ==
:{{Template:FuncDef|mt_hysteresis (clip, clip, float "Y", float "U", float "V", string "chroma", int "offX", int "offY", int "w", int "h", int "sse2", bool "sse3", bool "ssse3", bool "sse4", bool "avx", bool "avx2", float "A", string "alpha")}}
 
::{{Par2| |clip| }}
:::Input clip one.
 
::{{Par2| |clip| }}
:::Input clip two.
 
::{{Par2|Y|float|3}}
::{{Par2|U|float|1}}
::{{Par2|V|float|1}}
::{{Par2|A|float|1}}
:::These three values describe the actual processing mode that is to be used on each plane / channel. Here is how the modes are coded :
::::*x = -255...0 : all the pixels of the plane will be set to -x.
::::*x = 1 : the plane will not be processed. That means the content of the plane after the filter is pure garbage.
::::*x = 2 : the plane of the first input clip will be copied.
::::*x = 3 : the plane will be processed with the processing the filter is designed to do.
::::*x = 4 : the plane of the second input clip will be copied.
 
::{{Par2|chroma|string|""}}
::{{Par2|alpha|string|""}}
:::When defined, the value contained in this string will overwrite the {{Template:FuncDef3|U}} and {{Template:FuncDef3|V}} processing modes.
:::This is a nice addition proposed by mg262 that makes the filter more user friendly. Allowed values for chroma are:
::::*"process" : set u = v = 3.
::::*"copy" or "copy first" : set u = v = 2.
::::*"copy second" : set u = v = 4.
::::*"xxx", where xxx is a number : set u = v = -xxx.
 
::{{Par2|offX|int|0}}
::{{Par2|offY|int|0}}
:::{{Template:FuncDef3|offX}} and {{Template:FuncDef3|offY}} are the top left coordinates of the box where the actual processing shall occur. Everything outside that box will be garbage.
 
::{{Par2|w|int|-1}}
::{{Par2|h|int|-1}}
:::{{Template:FuncDef3|w}} and {{Template:FuncDef3|h}} are the width and height of the processed box. -1 means that the box extends to the lower right corner of the video. That also means that default settings are meant to process the whole picture.
 
== Examples ==
mt_hysteresis with default settings:
mask1 = last.mt_edge(thY1=30, thY2=30)
mask2 = last.mt_edge(thY1=5, thY2=5) 
mt_hysteresis(mask1, mask2, Y=3, U=1, V=1, chroma="", w=-1, h=-1)
See these threads for more examples:
*[https://forum.doom9.org/showthread.php?t=163516 Remove isolated dots in a mask]
*[https://forum.doom9.org/showthread.php?t=128458 Use spots from one mask to select spots on another mask]
 
 
-----------------------------------------------
'''Back to [[MaskTools2#Filters|MaskTools2]] ←'''
-----------------------------------------------

MaskTools2/mt hysteresis - Revision history

Reel.Deal: mt_hysteresis: add docs