group.add_option("--control-peak-time", metavar = "seconds", type = "int", help = "Set a time window in seconds to find peaks in the control signal (optional, default is to disable composite detection statistic).")
group.add_option("--output", metavar = "filename", action = "append", default = [], help = "Set the name of the LIGO light-weight XML output file *.{xml,xml.gz} or an SQLite database *.sqlite (required). Can be given multiple times. Exactly as many output files must be specified as svd-bank files will be processed (see --svd-bank).")
group.add_option("--output-cache", metavar = "filename", help = "Provide a cache of output files. This can be used instead of giving multiple --output options. Cannot be combined with --output.")
group.add_option("--svd-bank", metavar = "filename", action = "append", default = [], help = "Set the name of the LIGO light-weight XML file from which to load the svd bank for a given instrument in the form ifo:file. These can be given as a comma separated list such as H1:file1,H2:file2,L1:file3 to analyze multiple instruments. This option can be given multiple times, unless --data-source is lvshm or framexmit in which case it must be given exactly once. If given multiple times, the banks will be processed one-by-one, in order. At least one svd bank for at least 2 detectors is required, but see also --svd-bank-cache.")
group.add_option("--svd-bank", metavar = "filename", action = "append", default = [], help = "Set the name of the LIGO light-weight XML file from which to load the svd bank for a given instrument in the form ifo:file. These can be given as a comma separated list such as H1:file1,L1:file2,V1:file3 to analyze multiple instruments. This option can be given multiple times, unless --data-source is lvshm or framexmit in which case it must be given exactly once. If given multiple times, the banks will be processed one-by-one, in order. At least one svd bank for at least 2 detectors is required, but see also --svd-bank-cache.")
group.add_option("--svd-bank-cache", metavar = "filename", help = "Provide a cache file of svd-bank files. This can be used instead of giving multiple --svd-bank options. Cannot be combined with --svd-bank options.")
# NOTE: the clustering SQL scripts search for this option in the
# process_params table to determine the threshold below which it
group=OptionGroup(parser,"Template Options","Choose a template from a SVD bank file / a bank file (see svd_bank_snr.Bank).")
group.add_option("--svd-bank",metavar="filename",help="A LIGO light-weight xml / xml.gz file containing svd bank information. These can be given as a comma separated list such as H1:file1,H2:file2,L1:file3 to analyze multiple instruments (require).")
group.add_option("--svd-bank",metavar="filename",help="A LIGO light-weight xml / xml.gz file containing svd bank information. These can be given as a comma separated list such as H1:file1,L1:file2,V1:file3 to analyze multiple instruments (require).")
group.add_option("--coinc",metavar="filename",help="The coinc.xml file associated with --svd-bank. This is used to find the --bank-number and --row-number for a particular event. If given, the --bank-number and --row-number will be overwritten. (optional)")
group.add_option("--bank-number",type="int",help="Bank id is of the form <int>ID_<int>N where N is the sub bank id. (optional). SNRs in all banks will be used if it is not given.")
group.add_option("--bank-counts",type="int",default=1,help="Number of banks to used; Counted from --bank-number; default = 1")
group.add_option("--row-number",type="int",help="The row number of the template (optional). All the SNRs will be outputed if it is not given.")
group.add_option("--row-counts",type="int",default=1,help="Number of rows to be outputted; Counted from --row-number; default = 1")
group.add_option("--bank",metavar="filename",help="LIGO light-weight xml.gz file(s) containing only one template. These can be given as a comma separated list such as H1:file1,H2:file2,L1:file3. Expecting one template only for each file (require).")
group.add_option("--bank",metavar="filename",help="LIGO light-weight xml.gz file(s) containing only one template. These can be given as a comma separated list such as H1:file1,L1:file2,V1:file3. Expecting one template only for each file (require).")
parser.add_option_group(group)
group=OptionGroup(parser,"Data Quality Options","Adjust data quality handling")
parser.add_option("--samples-max-256",type="int",default=1024,help="The maximum number of samples to use for time slices with frequencies above 256Hz, default 1024")
parser.add_option("--samples-max-64",type="int",default=2048,help="The maximum number of samples to use for time slices with frequencies above 64Hz, default 2048")
parser.add_option("--samples-max",type="int",default=4096,help="The maximum number of samples to use for time slices with frequencies below 64Hz, default 4096")
parser.add_option("--bank-cache",metavar="filenames",action="append",help="Set the bank cache files in format H1=H1.cache,H2=H2.cache, etc.. (can be given multiple times)")
parser.add_option("--bank-cache",metavar="filenames",action="append",help="Set the bank cache files in format H1=H1.cache,L1=L1.cache, etc.. (can be given multiple times)")
parser.add_option("--tolerance",metavar="float",type="float",default=0.9999,help="set the SVD tolerance, default 0.9999")
parser.add_option("--flow",metavar="num",type="float",action="append",help="set the low frequency cutoff. Can be given multiple times.")
parser.add_option("--fmax",metavar="num",type="float",default=1600,help="set the max frequency cutoff, default 1600 (Hz)")
@@ -49,7 +49,7 @@ from lalburst import calc_likelihood
defparse_command_line():
parser=OptionParser()
parser.add_option("--svd-bank",metavar="filename",action="append",default=[],help="Set the name of the LIGO light-weight XML file from which to load the svd bank for a given instrument in the form ifo:file, These can be given as a comma separated list such as H1:file1,H2:file2,L1:file3 to analyze multiple instruments. This option can be given multiple times in order to analyze bank serially. At least one svd bank for at least 2 detectors is required.")
parser.add_option("--svd-bank",metavar="filename",action="append",default=[],help="Set the name of the LIGO light-weight XML file from which to load the svd bank for a given instrument in the form ifo:file, These can be given as a comma separated list such as H1:file1,L1:file2,V1:file3 to analyze multiple instruments. This option can be given multiple times in order to analyze bank serially. At least one svd bank for at least 2 detectors is required.")
parser.add_option("--svd-bank-cache",metavar="filename",help="Provide a cache file of svd-bank files")
parser.add_option("--likelihood-file",metavar="filename",action="append",help="Set the name of the likelihood ratio data file to use. Can be given more than once. File names should file T050017 naming convention, with an integer corresponding to split bank it is associated with (e.g. H1L1-0_DIST_STATS-1127307417-3805.xml.gz)")
parser.add_option("--global-likelihood-file",metavar="filename",action="append",help="Set the name of a likelihood file not associated with a specific split ban. Can be given multiple times.")
parser.add_option("--dist-stats-cache",metavar="filename",help="Set the cache file for dist stats")
parser.add_option("--lloid-cache",metavar="filename",help="Set the cache file for LLOID")
parser.add_option("--bank-cache",metavar="filenames",action="append",help="Set the bank cache files in format H1=H1.cache,H2=H2.cache, etc.. (can be given multiple times)")
parser.add_option("--bank-cache",metavar="filenames",action="append",help="Set the bank cache files in format H1=H1.cache,L1=L1.cache, etc.. (can be given multiple times)")
# Data from a zero lag run in the case of an injection-only run.
parser.add_option("--svd-bank-cache",metavar="filename",help="Set the cache file for svd banks (required iff running injection-only analysis)")
injrecovery+=report.Description("""Measuring the found and missed injections as a function of various parameters aids in diagnosing the pipeline as well as providing the expected sensitivity of the pipeline to real signals. The plots in this section show the missed and found injections as a for the various IFO times for coincident triggers. We allow double coincident events so some categories can have multiple types of found injections (for example H1L1 and H1H2L1 triggers in H1H2L1 time). Because of ambiguity concerning the time of an injection and the injection window it is occasionally possible to find an injection in more detectors than what the "time" refers to. For example, an injection's geocentric end time might be in H1L1 time but that might occur near a boundary where H2 was also on. Thus one could find an H1L1 injection in H1H2L1 time.""")
injrecovery+=report.Description("""Measuring the found and missed injections as a function of various parameters aids in diagnosing the pipeline as well as providing the expected sensitivity of the pipeline to real signals. The plots in this section show the missed and found injections as a for the various IFO times for coincident triggers. We allow double coincident events so some categories can have multiple types of found injections (for example H1L1 and H1L1V1 triggers in H1L1V1 time). Because of ambiguity concerning the time of an injection and the injection window it is occasionally possible to find an injection in more detectors than what the "time" refers to. For example, an injection's geocentric end time might be in H1L1 time but that might occur near a boundary where V1 was also on. Thus one could find an H1L1 injection in H1L1V1 time.""")
parser.add_option("--analysis-tag",metavar="name",help="Set the name of the analysis, used to distinguish between different DAGs running simultaneously.")
parser.add_option("--psd-fft-length",metavar="s",default=32,type="int",help="FFT length, default 32s. Note that 50% will be used for zero-padding.")
parser.add_option("--reference-psd",metavar="filename",help="Set the reference psd file.")
parser.add_option("--bank-cache",metavar="filenames",help="Set the bank cache files in format H1=H1.cache,H2=H2.cache, etc..")
parser.add_option("--bank-cache",metavar="filenames",help="Set the bank cache files in format H1=H1.cache,L1=L1.cache, etc..")
parser.add_option("--min-instruments",metavar="count",type="int",default=2,help="Set the minimum number of instruments that must contribute triggers to form a candidate (default = 2).")
parser.add_option("--inj-channel-name",metavar="name",default=[],action="append",help="Set the name of the injection channel to process for given mass bins (optional). 0000:0002:IFO1=CHANNEL-NAME1,IFO2=CHANNEL-NAME2 can be given multiple times.")
parser.add_option("--inj-state-channel-name",metavar="name",default=[],action="append",help="Set the name of the injection state channel to process (required if --inj-channel-name set).")
