marcel/pylot
3
0
Fork 0
Code Issues 7 Pull Requests 1 Releases Wiki Activity

documentation updated in order to automatically provide online documentation via sphinx.ext.autodoc

Browse Source
This commit is contained in:
Sebastian Wehling-Benatelli 2014-04-01 16:49:28 +02:00
parent 0dec3eb7f0
commit bead7a24c3
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
pylot/core/read/inputs.py
View File

@ -6,9 +6,13 @@ class AutoPickParameter(object):
''' '''
AutoPickParameters is a parameter type object capable to read and/or write AutoPickParameters is a parameter type object capable to read and/or write
parameter ASCII and binary files. parameter ASCII and binary files.
:param fn str: Filename of the input file
Parameters are given for example as follows: Parameters are given for example as follows:
========== ========== =======================================
Name Value Comment
========== ========== =======================================
phl S # phaselabel phl S # phaselabel
ff1 0.1 # freqmin ff1 0.1 # freqmin
ff2 0.5 # freqmax ff2 0.5 # freqmax
@ -27,6 +31,7 @@ class AutoPickParameter(object):
aerr 30;60 # adjusted_error_slope_fitting_loc_glob aerr 30;60 # adjusted_error_slope_fitting_loc_glob
tsn 20;5;20;10 # length_signal_window_S/N tsn 20;5;20;10 # length_signal_window_S/N
proPh Sn # nextprominentphase proPh Sn # nextprominentphase
========== ========== =======================================
''' '''
def __init__(self, fn=None): def __init__(self, fn=None):