From 0d0b43103b8774e547f2dc2fa29af12a1b51edbc Mon Sep 17 00:00:00 2001 From: sebastianp Date: Wed, 3 Feb 2016 14:49:16 +0100 Subject: [PATCH] editing of Docstring --- pylot/core/analysis/trigger.py | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/pylot/core/analysis/trigger.py b/pylot/core/analysis/trigger.py index baa4ccd8..aa900cef 100644 --- a/pylot/core/analysis/trigger.py +++ b/pylot/core/analysis/trigger.py @@ -8,12 +8,18 @@ def createSingleTriggerlist(st, station='ZV01', trigcomp='Z', stalta=(1, 10), trigonoff=(6, 1)): ''' uses a single-station trigger to create a triggerlist for this station - :param st: - :param station: - :param trigcomp: - :param stalta: - :param trigonoff: - :return: + :param st: obspy stream + :type st: + :param station: station name to get triggers for (optional, default = ZV01) + :type station: str + :param trigcomp: (optional, default = Z) + :type trigcomp: str + :param stalta: (optional, default = (1,10)) + :type stalta: tuple + :param trigonoff: (optional, default = (6,1)) + :type trigonoff: tuple + :return: list of triggtimes + :rtype: list ''' tr = st.copy().select(component=trigcomp, station=station)[0] df = tr.stats.sampling_rate @@ -32,7 +38,7 @@ def createSubCoincTriggerlist(trig, station='ZV01'): coincidence trigger and are seen at the demanded station :param trig: list containing triggers from coincidence trigger :type trig: list - :param station: station name to get triggers for + :param station: station name to get triggers for (optional, default = ZV01) :type station: str :return: list of triggertimes :rtype: list