smpl 1.5.3.dev5__tar.gz → 1.5.4__tar.gz

{smpl-1.5.3.dev5 → smpl-1.5.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: smpl
-Version: 1.5.3.dev5
+Version: 1.5.4
 Summary: SiMPLe plotting and fitting
 Project-URL: Documentation, https://smpl.readthedocs.io/
 Project-URL: Issues, https://github.com/APN-Pucky/smpl/issues

{smpl-1.5.3.dev5 → smpl-1.5.4}/smpl/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.5.3.dev5'
-__version_tuple__ = version_tuple = (1, 5, 3, 'dev5')
+__version__ = version = '1.5.4'
+__version_tuple__ = version_tuple = (1, 5, 4)

{smpl-1.5.3.dev5 → smpl-1.5.4}/smpl/fit.py

@@ -236,8 +236,29 @@ def _unwrap_param(fitt, fixed, Ntot):
 def Chi2(datax, datay, function, ff, **kwargs):
     kwargs = fit_kwargs(kwargs)
     x, y, _, yerr = fit_split(datax, datay, **kwargs)
-    sigmas = yerr
-    return stat.Chi2(y, unv(function(x, *ff)), sigmas)
+    f = function(x, *ff)
+    sigmas = (yerr**2 + usd(f) ** 2) ** 0.5
+    return stat.Chi2(y, unv(f), sigmas)
+
+
+def Dof(datax, datay, function, ff, **kwargs):
+    """Calculate the degrees of freedom for a fit."""
+    kwargs = fit_kwargs(kwargs)
+    x, y, _, yerr = fit_split(datax, datay, **kwargs)
+    f = function(x, *ff)
+
+    # Obtain the number of fitted parameters
+    # by counting the number of non-fixed parameters
+    # This assumes that the fit function has parameters
+    # in the order: x, param1, param2, ..., paramN
+    # and that fixed parameters are provided in kwargs
+    _, _, fixed, Ntot = _wrap_func_and_param(function, **kwargs)
+
+    # Number of points fitted
+    N_points = len(y)
+
+    # Fixed parameters do not count towards degrees of freedom
+    return N_points - Ntot + len(fixed)
 
 
 @doc.insert_doc(stat.R2)

{smpl-1.5.3.dev5 → smpl-1.5.4}/smpl/plot.py

@@ -214,6 +214,9 @@ default = {
         "xspace gets called with xspace(xmin,xmax,steps) in :func:`function` to get the points of the function that will be drawn.",
     ],
     "alpha": [0.2, "alpha value for the fill_between plot"],
+    "append_chi2": [False, "Append chi2 to legend"],
+    "append_r2": [False, "Append r2 to legend"],
+    "append_dof": [False, "Append degrees of freedom to legend"],
 }
 
 
@@ -272,11 +275,11 @@ def fit(func, *adata, **kwargs):
         1.0
 
     """
-    if "xaxis" in kwargs and not kwargs["xlabel"]:
+    if "xaxis" in kwargs and ("xlabel" not in kwargs or not kwargs["xlabel"]):
         # warnings.warn("xaxis is deprecated. Use xlabel instead.", DeprecationWarning, 2)
         kwargs["xlabel"] = kwargs["xaxis"]
         # TODO maybe pop
-    if "yaxis" in kwargs and not kwargs["ylabel"]:
+    if "yaxis" in kwargs and ("ylabel" not in kwargs or not kwargs["ylabel"]):
         # warnings.warn("yaxis is deprecated. Use ylabel instead.", DeprecationWarning, 2)
         kwargs["ylabel"] = kwargs["yaxis"]
         # TODO maybe pop
@@ -555,6 +558,9 @@ def __function(
         "steps",
         "interpolator",
         "next_color",
+        "append_chi2",
+        "append_r2",
+        "append_dof",
     ]:
         kwargs.pop(key, None)
     func = gfunc
@@ -799,7 +805,7 @@ def plt_data(datax, datay, **kwargs):
     return ll
 
 
-def get_fnc_legend(function, rfit, **kwargs):
+def get_fnc_legend(function, rfit, datax=None, datay=None, **kwargs):
     l = wrap.get_latex(function)
 
     vnames = wrap.get_varnames(function, kwargs["xvar"])
@@ -817,6 +823,42 @@ def get_fnc_legend(function, rfit, **kwargs):
             l = l + ")"
         if kwargs["units"] is not None:
             l = l + " " + kwargs["units"][i - 1]
+
+    # Append Chi2, R2, and DOF if requested and data is available
+    if datax is not None and datay is not None:
+        if kwargs.get("append_chi2", False):
+            try:
+                chi2_val = ffit.Chi2(datax, datay, function, rfit, **kwargs)
+                l = l + ("\n" if not kwargs["fitinline"] else " ")
+                if "number_format" in kwargs:
+                    l = l + "$\\chi^2$=" + kwargs["number_format"].format(chi2_val)
+                else:
+                    l = l + "$\\chi^2$=%s" % (chi2_val)
+            except Exception:
+                pass  # Ignore errors in Chi2 calculation
+
+        if kwargs.get("append_r2", False):
+            try:
+                r2_val = ffit.R2(datax, datay, function, rfit, **kwargs)
+                l = l + ("\n" if not kwargs["fitinline"] else " ")
+                if "number_format" in kwargs:
+                    l = l + "$R^2$=" + kwargs["number_format"].format(r2_val)
+                else:
+                    l = l + "$R^2$=%s" % (r2_val)
+            except Exception:
+                pass  # Ignore errors in R2 calculation
+
+        if kwargs.get("append_dof", False):
+            try:
+                dof_val = ffit.Dof(datax, datay, function, rfit, **kwargs)
+                l = l + ("\n" if not kwargs["fitinline"] else " ")
+                if "number_format" in kwargs:
+                    l = l + "DOF=" + kwargs["number_format"].format(dof_val)
+                else:
+                    l = l + "DOF=%s" % (dof_val)
+            except Exception:
+                pass  # Ignore errors in DOF calculation
+
     return l
 
 
@@ -906,7 +948,7 @@ def plt_fit(datax, datay, gfunction, **kwargs):
     for v in vnames[1:]:  # remove fixed parameters from kwargs
         kwargs.pop(v, None)
 
-    l = get_fnc_legend(gfunction, rfit, **kwargs)
+    l = get_fnc_legend(gfunction, rfit, datax, datay, **kwargs)
     return (rfit, *plt_fit_or_interpolate(datax, datay, fitted, l, **kwargs))
 
 

{smpl-1.5.3.dev5 → smpl-1.5.4}/smpl/plot2d.py

@@ -53,13 +53,13 @@ def plot2d(datax, datay, dataz, **kwargs):
         see :func:`plot2d_kwargs`.
     """
     kwargs = plot2d_kwargs(kwargs)
