Update seed functions docstrings

next-exp · Oct 16, 2024 · 0b584bc · 0b584bc
1 parent 1f64724
commit 0b584bc
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/invisible_cities/reco/icaro_components.py b/invisible_cities/reco/icaro_components.py
@@ -8,7 +8,7 @@
 
 def lin_seed(x : np.array, y : np.array):
     '''
-    Estimate the seed for a linear fit.
+    Estimate the seed for a linear fit of the form y = a + bx.
 
     Parameters
     ----------
@@ -37,7 +37,7 @@ def lin_seed(x : np.array, y : np.array):
 
 def expo_seed(x : np.array, y : np.array):
     '''
-    Estimate the seed for an exponential fit.
+    Estimate the seed for an exponential fit of the form y = y0*exp(-x/lt).
 
     Parameters
     ----------
@@ -49,7 +49,7 @@ def expo_seed(x : np.array, y : np.array):
     Returns
     -------
     seed : tuple
-        Seed parameters (constant, mean) for the exponential fit.
+        Seed parameters (y0, lt) for the exponential fit.
     '''
     x, y = zip(*sorted(zip(x, y)))
     y0   = y[0]