pyrfu.pyrf.histogram module#
- pyrfu.pyrf.histogram.histogram(inp, bins=100, y_range=None, weights=None, density=True)[source]#
Computes 1D histogram of the inp with bins bins
- Parameters:
inp (xarray.DataArray) – Time series of the input scalar variable.
bins (str or int or array_like, Optional) – Number of bins. Default is
bins=100.y_range ((float, float), Optional) – The lower and upper range of the bins. If not provided, range is simply
(inp.min(), inp.max()). Values outside the range are ignored. The first element of the range must be less than or equal to the second. range affects the automatic bin computation as well. While bin width is computed to be optimal based on the actual data within range, the bin count will fill the entire range including portions containing no data.weights (array_like, Optional) – An array of weights, of the same shape as inp. Each value in inp only contributes its associated weight towards the bin count (instead of 1). If density is True, the weights are normalized, so that the integral of the density over the range remains 1.
density (bool, Optional) – If
False, the result will contain the number of samples in each bin. IfTrue, the result is the value of the probability density function at the bin, normalized such that the integral over the range is 1. Note that the sum of the histogram values will not be equal to 1 unless bins of unity width are chosen; it is not a probability mass function.
- Returns:
out – 1D distribution of the input time series.
- Return type: