Reel.Deal: mt_expand documentation

2021-12-09T11:37:35Z

mt_expand documentation

New page

{{FilterCat4|External_filters|Plugin_functions|Other_filters|Support_filters}}
-----------------------------------------------
'''Back to [[MaskTools2#Filters|MaskTools2]] ←'''
-----------------------------------------------
 
== Description ==
'''mt_expand''' expands the mask / the video. For every pixel compute the local maximum value. Expand refers to maximum; makes your picture brighter and it's usually used on masks to make covered areas wider, but can also be applied to video clips.
 
 
== [[Script variables|Syntax and Parameters]] ==
:{{Template:FuncDef|mt_expand (clip, float "thY", float "thC", string "mode", 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.
 
::{{Par2|thY|float|255.0}}
::{{Par2|thC|float|255.0}}
:::{{Template:FuncDef3|thY}} and {{Template:FuncDef3|thC}} are used to limit the change of a pixel.
:::For example, if the original pixel luma value is 50, and after applying {{Template:FuncDef3|mt_expand}} it becomes 125. If {{Template:FuncDef3|thY}} is set to 25, the result value will be 75. In other words, each value in the output clip cannot be greater than original value plus {{Template:FuncDef3|thY}}. {{Template:FuncDef3|thC}} is the same limiter for chroma.
 
::{{Par2|mode|string|"square"}}
:::Select the local neighbourhood. It can take the values :
:::*<code>"square"</code> : 3x3 square neighbourhood.
:::*"<code>horizontal"</code> : 3x1 horizontal neighbourhood.
:::*"<code>vertical"</code> : 1x3 horizontal neighbourhood.
:::*"<code>both"</code> : a 3-long cross ( "horizontal" + "vertical" ) neighbourhood.
:::*A custom mode, where you give a list of coordinates. Each pair of values is relative coordinate of a pixel, which will be taken into calculation. First value is X offset, second is Y. So “0 0” means the current pixel, “1 0” – one pixel to the right, “-1 0” – one pixel to the left. The official documentation here says that "0 0 -1 0 1 0" is equivalent to "horizontal” but in reality – it’s much slower.
 
::{{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_expand with default settings:
mt_expand(clip, thY=255, thC=255, Y=3, U=1, V=1, chroma="", w=-1, h=-1)
 
 
-----------------------------------------------
'''Back to [[MaskTools2#Filters|MaskTools2]] ←'''
-----------------------------------------------

MaskTools2/mt expand - Revision history

Reel.Deal: mt_expand documentation