lattice/pyerrors
1
0
Fork 0
mirror of https://github.com/fjosw/pyerrors.git synced 2025-03-18 08:10:24 +01:00
Code Issues Projects Releases Packages Wiki Activity

docstring added to Corr.plateau

Browse source
This commit is contained in:
Fabian Joswig 2021-11-02 12:04:42 +00:00
parent d9f4e5b453
commit 55f42327a2
1 changed files with 13 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
pyerrors/correlators.py
View file

@ -361,6 +361,18 @@ class Corr:
return result return result
def plateau(self, plateau_range=None, method="fit"): def plateau(self, plateau_range=None, method="fit"):
""" Extract a plateu value from a Corr object
Attributes:
-----------
plateau_range : list
list with two entries, indicating the first and the last timeslice
of the plateau region.
method : str
method to extract the plateau.
'fit' fits a constant to the plateau region
'avg', 'average' or 'mean' just average over the given timeslices.
"""
if not plateau_range: if not plateau_range:
if self.prange: if self.prange:
plateau_range = self.prange plateau_range = self.prange
@ -372,7 +384,7 @@ class Corr:
raise Exception("plateau is undefined at all timeslices in plateaurange.") raise Exception("plateau is undefined at all timeslices in plateaurange.")
if method == "fit": if method == "fit":
def const_func(a, t): def const_func(a, t):
return a[0] # At some point pe.standard fit had an issue with single parameter fits. Being careful does not hurt return a[0]
return self.fit(const_func, plateau_range)[0] return self.fit(const_func, plateau_range)[0]
elif method in ["avg", "average", "mean"]: elif method in ["avg", "average", "mean"]:
returnvalue = np.mean([item[0] for item in self.content[plateau_range[0]:plateau_range[1] + 1] if item is not None]) returnvalue = np.mean([item[0] for item in self.content[plateau_range[0]:plateau_range[1] + 1] if item is not None])