Skip to content
Snippets Groups Projects
Commit 1175b6f8 authored by Patrick Godwin's avatar Patrick Godwin
Browse files

gstlal_feature_extractor execs: add usage kwarg to OptionParser so that...

gstlal_feature_extractor execs: add usage kwarg to OptionParser so that command line options get rendered in online docs
parent 609b8950
No related branches found
No related tags found
No related merge requests found
Pipeline #
......@@ -16,7 +16,9 @@
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
"""
A program to extract features from auxiliary channel data in real time or in offline mode
"""
# =============================
#
......@@ -24,8 +26,6 @@
#
# =============================
### A program to extract features from auxiliary channel data in real time or in offline mode
###
### .. graphviz::
###
### digraph llpipe {
......@@ -192,7 +192,7 @@ setrlimit(resource.RLIMIT_STACK, 1024 * 1024) # 1 MiB per thread
def parse_command_line():
parser = OptionParser(description = __doc__)
parser = OptionParser(usage = '%prog [options]', description = __doc__)
# First append datasource and feature extraction common options
multichannel_datasource.append_options(parser)
......
......@@ -170,7 +170,7 @@ def feature_extractor_node_gen(gstlalFeatureExtractorJob, dag, parent_nodes, seg
#
def parse_command_line():
parser = OptionParser(description = __doc__)
parser = OptionParser(usage = '%prog [options]', description = __doc__)
# generic data source options
multichannel_datasource.append_options(parser)
......
......@@ -16,7 +16,10 @@
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
"""
A program that measures template overlaps and how templates are spread out in the parameter space
for gstlal_feature_extractor
"""
####################
#
......@@ -206,7 +209,7 @@ def to_output_url(output_dir):
def parse_command_line():
parser = OptionParser(description = __doc__)
parser = OptionParser(usage = '%prog [options]', description = __doc__)
parser.add_option("-v", "--verbose", action = "store_true", help = "Be verbose.")
parser.add_option("-m", "--mismatch", type = "float", default = 0.05, help = "Mismatch between templates, mismatch = 1 - minimal match. Default = 0.05.")
......
......@@ -16,6 +16,9 @@
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
"""
A program that allows diagnosis of the whitening stage of gstlal_feature_extractor
"""
####################
......@@ -60,7 +63,7 @@ PSD_DROP_TIME = 16 * PSD_FFT_LENGTH
def parse_command_line():
parser = OptionParser(description = __doc__)
parser = OptionParser(usage = '%prog [options]', description = __doc__)
# First append the datasource common options
multichannel_datasource.append_options(parser)
......
......@@ -139,7 +139,7 @@ def feature_extractor_node_gen(feature_extractor_job, dag, parent_nodes, ifo, op
# =============================
def parse_command_line():
parser = optparse.OptionParser(description = __doc__)
parser = optparse.OptionParser(usage = '%prog [options]', description = __doc__)
# generic data source and feature extraction options
multichannel_datasource.append_options(parser)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment