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

docstring added to m_eff

Browse source
This commit is contained in:
Fabian Joswig 2021-09-27 12:03:42 +01:00
parent 1ea8655684
commit 013c43fd4b
1 changed files with 22 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
pyerrors/correlators.py
View file

@ -198,13 +198,18 @@ class Corr:
else: else:
newcontent.append(0.5 * (self.content[t + 1] - self.content[t - 1])) newcontent.append(0.5 * (self.content[t + 1] - self.content[t - 1]))
if(all([x is None for x in newcontent])): if(all([x is None for x in newcontent])):
raise Exception("Derivative is undefined at all timeslices") raise Exception('Derivative is undefined at all timeslices')
return Corr(newcontent, padding_back=1, padding_front=1) return Corr(newcontent, padding_back=1, padding_front=1)
#effective mass at every timeslice
def m_eff(self, periodic=False): def m_eff(self, periodic=False):
"""Returns the effective mass of the correlator as correlator object
Parameters
----------
x_range -- if true the function uses arccosh( (C(t+1)+C(t-1)) / (2C(t) ) instead of the standard expression for the effective mass
"""
if self.N != 1: if self.N != 1:
raise Exception("Correlator must be projected before getting m_eff") raise Exception('Correlator must be projected before getting m_eff')
if not periodic: if not periodic:
newcontent = [] newcontent = []
for t in range(self.T - 1): for t in range(self.T - 1):
@ -213,11 +218,11 @@ class Corr:
else: else:
newcontent.append(self.content[t] / self.content[t + 1]) newcontent.append(self.content[t] / self.content[t + 1])
if(all([x is None for x in newcontent])): if(all([x is None for x in newcontent])):
raise Exception("m_eff is undefined at all timeslices") raise Exception('m_eff is undefined at all timeslices')
return np.log(Corr(newcontent, padding_back=1)) return np.log(Corr(newcontent, padding_back=1))
else: #This is usually not very stable. else: # This is usually not very stable.
newcontent = [] newcontent = []
for t in range(1, self.T - 1): for t in range(1, self.T - 1):
if (self.content[t] is None) or (self.content[t + 1] is None)or (self.content[t - 1] is None): if (self.content[t] is None) or (self.content[t + 1] is None)or (self.content[t - 1] is None):
@ -225,8 +230,8 @@ class Corr:
else: else:
newcontent.append((self.content[t + 1] + self.content[t - 1]) / (2 * self.content[t])) newcontent.append((self.content[t + 1] + self.content[t - 1]) / (2 * self.content[t]))
if(all([x is None for x in newcontent])): if(all([x is None for x in newcontent])):
raise Exception("m_eff is undefined at all timeslices") raise Exception('m_eff is undefined at all timeslices')
return np.arccosh(Corr(newcontent,padding_back=1, padding_front=1)) return np.arccosh(Corr(newcontent, padding_back=1, padding_front=1))
#We want to apply a pe.standard_fit directly to the Corr using an arbitrary function and range. #We want to apply a pe.standard_fit directly to the Corr using an arbitrary function and range.
@ -264,14 +269,15 @@ class Corr:
#quick and dirty plotting function to view Correlator inside Jupyter #quick and dirty plotting function to view Correlator inside Jupyter
#If one would not want to import pyplot, this could easily be replaced by a call to pe.plot_corrs #If one would not want to import pyplot, this could easily be replaced by a call to pe.plot_corrs
#This might be a bit more flexible later #This might be a bit more flexible later
def show(self, x_range=None, comp=None, logscale=False): def show(self, x_range=None, comp=None, logscale=False, save=None):
"""Plots the correlator, uses tag as label if available. """Plots the correlator, uses tag as label if available.
Parameters Parameters
---------- ----------
x_range -- list of two values, determining the range of the x-axis e.g. [4, 8] x_range -- list of two values, determining the range of the x-axis e.g. [4, 8]
comp -- Correlator or list of correlators which are plotted for comparison. comp -- Correlator or list of correlators which are plotted for comparison.
logscale -- Sets y-axis to logsclae logscale -- Sets y-axis to logscale
save -- path to file in which the figure should be saved
""" """
if self.N!=1: if self.N!=1:
raise Exception("Correlator must be projected before plotting") raise Exception("Correlator must be projected before plotting")
@ -306,6 +312,13 @@ class Corr:
if labels: if labels:
legend = ax1.legend() legend = ax1.legend()
plt.show() plt.show()
if save:
if isinstance(save, str):
fig.savefig(save)
else:
raise Exception('safe has to be a string.')
return return
def dump(self,filename): def dump(self,filename):