From 7b540b395fe32757d661f50d61ecb947a489a5c4 Mon Sep 17 00:00:00 2001 From: Alexander James Date: Mon, 20 May 2024 12:29:14 -0700 Subject: [PATCH] noise docstring --- paleobeasts/utils/noise.py | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/paleobeasts/utils/noise.py b/paleobeasts/utils/noise.py index f2f1bcf..964b312 100644 --- a/paleobeasts/utils/noise.py +++ b/paleobeasts/utils/noise.py @@ -39,9 +39,8 @@ def from_series(target_series,method,number=1,seed=None,label=None): Returns ------- - ts or ens : Series or EnsembleSeries - Series or EnsembleSeries containing original series + noise realizations. - If number > 1, returns EnsembleSeries. Else, returns Series. + surr : SurrogateSeries + SurrogateSeries object. surr.series_list will contain as many series objects as specified by `number` See also -------- @@ -145,9 +144,8 @@ def from_param(method = 'uar1',noise_param=[1,1],length=50, number = 1, time_pat Returns ------- - ts or ens : Series or EnsembleSeries - Series or EnsembleSeries containing noise realizations. - If number > 1, returns EnsembleSeries. Else, returns Series. + surr : SurrogateSeries + SurrogateSeries object. surr.series_list will contain as many series objects as specified by `number` See also --------