get_peak

sherpa.utils.guess.get_peak(y: ndarray, x: ndarray, xhi: ndarray | None = None) → float[source] [edit on github]

Estimate the peak position of the data.

Parameters:

y, xarray_like: The data points.
xhiNone or array_like, optional: If given then the x array is taken to be the low-edge of each bin.

Returns:

ansscalar: The X position of the peak.

See also

get_fwhm, get_midpoint, get_valley

Notes

If there are multiple peaks of the same height then the location of the first peak is used.