docs: warning added to docstring of covariance.

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

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