Skip to content

morpho

Classes:

  • Morpho

    Collection of morphological operations.

Functions:

Attributes:

  • RadiusLike

    Type alias for specifying a convolution radius.

RadiusLike module-attribute

RadiusLike = int | tuple[int, SpatialConvMode]

Type alias for specifying a convolution radius.

This can be one of the following
  • An int: Interpreted as a square convolution with size (2 * radius + 1) x (2 * radius + 1).
  • A tuple[int, SpatialConvMode]: A pair specifying the radius and the convolution mode.

Morpho

Morpho(*args: Any, **kwargs: Any)

Collection of morphological operations.

Methods:

  • binarize

    Turns every pixel in the image into either lowval, if it's below midthr, or highval otherwise.

  • binarize_mask

    Turns every pixel in the mask clip into either lowval if it's below midthr, or highval otherwise.

  • black_hat

    Alias for bottom_hat

  • bottom_hat

    A bottom hat or a black hat is the difference of the closing and the original clip.

  • closing

    A closing is an dilation followed by an erosion.

  • deflate

    Replaces each pixel with the average of the (radius * 2 + 1) ** 2 - 1 pixels

  • dilation

    Replaces each pixel with the largest value in its (radius * 2 + 1)x(radius * 2 + 1) neighbourhood.

  • erosion

    Replaces each pixel with the smallest value in its (radius * 2 + 1)x(radius * 2 + 1) neighbourhood.

  • expand

    Replaces multiple times each pixel with the largest value in its 3x3 neighbourhood.

  • gradient

    A morphological gradient is the difference between a dilation and erosion.

  • inflate

    Replaces each pixel with the average of the (radius * 2 + 1) ** 2 - 1 pixels

  • inner_hat

    An inner hat is the difference of the original clip and the erosion.

  • inpand

    Replaces multiple times each pixel with the smallest value in its 3x3 neighbourhood.

  • maximum

    Replaces each pixel with the largest value in its 3x3 neighbourhood.

  • minimum

    Replaces each pixel with the smallest value in its 3x3 neighbourhood.

  • opening

    An opening is an erosion followed by an dilation.

  • outer_hat

    An outer hat is the difference of the dilation and the original clip.

  • top_hat

    A top hat or a white hat is the difference of the original clip and the opening.

  • white_hate

    Alias for top_hat

Source code in vsmasktools/morpho.py
49
def __init__(self, *args: Any, **kwargs: Any) -> None: ...

binarize

binarize(
    clip: VideoNode,
    midthr: float | Sequence[float] | None = None,
    lowval: float | Sequence[float] | None = None,
    highval: float | Sequence[float] | None = None,
    planes: Planes = None,
) -> ConstantFormatVideoNode

Turns every pixel in the image into either lowval, if it's below midthr, or highval otherwise.

Parameters:

  • clip

    (VideoNode) –

    Clip to process.

  • midthr

    (float | Sequence[float] | None, default: None ) –

    Threshold separating lowval and highval. Defaults to the midpoint of the format's range. Can be specified per plane.

  • lowval

    (float | Sequence[float] | None, default: None ) –

    Value assigned to pixels below midthr. Defaults to the lower bound of the format's range. Can be specified per plane.

  • highval

    (float | Sequence[float] | None, default: None ) –

    Value assigned to pixels greater than or equal to midthr. Defaults to the upper bound of the format's range. Can be specified per plane.

  • planes

    (Planes, default: None ) –

    Specifies which planes to process. Unprocessed planes are copied unchanged.

Source code in vsmasktools/morpho.py
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
@inject_self
def binarize(
    self,
    clip: vs.VideoNode,
    midthr: float | Sequence[float] | None = None,
    lowval: float | Sequence[float] | None = None,
    highval: float | Sequence[float] | None = None,
    planes: Planes = None,
) -> ConstantFormatVideoNode:
    """
    Turns every pixel in the image into either `lowval`, if it's below `midthr`, or `highval` otherwise.

    Args:
        clip: Clip to process.
        midthr: Threshold separating `lowval` and `highval`. Defaults to the midpoint of the
            format's range. Can be specified per plane.
        lowval: Value assigned to pixels below `midthr`. Defaults to the lower bound of the
            format's range. Can be specified per plane.
        highval: Value assigned to pixels greater than or equal to `midthr`. Defaults to the
            upper bound of the format's range. Can be specified per plane.
        planes: Specifies which planes to process. Unprocessed planes are copied unchanged.
    """
    midthr, lowval, highval = (
        thr and [scale_value(t, 32, clip) for t in to_arr(thr)] for thr in (midthr, lowval, highval)
    )

    return core.std.Binarize(clip, midthr, lowval, highval, planes)

binarize_mask

binarize_mask(
    clip: VideoNode,
    midthr: float | Sequence[float] | None = None,
    lowval: float | Sequence[float] | None = None,
    highval: float | Sequence[float] | None = None,
    planes: Planes = None,
) -> ConstantFormatVideoNode

Turns every pixel in the mask clip into either lowval if it's below midthr, or highval otherwise.

This variant is intended for use on mask clips where all planes share the same value range.

Parameters:

  • clip

    (VideoNode) –

    Mask clip to process.

  • midthr

    (float | Sequence[float] | None, default: None ) –

    Threshold separating lowval and highval. Defaults to the midpoint of the format's range. Can be specified per plane.

  • lowval

    (float | Sequence[float] | None, default: None ) –

    Value assigned to pixels below midthr. Defaults to the lower bound of the format's range for mask clips. Can be specified per plane.

  • highval

    (float | Sequence[float] | None, default: None ) –

    Value assigned to pixels greater than or equal to midthr. Defaults to the upper bound of the format's range for mask clips. Can be specified per plane.

  • planes

    (Planes, default: None ) –

    Specifies which planes to process. Unprocessed planes are copied unchanged.

Source code in vsmasktools/morpho.py
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
@inject_self
def binarize_mask(
    self,
    clip: vs.VideoNode,
    midthr: float | Sequence[float] | None = None,
    lowval: float | Sequence[float] | None = None,
    highval: float | Sequence[float] | None = None,
    planes: Planes = None,
) -> ConstantFormatVideoNode:
    """
    Turns every pixel in the mask clip into either `lowval` if it's below `midthr`, or `highval` otherwise.

    This variant is intended for use on mask clips where all planes share the same value range.

    Args:
        clip: Mask clip to process.
        midthr: Threshold separating `lowval` and `highval`. Defaults to the midpoint of the
            format's range. Can be specified per plane.
        lowval: Value assigned to pixels below `midthr`. Defaults to the lower bound of the
            format's range for mask clips. Can be specified per plane.
        highval: Value assigned to pixels greater than or equal to `midthr`. Defaults to the
            upper bound of the format's range for mask clips. Can be specified per plane.
        planes: Specifies which planes to process. Unprocessed planes are copied unchanged.
    """
    midthr, lowval, highval = (
        thr and [scale_value(t, 32, clip) for t in to_arr(thr)] for thr in (midthr, lowval, highval)
    )

    return core.std.BinarizeMask(clip, midthr, lowval, highval, planes)

black_hat

black_hat(*args: Any, **kwargs: Any) -> ConstantFormatVideoNode

Alias for bottom_hat

Source code in vsmasktools/morpho.py
551
552
553
554
555
@copy_signature(bottom_hat)
@inject_self
def black_hat(self, *args: Any, **kwargs: Any) -> ConstantFormatVideoNode:
    """Alias for [bottom_hat][vsmasktools.Morpho.bottom_hat]"""
    return self.top_hat(*args, **{"func": self.black_hat} | kwargs)

bottom_hat

bottom_hat(
    clip: VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any
) -> ConstantFormatVideoNode

A bottom hat or a black hat is the difference of the closing and the original clip.

Parameters:

  • clip

    (VideoNode) –

    Clip to process.

  • radius

    (RadiusLike, default: 1 ) –

    A single integer specifies the size of the square matrix. A tuple of an integer and a ConvMode allows specification of the matrix type dimension as well.

  • thr

    (float | None, default: None ) –

    Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than input - thr. The default is no limit.

  • iterations

    (int, default: 1 ) –

    Number of times to execute the function.

  • coords

    (Sequence[int] | None, default: None ) –

    Specifies which pixels from the neighbourhood are considered. If an element of this array is 0, the corresponding pixel is not considered when finding the maximum value. This must contain exactly (radius * 2 + 1) ** 2 - 1 numbers eg. 8, 24, 48... When specified, this parameter takes precedence over radius.

  • multiply

    (float | None, default: None ) –

    Optional multiplier of the final value.

  • planes

    (Planes, default: None ) –

    Which plane to process.

Source code in vsmasktools/morpho.py
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
@inject_self
def bottom_hat(
    self,
    clip: vs.VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any,
) -> ConstantFormatVideoNode:
    """
    A bottom hat or a black hat is the difference of the closing and the original clip.

    Args:
        clip: Clip to process.
        radius: A single integer specifies the size of the square matrix. A tuple of an integer and a ConvMode
            allows specification of the matrix type dimension as well.
        thr: Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than
            input - thr. The default is no limit.
        iterations: Number of times to execute the function.
        coords: Specifies which pixels from the neighbourhood are considered. If an element of this array is 0, the
            corresponding pixel is not considered when finding the maximum value. This must contain exactly (radius
            * 2 + 1) ** 2 - 1 numbers eg. 8, 24, 48... When specified, this parameter takes precedence over radius.
        multiply: Optional multiplier of the final value.
        planes: Which plane to process.
    """
    func = func or self.bottom_hat

    assert check_variable_format(clip, func)

    closed = self.closing(clip, radius, thr, iterations, coords, multiply, planes, func=func, **kwargs)

    return norm_expr([closed, clip], "x y -", planes, func=func)

closing

closing(
    clip: VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any
) -> ConstantFormatVideoNode

A closing is an dilation followed by an erosion.

Parameters:

  • clip

    (VideoNode) –

    Clip to process

  • radius

    (RadiusLike, default: 1 ) –

    A single integer specifies the size of the square matrix. A tuple of an integer and a ConvMode allows specification of the matrix type dimension as well.

  • thr

    (float | None, default: None ) –

    Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than input - thr. The default is no limit.

  • iterations

    (int, default: 1 ) –

    Number of times to execute the function.

  • coords

    (Sequence[int] | None, default: None ) –

    Specifies which pixels from the neighbourhood are considered. If an element of this array is 0, the corresponding pixel is not considered when finding the maximum value. This must contain exactly (radius * 2 + 1) ** 2 - 1 numbers eg. 8, 24, 48... When specified, this parameter takes precedence over radius.

  • multiply

    (float | None, default: None ) –

    Optional multiplier of the final value.

  • planes

    (Planes, default: None ) –

    Which plane to process.