-    if "xaxis" in kwargs and not kwargs["xlabel"]:
+    if "xaxis" in kwargs and ("xlabel" not in kwargs or not kwargs["xlabel"]):
         # warnings.warn("xaxis is deprecated. Use xlabel instead.", DeprecationWarning, 2)
         kwargs["xlabel"] = kwargs["xaxis"]
-    if "yaxis" in kwargs and not kwargs["ylabel"]:
+    if "yaxis" in kwargs and ("ylabel" not in kwargs or not kwargs["ylabel"]):
         # warnings.warn("yaxis is deprecated. Use ylabel instead.", DeprecationWarning, 2)
         kwargs["ylabel"] = kwargs["yaxis"]
-    if "zaxis" in kwargs and not kwargs["zlabel"]:
+    if "zaxis" in kwargs and ("zlabel" not in kwargs or not kwargs["zlabel"]):
         # warnings.warn("zaxis is deprecated. Use zlabel instead.", DeprecationWarning, 2)
         kwargs["zlabel"] = kwargs["zaxis"]
 

smpl-1.5.4/test_chi2_r2_legend.py

@@ -0,0 +1,29 @@
+#!/usr/bin/env python3
+"""Test script for append_chi2 and append_r2 functionality."""
+
+import numpy as np
+import matplotlib.pyplot as plt
+from smpl import plot, functions
+
+# Generate some test data
+np.random.seed(42)
+x = np.linspace(0, 10, 50)
+y_true = 2 * x + 3  # linear function: y = 2x + 3
+y = y_true + np.random.normal(0, 1, len(x))  # add some noise
+
+# Test 1: Basic fit without chi2/r2
+print("Test 1: Basic fit without chi2/r2")
+plt.figure(figsize=(12, 4))
+
+# Test 2: Fit with chi2 appended
+print("Test 2: Fit with chi2 appended")
+params2 = plot.fit(x, y, functions.line, label="With Chi2", append_chi2=True, init=True,fselector=lambda x,y : (x<2))
+plt.title("With Chi2")
+plt.legend()
+
+
+plt.tight_layout()
+plt.savefig("test_chi2_r2_legend.png", dpi=150, bbox_inches='tight')
+plt.show()
+
+print("Test completed successfully!")

smpl-1.5.4/test_dof_append.py

@@ -0,0 +1,33 @@
+#!/usr/bin/env python3
+"""Test script for append_dof functionality."""
+
+import numpy as np
+import matplotlib.pyplot as plt
+from smpl import plot, functions
+
+# Generate test data
+x = np.linspace(0, 5, 20)
+y = 2 * x + 1 + np.random.normal(0, 0.5, len(x))  # Linear with noise
+
+print("Testing append_dof functionality...")
+
+# Test 1: Basic fit without DOF
+print("Test 1: Basic fit without DOF")
+params1 = plot.fit(x, y, functions.line, label="Without DOF", init=True)
+plt.title("Without DOF")
+plt.show()
+
+# Test 2: Fit with DOF appended
+print("Test 2: Fit with DOF appended")
+params2 = plot.fit(x, y, functions.line, label="With DOF", append_dof=True, init=True)
+plt.title("With DOF")
+plt.show()
+
+# Test 3: Fit with Chi2, R2, and DOF all appended
+print("Test 3: Fit with Chi2, R2, and DOF all appended")
+params3 = plot.fit(x, y, functions.line, label="Complete stats", 
+                   append_chi2=True, append_r2=True, append_dof=True, init=True)
+plt.title("With Chi2, R2, and DOF")
+plt.show()
+
+print("DOF test completed!")