Skip to content

Commit 228206c

Browse files
committed
[doc] Update filter grammar
1 parent e43f1e6 commit 228206c

File tree

2 files changed

+34
-13
lines changed

2 files changed

+34
-13
lines changed

doc/base/filter-grammar.rst

+33-12
Original file line numberDiff line numberDiff line change
@@ -53,16 +53,6 @@ parameters it can be given either with parentheses (e.g. :py:func:`DIFF()<DIFF()
5353
:param timespan: Time span in seconds
5454

5555

56-
.. py:function:: BW(order, lo-freq, hi-freq)
57-
58-
Butterworth Bandpass filter (BW) realized as a causal recursive IIR (infinite impulse response)
59-
filter. An arbitrary bandpass filter can be created for given order and corner frequencies.
60-
61-
:param order: The filter order
62-
:param lo-freq: The lower corner frequency
63-
:param hi-freq: The upper corner frequency
64-
65-
6656
.. py:function:: BW_LP(order, hi-freq)
6757
6858
Butterworth lowpass filter realized as a causal recursive IIR (infinite impulse response) filter.
@@ -88,6 +78,21 @@ parameters it can be given either with parentheses (e.g. :py:func:`DIFF()<DIFF()
8878
:param hi-freq: The upper corner frequency
8979

9080

81+
.. py:function:: BW(order, lo-freq, hi-freq)
82+
83+
Alias for :py:func:`high-low-pass filter<BW_HLP()>`.
84+
85+
86+
.. py:function:: BW_BP(order, lo-freq, hi-freq)
87+
88+
Butterworth Bandpass filter (BW) realized as a causal recursive IIR (infinite impulse response)
89+
filter. An arbitrary bandpass filter can be created for given order and corner frequencies.
90+
91+
:param order: The filter order
92+
:param lo-freq: The lower corner frequency
93+
:param hi-freq: The upper corner frequency
94+
95+
9196
.. py:function:: DIFF
9297
9398
Differentiation filter realized as a recursive IIR (infinite impulse response) differentiation
@@ -97,7 +102,7 @@ parameters it can be given either with parentheses (e.g. :py:func:`DIFF()<DIFF()
97102

98103
.. code-block:: py
99104
100-
s' = (s-v1) * dt
105+
s' = (s-v1) / dt
101106
v1 = s;
102107
103108
@@ -146,6 +151,19 @@ parameters it can be given either with parentheses (e.g. :py:func:`DIFF()<DIFF()
146151

147152
:param timespan: The timespan in seconds
148153

154+
.. py:function:: RM(timespan)
155+
156+
A running mean filter. For a given time window in seconds the running mean is
157+
computed from the single amplitude values and set as output. This computation
158+
is equal to :py:func:`RHMP<RMHP()>` with the exception that the mean is not
159+
subtracted from single amplitudes but replaces them.
160+
161+
.. code-block:: sh
162+
163+
RMHP = self-RM
164+
165+
:param timespan: The timespan in seconds
166+
149167
.. py:function:: SM5([type = 1])
150168
151169
A simulation of a 5-second seismometer.
@@ -164,13 +182,16 @@ parameters it can be given either with parentheses (e.g. :py:func:`DIFF()<DIFF()
164182
:param lta: Long-term time window
165183

166184

167-
.. py:function:: WA([type = 1])
185+
.. py:function:: WA([type = 1[,gain=2800[,T0=0.8[,h=0.8]]]])
168186
169187
The simulation filter of a Wood-Anderson seismometer. The data format of the waveforms has
170188
to be given for applying the simulation filter (displacement = 0, velocity = 1, acceleration = 2),
171189
e.g. WA(1) is the simulation on velocity data.
172190

173191
:param type: The data type: 0 (displacement), 1 (velocity) and 2 (acceleration)
192+
:param gain: The gain of the Wood-Anderson response
193+
:param T0: The eigen period in seconds
194+
:param h: The damping constant
174195

175196

176197
.. py:function:: WWSSN_LP([type = 1])

doc/templates/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555

5656
# General information about the project.
5757
project = u'SeisComP3'
58-
copyright = u'2014, GFZ Potsdam, gempa GmbH'
58+
copyright = u'2016, GFZ Potsdam, gempa GmbH'
5959

6060
# The version info for the project you're documenting, acts as replacement for
6161
# |version| and |release|, also used in various other places throughout the

0 commit comments

Comments
 (0)