Note

This is the documentation for the current state of the development branch of Qiskit Experiments. The documentation or APIs here can change prior to being released.

max_height

max_height(y, percentile=None, absolute=False)[source]

Get maximum value of y curve and its index.

Parameters:

  • y (ndarray) – Array of y values.

  • percentile (float | None) – Return that percentile value if provided, otherwise just return max value.

  • absolute (bool) – Use absolute y value.

Returns:

The maximum y value and index.

Return type:

Tuple[float, int]