vpi.Image.image_stats

Image.image_stats(self: vpi.Image, mask: vpi.Image = None, *, backend: vpi.Backend = vpi.Backend.DEFAULT, out: vpi.Array = None, flags: int = 15, stream: vpi.Stream = None) → vpi.Array

Computes the image statistics.

See also

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

Parameters

  • mask (vpi.Image, optional) – Specifies the neighbourhood of the operation. Pass null for full neighbourhood.

  • out (vpi.Array, optional) – Output array with the resulting image statistics.

  • flags (vpi.ImageStatistics) – Specifies the statistics to be calculated.

  • 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 image statistics.

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.