This repository has been archived by the owner on Jun 12, 2023. It is now read-only.
Add better explanation comments for the QV fitter module #481
Labels
documentation
Something is not clear or error in description
While attempting to solve issue #473, I try to read and understand the code in QV fitter module. I find the code difficult to understand. It assumes very good level of understanding of statistics.
For example, when calculating the confidence level, the equation
cfd = 0.5 * (1 + math.erf((hmean - 2/3)/ (1e-10 + self._ydata[1][depth_ind])/2**0.5))
come out from nowhere. It should be great to add some comments to explain why the confidence level can be calculated using the equation. (see this comment #473 (comment))Another example is in the
calc_statistics
method. In lines 243-250:It's not clear what each line does. If I understand it correctly, the first line
self._ydata[0][depthidx]
calculateshmean
, the second lineself._ydata[1][depthidx]
calculates the standard deviation sigma, the third lineself._ydata[2][depthidx]
calculates the idealhmean
and the fourth lineself._ydata[3][depthidx]
calculate the ideal standard deviation sigma.I don't understand how we can calculate sigma using only
mean
andntrials
:(
The text was updated successfully, but these errors were encountered: