From 11007dffc9d7f0e2081fde9a6a1f6c1e045629c9 Mon Sep 17 00:00:00 2001 From: Fabian Joswig Date: Wed, 2 Mar 2022 11:11:48 +0000 Subject: [PATCH] docs: docstrings of covariance and _covariance_element clarified --- pyerrors/obs.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pyerrors/obs.py b/pyerrors/obs.py index 4b6a431a..69af5cea 100644 --- a/pyerrors/obs.py +++ b/pyerrors/obs.py @@ -1348,7 +1348,7 @@ def covariance(obs, visualize=False, correlation=False, **kwargs): Notes ----- - The covariance is estimated by calculating the correlation matrix assuming no autocorrelation and then rescaling the correlation matrix by the full errors including the previous gamma method estimate for the autocorrelation of the observables. This is equivalent to assuming that the integrated autocorrelation time of an off-diagonal element is equal to the geometric mean of the integrated autocorrelation times of the corresponding diagonal elements. + The covariance is estimated by calculating the correlation matrix assuming no autocorrelation and then rescaling the correlation matrix by the full errors including the previous gamma method estimate for the autocorrelation of the observables. For observables defined on a single ensemble this is equivalent to assuming that the integrated autocorrelation time of an off-diagonal element is equal to the geometric mean of the integrated autocorrelation times of the corresponding diagonal elements. $$ \tau_{\mathrm{int}, ij}=\sqrt{\tau_{\mathrm{int}, i}\times \tau_{\mathrm{int}, j}} $$ @@ -1384,7 +1384,7 @@ def covariance(obs, visualize=False, correlation=False, **kwargs): def _covariance_element(obs1, obs2): - """Estimates the uncorrelated covariance of two Obs objects.""" + """Estimates the covariance of two Obs objects, neglecting autocorrelations.""" def expand_deltas(deltas, idx, shape, new_idx): """Expand deltas defined on idx to a contiguous range [new_idx[0], new_idx[-1]].