document logscale_hist

This commit is contained in:
markus 2021-01-19 14:20:52 +01:00
parent a318cc1ecd
commit 1c35917909

View file

@ -1,6 +1,6 @@
import numpy as np import numpy as np
import scipy.stats as sct import scipy.stats as sct
from typing import Optional from typing import Optional, Iterable
import matplotlib.pyplot as plt import matplotlib.pyplot as plt
@ -53,7 +53,13 @@ def generate_qr_values(samples: int, expiratory_activity: int, masked: bool, qid
return qr_func(viral_loads, emissions, diameters, mask_efficiency, qid) return qr_func(viral_loads, emissions, diameters, mask_efficiency, qid)
def logscale_hist(x, bins): def logscale_hist(x: Iterable, bins: int) -> None:
"""
Plots the data of x as a log-scale histogram
:param x: An array containing the data to be plotted
:param bins: The number of bins to be used in the histogram (number of bars)
:return: Nothing
"""
hist, bins = np.histogram(x, bins=bins) hist, bins = np.histogram(x, bins=bins)
logscale_bins = np.logspace(np.log10(bins[0]), np.log10(bins[-1]), len(bins)) logscale_bins = np.logspace(np.log10(bins[0]), np.log10(bins[-1]), len(bins))
plt.hist(x, bins=logscale_bins) plt.hist(x, bins=logscale_bins)