lattice/pyerrors
1
0
Fork 0
mirror of https://github.com/fjosw/pyerrors.git synced 2025-03-15 14:50:25 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs: warning added to docstring of covariance.

Browse source
This commit is contained in:
Fabian Joswig 2022-11-16 10:43:12 +00:00
parent d7fd101145
commit c0e3c433d0
No known key found for this signature in database
1 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
pyerrors/obs.py
View file

@ -1430,6 +1430,9 @@ def correlate(obs_a, obs_b):
def covariance(obs, visualize=False, correlation=False, smooth=None, **kwargs):
r'''Calculates the error covariance matrix of a set of observables.
WARNING: This function should be used with care, especially for observables with support on multiple
ensembles with differing autocorrelations. See the notes below for details.
The gamma method has to be applied first to all observables.
Parameters