Source code in vsmasktools/morpho.py
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
@inject_self
def closing(
    self,
    clip: vs.VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any,
) -> ConstantFormatVideoNode:
    """
    A closing is an dilation followed by an erosion.

    Args:
        clip: Clip to process
        radius: A single integer specifies the size of the square matrix. A tuple of an integer and a ConvMode
            allows specification of the matrix type dimension as well.
        thr: Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than
            input - thr. The default is no limit.
        iterations: Number of times to execute the function.
        coords: Specifies which pixels from the neighbourhood are considered. If an element of this array is 0, the
            corresponding pixel is not considered when finding the maximum value. This must contain exactly (radius
            * 2 + 1) ** 2 - 1 numbers eg. 8, 24, 48... When specified, this parameter takes precedence over radius.
        multiply: Optional multiplier of the final value.
        planes: Which plane to process.
    """
    func = func or self.closing

    dilated = self.dilation(clip, radius, thr, iterations, coords, multiply, planes, func=func, **kwargs)
    eroded = self.erosion(dilated, radius, thr, iterations, coords, multiply, planes, func=func, **kwargs)

    return eroded

deflate

deflate(
    clip: VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any
) -> ConstantFormatVideoNode

Replaces each pixel with the average of the (radius * 2 + 1) ** 2 - 1 pixels in its (radius * 2 + 1)x(radius * 2 + 1) neighbourhood, but only if that average is less than the center pixel.

A radius of 1 will replace each pixel with the average of the 8 pixels in its 3x3 neighbourhood. A radius of 2 will replace each pixel with the average of the 24 pixels in its 5x5 neighbourhood.

Parameters:

  • clip

    (VideoNode) –

    Clip to process.

  • radius

    (RadiusLike, default: 1 ) –

    A single integer specifies the size of the square matrix. A tuple of an integer and a ConvMode allows specification of the matrix type dimension as well.

  • thr

    (float | None, default: None ) –

    Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than input - thr. The default is no limit.

  • iterations

    (int, default: 1 ) –

    Number of times to execute the function.

  • coords

    (Sequence[int] | None, default: None ) –

    Specifies which pixels from the neighbourhood are considered. If an element of this array is 0, the corresponding pixel is not considered when finding the maximum value. This must contain exactly (radius * 2 + 1) ** 2 - 1 numbers eg. 8, 24, 48... When specified, this parameter takes precedence over radius.

  • multiply

    (float | None, default: None ) –

    Optional multiplier of the final value.

  • planes

    (Planes, default: None ) –

    Which plane to process.

Source code in vsmasktools/morpho.py
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
@inject_self
def deflate(
    self,
    clip: vs.VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any,
) -> ConstantFormatVideoNode:
    """
    Replaces each pixel with the average of the (radius * 2 + 1) ** 2 - 1 pixels
    in its (radius * 2 + 1)x(radius * 2 + 1) neighbourhood, but only if that average
    is less than the center pixel.

    A radius of 1 will replace each pixel with the average of the 8 pixels in its 3x3 neighbourhood.
    A radius of 2 will replace each pixel with the average of the 24 pixels in its 5x5 neighbourhood.

    Args:
        clip: Clip to process.
        radius: A single integer specifies the size of the square matrix. A tuple of an integer and a ConvMode
            allows specification of the matrix type dimension as well.
        thr: Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than
            input - thr. The default is no limit.
        iterations: Number of times to execute the function.
        coords: Specifies which pixels from the neighbourhood are considered. If an element of this array is 0, the
            corresponding pixel is not considered when finding the maximum value. This must contain exactly (radius
            * 2 + 1) ** 2 - 1 numbers eg. 8, 24, 48... When specified, this parameter takes precedence over radius.
        multiply: Optional multiplier of the final value.
        planes: Which plane to process.
    """
    return self._xxflate(
        clip, radius, thr, iterations, coords, multiply, planes, func=func or self.deflate, inflate=False, **kwargs
    )

dilation

dilation(
    clip: VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any
) -> ConstantFormatVideoNode

Replaces each pixel with the largest value in its (radius * 2 + 1)x(radius * 2 + 1) neighbourhood.

Parameters:

  • clip

    (VideoNode) –

    Clip to process.

  • radius

    (RadiusLike, default: 1 ) –

    A single integer specifies the size of the square matrix. A tuple of an integer and a ConvMode allows specification of the matrix type dimension as well.

  • thr

    (float | None, default: None ) –

    Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than input - thr. The default is no limit.

  • iterations

    (int, default: 1 ) –

    Number of times to execute the function.

  • coords

    (Sequence[int] | None, default: None ) –

    Specifies which pixels from the neighbourhood are considered. If an element of this array is 0, the corresponding pixel is not considered when finding the maximum value. This must contain exactly (radius * 2 + 1) ** 2 - 1 numbers eg. 8, 24, 48... When specified, this parameter takes precedence over radius.

  • multiply

    (float | None, default: None ) –

    Optional multiplier of the final value.

  • planes

    (Planes, default: None ) –

    Which plane to process.

