vpi.Image.minloc

Image.minloc(self: vpi.Image, *, backend: vpi.Backend = vpi.Backend.DEFAULT, out_min_coords: vpi.Array = None, min_capacity: int = 1, stream: vpi.Stream = None) → vpi.Array

Find minimum value locations in an image.

Note

If an output array is not provided, they are created with the capacity as given by the corresponding argument.

See also

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

Parameters

  • min_capacity (int, optional) – Capacity of the created minimum array when output is missing.

  • out_min_coords (vpi.Array, optional) – Output array with pixel coordinates of the minimum value.

  • 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 minimum coordinates output array.

Return type

vpi.Array

Caution

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