Out-of-the-Box Fit Functions¶
-
fitting_functions_list.linear(x: Union[<sphinx.ext.autodoc.importer._MockObject object at 0x7f36c2ceb990>, float]) → Union[<sphinx.ext.autodoc.importer._MockObject object at 0x7f36c2ceba50>, float]¶ Simple linear fitting function.
Syntax:
y = a[0] + a[1] * xParameters: - a (
numpy.ndarray) – Coefficients array of length 2 - x (
numpy.ndarrayorfloat) – Free parameter
Returns: numpy.ndarrayorfloat- a (
-
fitting_functions_list.constant(x: Union[<sphinx.ext.autodoc.importer._MockObject object at 0x7f36c2cebcd0>, float]) → Union[<sphinx.ext.autodoc.importer._MockObject object at 0x7f36c2cebd90>, float]¶ Constant fitting function.
Syntax:
y = a[0]Parameters: - a (
numpy.ndarray) – Coefficients array of length 1 - x (
numpy.ndarrayorfloat) – Free parameter
Returns: numpy.ndarrayorfloat- a (
-
fitting_functions_list.parabolic(x: Union[<sphinx.ext.autodoc.importer._MockObject object at 0x7f36c2cf3050>, float]) → Union[<sphinx.ext.autodoc.importer._MockObject object at 0x7f36c2cf3110>, float]¶ Parabolic fitting function.
Syntax:
y = a[0] + a[1] * x + a[2] * x ^ 2Parameters: - a (
numpy.ndarray) – Coefficients array of length 3 - x (
numpy.ndarrayorfloat) – Free parameter
Returns: numpy.ndarrayorfloat- a (
-
fitting_functions_list.straight_power(x: Union[<sphinx.ext.autodoc.importer._MockObject object at 0x7f36c2cf3390>, float]) → Union[<sphinx.ext.autodoc.importer._MockObject object at 0x7f36c2cf3450>, float]¶ Represent fitting of y ~ x^n.
Syntax:
y = a[0] * (x + a[1]) ^ a[2] + a[3]Parameters: - a (
numpy.ndarray) – Coefficients array of length 4 - x (
numpy.ndarrayorfloat) – Free parameter
Returns: numpy.ndarrayorfloat- a (
-
fitting_functions_list.inverse_power(x: Union[<sphinx.ext.autodoc.importer._MockObject object at 0x7f36c2cf36d0>, float]) → Union[<sphinx.ext.autodoc.importer._MockObject object at 0x7f36c2cf3790>, float]¶ Represent fitting of y ~ x^(-n).
Syntax:
y = a[0] / (x + a[1]) ^ a[2] + a[3]Parameters: - a (
numpy.ndarray) – Coefficients array of length 4 - x (
numpy.ndarrayorfloat) – Free parameter
Returns: numpy.ndarrayorfloat- a (
-
fitting_functions_list.polynomial() → eddington.fitting_function_class.FittingFunction¶ Creates a polynomial fitting function with parameters as coefficients.
Parameters: n – Degree of the polynom. Returns: FittingFunction
-
fitting_functions_list.hyperbolic(x: Union[<sphinx.ext.autodoc.importer._MockObject object at 0x7f36c2cf3a10>, float]) → Union[<sphinx.ext.autodoc.importer._MockObject object at 0x7f36c2cf3ad0>, float]¶ Hyperbolic fitting function.
Syntax:
y = a[0] / (x + a[1]) + a[2]Parameters: - a (
numpy.ndarray) – Coefficients array of length 3 - x (
numpy.ndarrayorfloat) – Free parameter
Returns: numpy.ndarrayorfloat- a (
-
fitting_functions_list.exponential(x: Union[<sphinx.ext.autodoc.importer._MockObject object at 0x7f36c2cf3d50>, float]) → Union[<sphinx.ext.autodoc.importer._MockObject object at 0x7f36c2cf3e10>, float]¶ Exponential fitting function.
Syntax:
y = a[0] * exp(a[1] * x) + a[2]Parameters: - a (
numpy.ndarray) – Coefficients array of length 3 - x (
numpy.ndarrayorfloat) – Free parameter
Returns: numpy.ndarrayorfloat- a (
-
fitting_functions_list.sin(x: Union[<sphinx.ext.autodoc.importer._MockObject object at 0x7f36c2cf9410>, float]) → Union[<sphinx.ext.autodoc.importer._MockObject object at 0x7f36c2cf94d0>, float]¶ Sine fitting function.
Syntax:
y = a[0] * sin(a[1] * x + a[2]) + a[3]Parameters: - a (
numpy.ndarray) – Coefficients array of length 4 - x (
numpy.ndarrayorfloat) – Free parameter
Returns: numpy.ndarrayorfloat- a (
-
fitting_functions_list.cos(x: Union[<sphinx.ext.autodoc.importer._MockObject object at 0x7f36c2cf90d0>, float]) → Union[<sphinx.ext.autodoc.importer._MockObject object at 0x7f36c2cf9190>, float]¶ Cosines fitting function.
Syntax:
y = a[0] * cos(a[1] * x + a[2]) + a[3]Parameters: - a (
numpy.ndarray) – Coefficients array of length 4 - x (
numpy.ndarrayorfloat) – Free parameter
Returns: numpy.ndarrayorfloat- a (
-
fitting_functions_list.normal(x: Union[<sphinx.ext.autodoc.importer._MockObject object at 0x7f36c2cf9750>, float]) → Union[<sphinx.ext.autodoc.importer._MockObject object at 0x7f36c2cf9810>, float]¶ Normal distribution fitting function.
Syntax:
y = a[0] * exp( - ((x - a[1]) / a[2]) ^ 2) + a[3]Parameters: - a (
numpy.ndarray) – Coefficients array of length 4 - x (
numpy.ndarrayorfloat) – Free parameter
Returns: numpy.ndarrayorfloat- a (
-
fitting_functions_list.poisson(x: Union[<sphinx.ext.autodoc.importer._MockObject object at 0x7f36c2cf9a90>, float]) → Union[<sphinx.ext.autodoc.importer._MockObject object at 0x7f36c2cf9b50>, float]¶ Poisson fitting function.
Syntax:
y = a[0] * (a[1] ^ x) * exp(-a[1]) / gamma(x+1) + a[2]Parameters: - a (
numpy.ndarray) – Coefficients array of length 3 - x (
numpy.ndarrayorfloat) – Free parameter
Returns: numpy.ndarrayorfloat- a (