Source code in vsmasktools/morpho.py
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
@inject_self
def dilation(
    self,
    clip: vs.VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any,
) -> ConstantFormatVideoNode:
    """
    Replaces each pixel with the largest value in its (radius * 2 + 1)x(radius * 2 + 1) neighbourhood.

    Args:
        clip: Clip to process.
        radius: A single integer specifies the size of the square matrix. A tuple of an integer and a ConvMode
            allows specification of the matrix type dimension as well.
        thr: Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than
            input - thr. The default is no limit.
        iterations: Number of times to execute the function.
        coords: Specifies which pixels from the neighbourhood are considered. If an element of this array is 0, the
            corresponding pixel is not considered when finding the maximum value. This must contain exactly (radius
            * 2 + 1) ** 2 - 1 numbers eg. 8, 24, 48... When specified, this parameter takes precedence over radius.
        multiply: Optional multiplier of the final value.
        planes: Which plane to process.
    """
    return self._mm_func(
        clip,
        radius,
        thr,
        iterations,
        coords,
        multiply,
        planes,
        func=func or self.dilation,
        mm_func=core.lazy.std.Maximum,
        op=ExprOp.MAX,
        **kwargs,
    )

erosion

erosion(
    clip: VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any
) -> ConstantFormatVideoNode

Replaces each pixel with the smallest value in its (radius * 2 + 1)x(radius * 2 + 1) neighbourhood.

Parameters:

  • clip

    (VideoNode) –

    Clip to process.

  • radius

    (RadiusLike, default: 1 ) –

    A single integer specifies the size of the square matrix. A tuple of an integer and a ConvMode allows specification of the matrix type dimension as well.

  • thr

    (float | None, default: None ) –

    Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than input - thr. The default is no limit.

  • iterations

    (int, default: 1 ) –

    Number of times to execute the function.

  • coords

    (Sequence[int] | None, default: None ) –

    Specifies which pixels from the neighbourhood are considered. If an element of this array is 0, the corresponding pixel is not considered when finding the maximum value. This must contain exactly (radius * 2 + 1) ** 2 - 1 numbers eg. 8, 24, 48... When specified, this parameter takes precedence over radius.

  • multiply

    (float | None, default: None ) –

    Optional multiplier of the final value.

  • planes

    (Planes, default: None ) –

    Which plane to process.

Source code in vsmasktools/morpho.py
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
@inject_self
def erosion(
    self,
    clip: vs.VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any,
) -> ConstantFormatVideoNode:
    """
    Replaces each pixel with the smallest value in its (radius * 2 + 1)x(radius * 2 + 1) neighbourhood.

    Args:
        clip: Clip to process.
        radius: A single integer specifies the size of the square matrix. A tuple of an integer and a ConvMode
            allows specification of the matrix type dimension as well.
        thr: Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than
            input - thr. The default is no limit.
        iterations: Number of times to execute the function.
        coords: Specifies which pixels from the neighbourhood are considered. If an element of this array is 0, the
            corresponding pixel is not considered when finding the maximum value. This must contain exactly (radius
            * 2 + 1) ** 2 - 1 numbers eg. 8, 24, 48... When specified, this parameter takes precedence over radius.
        multiply: Optional multiplier of the final value.
        planes: Which plane to process.
    """
    return self._mm_func(
        clip,
        radius,
        thr,
        iterations,
        coords,
        multiply,
        planes,
        func=func or self.erosion,
        mm_func=core.lazy.std.Minimum,
        op=ExprOp.MIN,
        **kwargs,
    )

expand

expand(
    clip: VideoNode,
    sw: int,
    sh: int | None = None,
    mode: XxpandMode = RECTANGLE,
    thr: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any
) -> ConstantFormatVideoNode

Replaces multiple times each pixel with the largest value in its 3x3 neighbourhood. Specifying a mode will allow custom growing mode.

Parameters:

  • clip

    (VideoNode) –

    Clip to process.

  • sw

    (int) –

    Number of horizontal iterations.

  • sh

    (int | None, default: None ) –

    Number of vertical iterations.

  • mode

    (XxpandMode, default: RECTANGLE ) –

    Specifies the expand mode shape.

  • thr

    (float | None, default: None ) –

    Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than input - thr. The default is no limit.

  • planes

    (Planes, default: None ) –

    Which plane to process.

Source code in vsmasktools/morpho.py
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
@inject_self
def expand(
    self,
    clip: vs.VideoNode,
    sw: int,
    sh: int | None = None,
    mode: XxpandMode = XxpandMode.RECTANGLE,
    thr: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any,
) -> ConstantFormatVideoNode:
    """
    Replaces multiple times each pixel with the largest value in its 3x3 neighbourhood.
    Specifying a mode will allow custom growing mode.

    Args:
        clip: Clip to process.
        sw: Number of horizontal iterations.
        sh: Number of vertical iterations.
        mode: Specifies the expand mode shape.
        thr: Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than
            input - thr. The default is no limit.
        planes: Which plane to process.
    """
    func = func or self.expand

    return self._xxpand_transform(clip, sw, sh, mode, thr, planes, op=ExprOp.MAX, func=func, **kwargs)

gradient

gradient(
    clip: VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any
) -> ConstantFormatVideoNode

A morphological gradient is the difference between a dilation and erosion.

