vpi.Image.box_filter

Image.box_filter(self: vpi.Image, ksize: Union[tuple[int, int], int], *, backend: vpi.Backend = vpi.Backend.DEFAULT, out: vpi.Image = None, border: vpi.Border = vpi.Border.CLAMP, stream: vpi.Stream = None) → vpi.Image

Runs a 2D box filter over the image.

See also

Refer to the algorithm explanation for more details and usage examples.

Parameters

  • ksize (Tuple[int, int] or int) – The kernel size as either (1) a tuple of two ints or (2) a single int, where (1) defines the X and Y directions and (2) defines both.

  • out (vpi.Image, optional) – The output for the algorithm.

  • border (vpi.Border, optional) – The border extension used by the algorithm.

  • backend (vpi.Backend, optional) – The backend to be used by the algorithm.

  • stream (vpi.Stream, optional) – The stream to be used by the algorithm.

Returns

The output for the algorithm.

Return type

vpi.Image

Caution

Restrictions to several arguments may apply. Check the C API references of the submit function and the group concepts for more details.