pyhctsa.operations.distribution.histogram_mode

pyhctsa.operations.distribution.histogram_mode(y, num_bins=10, do_simple=True)

Measures the mode of the data vector using histograms with a given number of bins.

Parameters:
y : array-like

the input data vector

num_bins : int, optional

the number of bins to use in the histogram

do_simple : bool, optional

whether to use a simple binning method (linearly spaced bins)

Returns:

The mode of the data vector using histograms with num_bins bins.

Return type:

float