Parameters:

  • clip

    (VideoNode) –

    Clip to process.

  • radius

    (RadiusLike, default: 1 ) –

    A single integer specifies the size of the square matrix. A tuple of an integer and a ConvMode allows specification of the matrix type dimension as well.

  • thr

    (float | None, default: None ) –

    Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than input - thr. The default is no limit.

  • iterations

    (int, default: 1 ) –

    Number of times to execute the function.

  • coords

    (Sequence[int] | None, default: None ) –

    Specifies which pixels from the neighbourhood are considered. If an element of this array is 0, the corresponding pixel is not considered when finding the maximum value. This must contain exactly (radius * 2 + 1) ** 2 - 1 numbers eg. 8, 24, 48... When specified, this parameter takes precedence over radius.

  • multiply

    (float | None, default: None ) –

    Optional multiplier of the final value.

  • planes

    (Planes, default: None ) –

    Which plane to process.

Source code in vsmasktools/morpho.py
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
@inject_self
def gradient(
    self,
    clip: vs.VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any,
) -> ConstantFormatVideoNode:
    """
    A morphological gradient is the difference between a dilation and erosion.

    Args:
        clip: Clip to process.
        radius: A single integer specifies the size of the square matrix. A tuple of an integer and a ConvMode
            allows specification of the matrix type dimension as well.
        thr: Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than
            input - thr. The default is no limit.
        iterations: Number of times to execute the function.
        coords: Specifies which pixels from the neighbourhood are considered. If an element of this array is 0, the
            corresponding pixel is not considered when finding the maximum value. This must contain exactly (radius
            * 2 + 1) ** 2 - 1 numbers eg. 8, 24, 48... When specified, this parameter takes precedence over radius.
        multiply: Optional multiplier of the final value.
        planes: Which plane to process.
    """
    func = func or self.gradient

    assert check_variable_format(clip, func)

    if isinstance(radius, tuple):
        r, conv_mode = radius
    else:
        r, conv_mode = radius, ConvMode.SQUARE

    if iterations == 1 and conv_mode is not ConvMode.HV:
        return norm_expr(
            clip,
            "{dilated} {eroded} - {multiply}",
            planes,
            dilated=self._morpho_xx_imum(
                clip, (r, conv_mode), thr, coords, multiply, True, op=ExprOp.MAX, func=func
            )[0].to_str(),
            eroded=self._morpho_xx_imum(
                clip, (r, conv_mode), thr, coords, multiply, True, op=ExprOp.MIN, func=func
            )[0].to_str(),
            multiply="" if multiply is None else f"{multiply} *",
        )

    dilated = self.dilation(clip, radius, thr, iterations, coords, multiply, planes, func=func, **kwargs)
    eroded = self.erosion(clip, radius, thr, iterations, coords, multiply, planes, func=func, **kwargs)

    return norm_expr([dilated, eroded], "x y -", planes, func=func)

inflate

inflate(
    clip: VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any
) -> ConstantFormatVideoNode

Replaces each pixel with the average of the (radius * 2 + 1) ** 2 - 1 pixels in its (radius * 2 + 1)x(radius * 2 + 1) neighbourhood, but only if that average is greater than the center pixel.

A radius of 1 will replace each pixel with the average of the 8 pixels in its 3x3 neighbourhood. A radius of 2 will replace each pixel with the average of the 24 pixels in its 5x5 neighbourhood.

Parameters:

  • clip

    (VideoNode) –

    Clip to process.

  • radius

    (RadiusLike, default: 1 ) –

    A single integer specifies the size of the square matrix. A tuple of an integer and a ConvMode allows specification of the matrix type dimension as well.

  • thr

    (float | None, default: None ) –

    Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become greater than input + thr. The default is no limit.

  • iterations

    (int, default: 1 ) –

    Number of times to execute the function.

  • coords

    (Sequence[int] | None, default: None ) –

    Specifies which pixels from the neighbourhood are considered. If an element of this array is 0, the corresponding pixel is not considered when finding the maximum value. This must contain exactly (radius * 2 + 1) ** 2 - 1 numbers eg. 8, 24, 48... When specified, this parameter takes precedence over radius.

  • multiply

    (float | None, default: None ) –

    Optional multiplier of the final value.

  • planes

    (Planes, default: None ) –

    Which plane to process.

Source code in vsmasktools/morpho.py
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
@inject_self
def inflate(
    self,
    clip: vs.VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any,
) -> ConstantFormatVideoNode:
    """
    Replaces each pixel with the average of the (radius * 2 + 1) ** 2 - 1 pixels
    in its (radius * 2 + 1)x(radius * 2 + 1) neighbourhood, but only if that average
    is greater than the center pixel.

    A radius of 1 will replace each pixel with the average of the 8 pixels in its 3x3 neighbourhood.
    A radius of 2 will replace each pixel with the average of the 24 pixels in its 5x5 neighbourhood.

    Args:
        clip: Clip to process.
        radius: A single integer specifies the size of the square matrix. A tuple of an integer and a ConvMode
            allows specification of the matrix type dimension as well.
        thr: Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become greater
            than input + thr. The default is no limit.
        iterations: Number of times to execute the function.
        coords: Specifies which pixels from the neighbourhood are considered. If an element of this array is 0, the
            corresponding pixel is not considered when finding the maximum value. This must contain exactly (radius
            * 2 + 1) ** 2 - 1 numbers eg. 8, 24, 48... When specified, this parameter takes precedence over radius.
        multiply: Optional multiplier of the final value.
        planes: Which plane to process.
    """
    return self._xxflate(
        clip, radius, thr, iterations, coords, multiply, planes, func=func or self.inflate, inflate=True, **kwargs
    )

inner_hat

inner_hat(
    clip: VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any
) -> ConstantFormatVideoNode

An inner hat is the difference of the original clip and the erosion.

