vpi.Image.histogram
- Image.histogram(self: vpi.Image, bins: Optional[int] = None, *, backend: vpi.Backend = vpi.Backend.DEFAULT, out: vpi.Array = None, range: Optional[tuple[float, float]] = None, accum: bool = False, stream: vpi.Stream = None) vpi.Array
Computes the image histogram.
See also
Refer to the algorithm explanation for more details and usage examples.
- Parameters
bins (int, optional) – Specifies the number of bins in the output array. It is inferred if missing using the output array capacity as the maximum number of bins. Use maximum range if missing.
out (vpi.Array, optional) – Output array with the resulting image histogram. The output array capacity is used as the maximum number of bins when the bins argument is missing.
range (Tuple[float, float], optional) – Specifies the low end (start) and high end (end) of the histogram range (inclusive), respectively.
accum (bool, optional) – Set to True to accumulate on existing values in the output array.
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 histogram.
- Return type
Caution
Restrictions to several arguments may apply. Check the C API references of the submit function and the group concepts for more details.