vpi.Image.canny

Image.canny(self: vpi.Image, *, backend: vpi.Backend = vpi.Backend.DEFAULT, out: vpi.Image = None, norm: vpi.Norm = vpi.Norm.L2, grad_method: vpi.GradientMethod = vpi.GradientMethod.SOBEL, grad_size: int = 3, thresh_strong: float, thresh_weak: float, edge_value: float = 1, nonedge_value: float = 0, stream: vpi.Stream = None) → vpi.Image

Runs Canny edge detector on the image.

See also

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

Parameters

  • out (vpi.Image, optional) – The output for 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.

  • norm (vpi.Norm, optional) – Determine the norm to calculate the gradient intensity.

  • grad_method (vpi.gradientMethod, optional) – Determine the method to generate the gradients.

  • grad_size (int, optional) – Determine the window size to calculate the gradients.

  • thresh_strong (float) – Strong threshold for the hysteresis procedure.

  • thresh_weak (float) – Weak threshold for the hysteresis procedure.

  • edge_value (float, optional) – Value used to mark edge.

  • nonedge_value (float, optional) – Value used to mark non-edge.

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.