[reproclasses/FICurve] add documentation

This commit is contained in:
Jan Grewe 2019-10-09 11:41:04 +02:00
parent 2c4f3afa56
commit b009cf673a

View File

@ -357,10 +357,17 @@ class BoltzmannFit:
@property @property
def x_data(self): def x_data(self):
""" The x data sorted and unique used for fitting.
:return: the x data
"""
return self.__x_sorted return self.__x_sorted
@property @property
def y_data(self): def y_data(self):
"""
the Y data used for fitting, i.e. the average rate in the specified time window sorted by the x data.
:return: the average and the standard deviation of the y data
"""
return self.__y_avg, self.__y_err return self.__y_avg, self.__y_err
def solve(self, xvalues=None): def solve(self, xvalues=None):