From 0b584bc3d28f84d885a7145c55de080bc8951789 Mon Sep 17 00:00:00 2001 From: carhc Date: Wed, 16 Oct 2024 10:53:47 +0200 Subject: [PATCH] Update seed functions docstrings --- invisible_cities/reco/icaro_components.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/invisible_cities/reco/icaro_components.py b/invisible_cities/reco/icaro_components.py index d4f367130..8ca366427 100644 --- 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]