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

docs: clarification on Corr.fit fitrange added.

Browse source
This commit is contained in:
Fabian Joswig 2022-04-19 13:13:45 +01:00
parent c9f65298b4
commit 9b356c9e97
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
pyerrors/correlators.py
View file

@ -621,7 +621,7 @@ class Corr:
raise Exception('Unknown variant.')
def fit(self, function, fitrange=None, silent=False, **kwargs):
"""Fits function to the data
r'''Fits function to the data
Parameters
----------
@ -629,10 +629,12 @@ class Corr:
function to fit to the data. See fits.least_squares for details.
fitrange : list
Two element list containing the timeslices on which the fit is supposed to start and stop.
Caution: This range is inclusive as opposed to standard python indexing.
`fitrange=[4, 6]` corresponds to the three entries 4, 5 and 6.
If not specified, self.prange or all timeslices are used.
silent : bool
Decides whether output is printed to the standard output.
"""
'''
if self.N != 1:
raise Exception("Correlator must be projected before fitting")