Parameters:

  • clip

    (VideoNode) –

    Clip to process.

  • radius

    (RadiusLike, default: 1 ) –

    A single integer specifies the size of the square matrix. A tuple of an integer and a ConvMode allows specification of the matrix type dimension as well.

  • thr

    (float | None, default: None ) –

    Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than input - thr. The default is no limit.

  • iterations

    (int, default: 1 ) –

    Number of times to execute the function.

  • coords

    (Sequence[int] | None, default: None ) –

    Specifies which pixels from the neighbourhood are considered. If an element of this array is 0, the corresponding pixel is not considered when finding the maximum value. This must contain exactly (radius * 2 + 1) ** 2 - 1 numbers eg. 8, 24, 48... When specified, this parameter takes precedence over radius.

  • multiply

    (float | None, default: None ) –

    Optional multiplier of the final value.

  • planes

    (Planes, default: None ) –

    Which plane to process.

Source code in vsmasktools/morpho.py
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
@inject_self
def inner_hat(
    self,
    clip: vs.VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any,
) -> ConstantFormatVideoNode:
    """
    An inner hat is the difference of the original clip and the erosion.

    Args:
        clip: Clip to process.
        radius: A single integer specifies the size of the square matrix. A tuple of an integer and a ConvMode
            allows specification of the matrix type dimension as well.
        thr: Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than
            input - thr. The default is no limit.
        iterations: Number of times to execute the function.
        coords: Specifies which pixels from the neighbourhood are considered. If an element of this array is 0, the
            corresponding pixel is not considered when finding the maximum value. This must contain exactly (radius
            * 2 + 1) ** 2 - 1 numbers eg. 8, 24, 48... When specified, this parameter takes precedence over radius.
        multiply: Optional multiplier of the final value.
        planes: Which plane to process.
    """
    func = func or self.inner_hat

    assert check_variable_format(clip, func)

    if isinstance(radius, tuple):
        r, conv_mode = radius
    else:
        r, conv_mode = radius, ConvMode.SQUARE

    if iterations == 1 and conv_mode is not ConvMode.HV:
        return norm_expr(
            clip,
            "x {eroded} {multiply} -",
            planes,
            eroded=self._morpho_xx_imum(
                clip, (r, conv_mode), thr, coords, multiply, True, op=ExprOp.MIN, func=func
            )[0].to_str(),
            multiply="" if multiply is None else f"{multiply} *",
        )

    eroded = self.erosion(clip, radius, thr, iterations, coords, multiply, planes, func=func, **kwargs)

    return norm_expr([clip, eroded], "x y -", planes, func=func)

inpand

inpand(
    clip: VideoNode,
    sw: int,
    sh: int | None = None,
    mode: XxpandMode = RECTANGLE,
    thr: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any
) -> ConstantFormatVideoNode

Replaces multiple times each pixel with the smallest value in its 3x3 neighbourhood. Specifying a mode will allow custom growing mode.

Parameters:

  • clip

    (VideoNode) –

    Clip to process.

  • sw

    (int) –

    Number of horizontal iterations.

  • sh

    (int | None, default: None ) –

    Number of vertical iterations.

  • mode

    (XxpandMode, default: RECTANGLE ) –

    Specifies the expand mode shape.

  • thr

    (float | None, default: None ) –

    Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than input - thr. The default is no limit.

  • planes

    (Planes, default: None ) –

    Which plane to process.

Source code in vsmasktools/morpho.py
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
@inject_self
def inpand(
    self,
    clip: vs.VideoNode,
    sw: int,
    sh: int | None = None,
    mode: XxpandMode = XxpandMode.RECTANGLE,
    thr: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any,
) -> ConstantFormatVideoNode:
    """
    Replaces multiple times each pixel with the smallest value in its 3x3 neighbourhood.
    Specifying a mode will allow custom growing mode.

    Args:
        clip: Clip to process.
        sw: Number of horizontal iterations.
        sh: Number of vertical iterations.
        mode: Specifies the expand mode shape.
        thr: Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than
            input - thr. The default is no limit.
        planes: Which plane to process.
    """
    func = func or self.expand

    return self._xxpand_transform(clip, sw, sh, mode, thr, planes, op=ExprOp.MIN, func=func, **kwargs)

maximum

maximum(
    clip: VideoNode,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any
) -> ConstantFormatVideoNode

Replaces each pixel with the largest value in its 3x3 neighbourhood. This operation is also known as dilation with a radius of 1.

Parameters:

  • clip

    (VideoNode) –

    Clip to process.

  • thr

    (float | None, default: None ) –

    Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become greater than input + threshold The default is no limit.

  • iterations

    (int, default: 1 ) –

    Number of times to execute the function.

  • coords

    (Sequence[int] | None, default: None ) –

    Specifies which pixels from the 3x3 neighbourhood are considered. If an element of this array is 0, the corresponding pixel is not considered when finding the maximum value. This must contain exactly 8 numbers.

  • multiply

    (float | None, default: None ) –

    Optional multiplier of the final value.

  • planes

    (Planes, default: None ) –

    Which plane to process.

Source code in vsmasktools/morpho.py
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
@inject_self
def maximum(
    self,
    clip: vs.VideoNode,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any,
) -> ConstantFormatVideoNode:
    """
    Replaces each pixel with the largest value in its 3x3 neighbourhood.
    This operation is also known as dilation with a radius of 1.

    Args:
        clip: Clip to process.
        thr: Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become greater
            than input + threshold The default is no limit.
        iterations: Number of times to execute the function.
        coords: Specifies which pixels from the 3x3 neighbourhood are considered. If an element of this array is 0,
            the corresponding pixel is not considered when finding the maximum value. This must contain exactly 8
            numbers.
        multiply: Optional multiplier of the final value.
        planes: Which plane to process.
    """
    return self.dilation(clip, 1, thr, iterations, coords, multiply, planes, func=func, **kwargs)

minimum

minimum(
    clip: VideoNode,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any
) -> ConstantFormatVideoNode

Replaces each pixel with the smallest value in its 3x3 neighbourhood. This operation is also known as erosion with a radius of 1.

Parameters:

  • clip

    (VideoNode) –

    Clip to process.

  • thr

    (float | None, default: None ) –

    Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than input - thr. The default is no limit.

  • iterations

    (int, default: 1 ) –

    Number of times to execute the function.

  • coords

    (Sequence[int] | None, default: None ) –

    Specifies which pixels from the 3x3 neighbourhood are considered. If an element of this array is 0, the corresponding pixel is not considered when finding the maximum value. This must contain exactly 8 numbers.

  • multiply

    (float | None, default: None ) –

    Optional multiplier of the final value.

  • planes

    (Planes, default: None ) –

    Which plane to process.

Source code in vsmasktools/morpho.py
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
@inject_self
def minimum(
    self,
    clip: vs.VideoNode,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any,
) -> ConstantFormatVideoNode:
    """
    Replaces each pixel with the smallest value in its 3x3 neighbourhood.
    This operation is also known as erosion with a radius of 1.

    Args:
        clip: Clip to process.
        thr: Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than
            input - thr. The default is no limit.
        iterations: Number of times to execute the function.
        coords: Specifies which pixels from the 3x3 neighbourhood are considered. If an element of this array is 0,
            the corresponding pixel is not considered when finding the maximum value. This must contain exactly 8
            numbers.
        multiply: Optional multiplier of the final value.
        planes: Which plane to process.
    """
    return self.erosion(clip, 1, thr, iterations, coords, multiply, planes, func=func, **kwargs)

opening

opening(
    clip: VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any
) -> ConstantFormatVideoNode

An opening is an erosion followed by an dilation.

Parameters:

  • clip

    (VideoNode) –

    Clip to process

  • radius

    (RadiusLike, default: 1 ) –

    A single integer specifies the size of the square matrix. A tuple of an integer and a ConvMode allows specification of the matrix type dimension as well.

  • thr

    (float | None, default: None ) –

    Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than input - thr. The default is no limit.

  • iterations

    (int, default: 1 ) –

    Number of times to execute the function.

  • coords

    (Sequence[int] | None, default: None ) –

    Specifies which pixels from the neighbourhood are considered. If an element of this array is 0, the corresponding pixel is not considered when finding the maximum value. This must contain exactly (radius * 2 + 1) ** 2 - 1 numbers eg. 8, 24, 48... When specified, this parameter takes precedence over radius.

  • multiply

    (float | None, default: None ) –

    Optional multiplier of the final value.

  • planes

    (Planes, default: None ) –

    Which plane to process.

Source code in vsmasktools/morpho.py
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
@inject_self
def opening(
    self,
    clip: vs.VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any,
) -> ConstantFormatVideoNode:
    """
    An opening is an erosion followed by an dilation.

    Args:
        clip: Clip to process
        radius: A single integer specifies the size of the square matrix. A tuple of an integer and a ConvMode
            allows specification of the matrix type dimension as well.
        thr: Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than
            input - thr. The default is no limit.
        iterations: Number of times to execute the function.
        coords: Specifies which pixels from the neighbourhood are considered. If an element of this array is 0, the
            corresponding pixel is not considered when finding the maximum value. This must contain exactly (radius
            * 2 + 1) ** 2 - 1 numbers eg. 8, 24, 48... When specified, this parameter takes precedence over radius.
        multiply: Optional multiplier of the final value.
        planes: Which plane to process.
    """
    func = func or self.opening

    eroded = self.erosion(clip, radius, thr, iterations, coords, multiply, planes, func=func, **kwargs)
    dilated = self.dilation(eroded, radius, thr, iterations, coords, multiply, planes, func=func, **kwargs)

    return dilated

outer_hat

outer_hat(
    clip: VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any
) -> ConstantFormatVideoNode

An outer hat is the difference of the dilation and the original clip.

Parameters:

  • clip

    (VideoNode) –

    Clip to process.

  • radius

    (RadiusLike, default: 1 ) –

    A single integer specifies the size of the square matrix. A tuple of an integer and a ConvMode allows specification of the matrix type dimension as well.

  • thr

    (float | None, default: None ) –

    Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than input - thr. The default is no limit.

  • iterations

    (int, default: 1 ) –

    Number of times to execute the function.

  • coords

    (Sequence[int] | None, default: None ) –

    Specifies which pixels from the neighbourhood are considered. If an element of this array is 0, the corresponding pixel is not considered when finding the maximum value. This must contain exactly (radius * 2 + 1) ** 2 - 1 numbers eg. 8, 24, 48... When specified, this parameter takes precedence over radius.

  • multiply

    (float | None, default: None ) –

    Optional multiplier of the final value.

  • planes

    (Planes, default: None ) –

    Which plane to process.

Source code in vsmasktools/morpho.py
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
@inject_self
def outer_hat(
    self,
    clip: vs.VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any,
) -> ConstantFormatVideoNode:
    """
    An outer hat is the difference of the dilation and the original clip.

    Args:
        clip: Clip to process.
        radius: A single integer specifies the size of the square matrix. A tuple of an integer and a ConvMode
            allows specification of the matrix type dimension as well.
        thr: Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than
            input - thr. The default is no limit.
        iterations: Number of times to execute the function.
        coords: Specifies which pixels from the neighbourhood are considered. If an element of this array is 0, the
            corresponding pixel is not considered when finding the maximum value. This must contain exactly (radius
            * 2 + 1) ** 2 - 1 numbers eg. 8, 24, 48... When specified, this parameter takes precedence over radius.
        multiply: Optional multiplier of the final value.
        planes: Which plane to process.
    """
    func = func or self.outer_hat

    assert check_variable_format(clip, func)

    if isinstance(radius, tuple):
        r, conv_mode = radius
    else:
        r, conv_mode = radius, ConvMode.SQUARE

    if iterations == 1 and conv_mode is not ConvMode.HV:
        return norm_expr(
            clip,
            "{dilated} {multiply} x -",
            planes,
            dilated=self._morpho_xx_imum(
                clip, (r, conv_mode), thr, coords, multiply, True, op=ExprOp.MAX, func=func
            )[0].to_str(),
            multiply="" if multiply is None else f"{multiply} *",
        )

    dilated = self.dilation(clip, radius, thr, iterations, coords, multiply, planes, func=func, **kwargs)

    return norm_expr([dilated, clip], "x y -", planes, func=func)

top_hat

top_hat(
    clip: VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any
) -> ConstantFormatVideoNode

A top hat or a white hat is the difference of the original clip and the opening.

Parameters:

  • clip

    (VideoNode) –

    Clip to process.

  • radius

    (RadiusLike, default: 1 ) –

    A single integer specifies the size of the square matrix. A tuple of an integer and a ConvMode allows specification of the matrix type dimension as well.

  • thr

    (float | None, default: None ) –

    Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than input - thr. The default is no limit.

  • iterations

    (int, default: 1 ) –

    Number of times to execute the function.

  • coords

    (Sequence[int] | None, default: None ) –

    Specifies which pixels from the neighbourhood are considered. If an element of this array is 0, the corresponding pixel is not considered when finding the maximum value. This must contain exactly (radius * 2 + 1) ** 2 - 1 numbers eg. 8, 24, 48... When specified, this parameter takes precedence over radius.

  • multiply

    (float | None, default: None ) –

    Optional multiplier of the final value.

  • planes

    (Planes, default: None ) –

    Which plane to process.

Source code in vsmasktools/morpho.py
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
@inject_self
def top_hat(
    self,
    clip: vs.VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any,
) -> ConstantFormatVideoNode:
    """
    A top hat or a white hat is the difference of the original clip and the opening.

    Args:
        clip: Clip to process.
        radius: A single integer specifies the size of the square matrix. A tuple of an integer and a ConvMode
            allows specification of the matrix type dimension as well.
        thr: Threshold (32-bit scale) to limit how much pixels are changed. Output pixels will not become less than
            input - thr. The default is no limit.
        iterations: Number of times to execute the function.
        coords: Specifies which pixels from the neighbourhood are considered. If an element of this array is 0, the
            corresponding pixel is not considered when finding the maximum value. This must contain exactly (radius
            * 2 + 1) ** 2 - 1 numbers eg. 8, 24, 48... When specified, this parameter takes precedence over radius.
        multiply: Optional multiplier of the final value.
        planes: Which plane to process.
    """
    func = func or self.top_hat

    assert check_variable_format(clip, func)

    opened = self.opening(clip, radius, thr, iterations, coords, multiply, planes, func=func, **kwargs)

    return norm_expr([clip, opened], "x y -", planes, func=func)

white_hate

white_hate(*args: Any, **kwargs: Any) -> ConstantFormatVideoNode

Alias for top_hat

Source code in vsmasktools/morpho.py
507
508
509
510
511
@copy_signature(top_hat)
@inject_self
def white_hate(self, *args: Any, **kwargs: Any) -> ConstantFormatVideoNode:
    """Alias for [top_hat][vsmasktools.Morpho.top_hat]"""
    return self.top_hat(*args, **{"func": self.white_hate} | kwargs)

grow_mask

grow_mask(
    clip: VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any
) -> ConstantFormatVideoNode
Source code in vsmasktools/morpho.py
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
def grow_mask(
    clip: vs.VideoNode,
    radius: RadiusLike = 1,
    thr: float | None = None,
    iterations: int = 1,
    coords: Sequence[int] | None = None,
    multiply: float | None = None,
    planes: Planes = None,
    *,
    func: FuncExcept | None = None,
    **kwargs: Any,
) -> ConstantFormatVideoNode:
    func = func or grow_mask

    morpho = Morpho()

    closed = morpho.closing(clip, radius, thr, 1, coords, None, planes, func=func, **kwargs)
    dilated = morpho.dilation(closed, radius, thr, 1, coords, None, planes, func=func, **kwargs)
    outer = morpho.outer_hat(dilated, radius, thr, iterations, coords, None, planes, func=func, **kwargs)

    blurred = BlurMatrix.BINOMIAL()(outer, planes=planes)

    if multiply:
        return norm_expr(blurred, "x {multiply} *", multiply=multiply, func=func)

    return blurred