From fca2f95070705def287d88ba8df5388ee3c023bb Mon Sep 17 00:00:00 2001 From: David Wright Date: Tue, 30 Jul 2024 15:03:20 -0700 Subject: [PATCH] fix(utils.py): make docstring with latex raw --- src/eztao/ts/utils.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/eztao/ts/utils.py b/src/eztao/ts/utils.py index 3e231fc..10ce26f 100644 --- a/src/eztao/ts/utils.py +++ b/src/eztao/ts/utils.py @@ -82,10 +82,10 @@ def add_season(t, lc_start=0, season_start=90, season_end=270): def median_clip(y, num_sigma=3): - """Clip time series using a three point median filter. + r"""Clip time series using a three point median filter. The sigma (standard deviation) for the time series is computed from the median absolute deviation (MAD) as to reduce the effects from extreme outliers, where - sigma \sim 1.4826*MAD. If more than 10% of the data points are removed, the upper + sigma :math:`\sim` 1.4826*MAD. If more than 10% of the data points are removed, the upper bound will be lifted gradually until that fraction drops bellow 10%. Args: