Skip to content
GitLab
Commit 6104b5f2 authored by Marius Kriegerowski's avatar Marius Kriegerowski
Browse files

snuffling: doc string

parent 251f9726
Hide whitespace changes
Inline Side-by-side
src/snuffling.py
View file @ 6104b5f2
......@@ -5,9 +5,36 @@ from pyrocko.snuffling import Snuffling, Param, Choice, Switch
class LassieSnuffling(Snuffling):
'''
Scrutinize Lassie Detections and Re-Detect
'''
@property
def __doc__(self):
s = '''
<html>
<head>
<style type="text/css">
body { margin-left:10px };
</style>
</head>
<body>
<h2 style="test-align:center"> Scrutinize Lassie Detections and
Re-Detect</h2>
<p>
Adjust the detector <i>threshold</i>, press <i>run</i>. From every
instant, where the signal rises above <i>threshold</i>, a time length
of <i>tsearch</i> seconds is searched for a maximum. Detections are
added as event markers to the viewer. </p>
<p>
If you want to save the updated detections, it might be helpful to use the marker table
(see <a href="http://pyrocko.org/v0.3/snuffler_tutorial.html"> Snuffler
Tutorial</a> at the bottom) to sort all markers by their kind.
</p>
</body>
</html>
'''
return s
def __init__(self):
Snuffling.__init__(self)
self.config = None
......@@ -18,9 +45,9 @@ class LassieSnuffling(Snuffling):
else:
detector_default = 100.
self.set_name('Lassie investigate')
self.add_parameter(Param('tsearch', 'tsearch', 1., 0.01, 100))
self.add_parameter(Param('Tsearch', 'tsearch', 1., 0.01, 100))
self.add_parameter(Param(
'threshold', 'detector_threshold', detector_default, 100., 10000.))
'Threshold', 'detector_threshold', detector_default, 100., 10000.))
self.add_parameter(Switch('Level Trace', 'level_trace', False))
self.add_parameter(Choice(
'new marker kind', 'marker_kind', '1 (green)',
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment