diff --git a/gstlal-inspiral/bin/gstlal_inspiral_calc_snr b/gstlal-inspiral/bin/gstlal_inspiral_calc_snr
index a30b89895f0ab16e6c0c5c9f76cc17483037c074..daead3e8afcbdda12f5f967d645d968e9ff15c68 100755
--- a/gstlal-inspiral/bin/gstlal_inspiral_calc_snr
+++ b/gstlal-inspiral/bin/gstlal_inspiral_calc_snr
@@ -40,8 +40,8 @@ $ gstlal_inspiral_calc_snr \
--verbose
Calculate SNR using LLOID method. You should have access to svd banks and reference psd for this option. For
-filter particular template in the svd banks, you should know the --sub-bank-id and the --row-number of the template;
-Otherwise, if only --sub-bank-id is provided, SNRs for all templates in the sub-bank will be produced. To limit the
+filter particular template in the svd banks, you should know the --bank-number and the --row-number of the template;
+Otherwise, if only --bank-number is provided, SNRs for all templates in the sub-bank will be produced. To limit the
output size, use --start and --end to specify the range of SNR in GPS time.
Example: G348519
@@ -58,7 +58,7 @@ $ gstlal_inspiral_calc_snr \
--track-psd \
--min-instruments 2 \
--svd-bank H1:H1-GSTLAL_SVD_BANK_258-0-0.xml.gz,L1:L1-GSTLAL_SVD_BANK_258-0-0.xml.gz \
---sub-bank-id 0 \
+--bank-number 0 \
--row-number 203 \
--outdir outputs \
--ranking-stat-output rankingstat.xml.gz \
@@ -144,16 +144,8 @@ class LIGOLWContentHandler(ligolw.LIGOLWContentHandler):
# FIXME: python plugin broken until we switch to Python 3
pipeparts.mkchecktimestamps = lambda pipeline, src, *args: src
-# Put the docstring at the end so that examples are prompted right away.
-class epilogFormatter(IndentedHelpFormatter):
- def format_epilog(self, epilog):
- if epilog:
- return epilog + "\n"
- else:
- return ""
-
def parse_command_line():
- parser = OptionParser(formatter = epilogFormatter(), description = "Using gstlal inspiral pipeline to calculate SNR for template(s)", epilog = __doc__)
+ parser = OptionParser(description = "Using gstlal inspiral pipeline to calculate SNR for template(s)")
datasource.append_options(parser)
@@ -168,8 +160,8 @@ def parse_command_line():
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("--coinc", metavar = "filename", help = "The coinc.xml file associated with --svd-bank. This is used to find the --sub-bank-id and --row-number for a particular event. If given, the --sub-bank-id and --row-number will be overwritten. (optional)")
- group.add_option("--sub-bank-id", type = "int", help = "Bank id is of the form <int>ID_<int>N where N is the sub bank id. (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. (require).")
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("--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).")
parser.add_option_group(group)
@@ -205,7 +197,7 @@ def parse_command_line():
group = OptionGroup(parser, "Program Options", "Control Program Behaviour.")
group.add_option("--verbose", action = "store_true", help = "Be verbsoe.")
group.add_option("--comment", metavar = "message", help = "Set the string to be recorded in comment and tag columns in various places in the output file (optional).")
- group.add_option("--save", action = "store_true", default = False, help = "Save frame cache / svd bank / psd (default = False).")
+ group.add_option("--save", action = "store_true", default = False, help = "Save frame cache / svd bank / psd if using --gid (default = False).")
group.add_option("--mode", metavar = "method", type = "int", default = 0, help = "The method (0 = LLOID / 1 = FIR) that is used to calculate SNR (default = 0).")
group.add_option("--output-width", metavar = "bits", type = "int", default = 32, help = "The size of the output data, can only be 32 or 64 bits (default = 32 bits).")
group.add_option("-t", "--tmp-space", metavar = "path", help = "Path to a directory suitable for use as a work area while manipulating the database file. The database file will be worked on in this directory, and then moved to the final location when complete. This option is intended to improve performance when running in a networked environment, where there might be a local disk with higher bandwidth than is available to the filesystem on which the final output will reside.")
@@ -244,7 +236,7 @@ def parse_command_line():
psds_dict = svd_bank_snr.psd_from_event(options.gid, save = options.save, verbose = options.verbose)
- banks_dict, options.sub_bank_id, options.row_number = svd_bank_snr.svd_banks_from_event(options.gid, save = options.save, verbose = options.verbose)
+ banks_dict, options.bank_number, options.row_number = svd_bank_snr.svd_banks_from_event(options.gid, save = options.save, verbose = options.verbose)
# bait out from here
return options, gw_data_source_info, banks_dict, psds_dict
@@ -294,8 +286,8 @@ def parse_command_line():
# Checking required options
if options.svd_bank is None:
missing_required_options.append("--svd-bank")
- if options.sub_bank_id is None and options.coinc is None:
- missing_required_options.append("--sub-bank-id")
+ if options.bank_number is None and options.coinc is None:
+ missing_required_options.append("--bank-number")
# Raise VauleError is required option(s) is/are missing
if missing_required_options:
raise ValueError("Missing required option(s) %s" % ", ".join(sorted(missing_required_options)))
@@ -309,16 +301,16 @@ def parse_command_line():
banks_dict = inspiral.parse_bank_files(bank_urls, options.verbose)
- # Scan for the --sub-bank-id and --row-number if --coinc is given
+ # Scan for the --bank-number and --row-number if --coinc is given
if options.coinc is not None:
coinc_xmldoc = ligolw_utils.load_url(options.coinc, verbose = options.verbose, contenthandler = ContentHandler)
- options.sub_bank_id, options.row_number = svd_bank_snr.scan_svd_banks_for_row(coinc_xmldoc, banks_dict)
- # Check if --sub-bank-id and --row-number is valid
+ options.bank_number, options.row_number = svd_bank_snr.scan_svd_banks_for_row(coinc_xmldoc, banks_dict)
+ # Check if --bank-number and --row-number is valid
for banks in banks_dict.values():
- if not (0 <= options.sub_bank_id < len(banks)) :
- raise ValueError("Invaild --sub-bank-id %d. Possible id [0-%d)\n" % (options.sub_bank_id, len(banks)))
- if options.row_number is not None and not (0 <= options.row_number < len(banks[options.sub_bank_id].sngl_inspiral_table)):
- raise ValueError("No such template: Invaild --row-number %d. Possible range [0-%d)\n" % (options.row_number, len(banks[options.sub_bank_id].sngl_inspiral_table)))
+ if not (0 <= options.bank_number < len(banks)) :
+ raise ValueError("Invaild --bank-number %d. Possible id [0-%d)\n" % (options.bank_number, len(banks)))
+ if options.row_number is not None and not (0 <= options.row_number < len(banks[options.bank_number].sngl_inspiral_table)):
+ raise ValueError("No such template: Invaild --row-number %d. Possible range [0-%d)\n" % (options.row_number, len(banks[options.bank_number].sngl_inspiral_table)))
# Use Finite Impulse Response
elif options.mode == 1:
@@ -372,11 +364,11 @@ mainloop = GObject.MainLoop()
#
rankingstat = far.RankingStat(
- template_ids = set(row.template_id for row in banks_dict.values()[0][options.sub_bank_id or 0].sngl_inspiral_table),
+ template_ids = set(row.template_id for row in banks_dict.values()[0][options.bank_number or 0].sngl_inspiral_table),
instruments = set(gw_data_source_info.channel_dict),
delta_t = options.coincidence_threshold,
min_instruments = options.min_instruments,
- horizon_factors = banks_dict.values()[0][options.sub_bank_id or 0].horizon_factors
+ horizon_factors = banks_dict.values()[0][options.bank_number or 0].horizon_factors
)
coincs_document = inspiral.CoincsDocument(
url = options.coinc_output,
@@ -392,7 +384,7 @@ coincs_document = inspiral.CoincsDocument(
verbose = options.verbose
)
-snr_dict = dict((instrument, svd_bank_snr.SNR(options.start, options.end, instrument, banks_dict[instrument], options.sub_bank_id or 0)) for instrument in gw_data_source_info.channel_dict)
+snr_dict = dict((instrument, svd_bank_snr.SNR(options.start, options.end, instrument, banks_dict[instrument], options.bank_number or 0)) for instrument in gw_data_source_info.channel_dict)
handler = svd_bank_snr.SNRPipelineHandler(
mainloop,
@@ -400,7 +392,7 @@ handler = svd_bank_snr.SNRPipelineHandler(
coincs_document,
rankingstat,
snr_dict,
- banks_dict.values()[0][options.sub_bank_id or 0].horizon_distance_func,
+ banks_dict.values()[0][options.bank_number or 0].horizon_distance_func,
ranking_stat_output_url = options.ranking_stat_output,
verbose = options.verbose)
@@ -414,12 +406,12 @@ if options.mode == 0:
#
itacac_dict = {}
for instrument in gw_data_source_info.channel_dict:
- bank = banks_dict[instrument][options.sub_bank_id]
+ bank = banks_dict[instrument][options.bank_number]
src, statevector, dqvector = datasource.mkbasicsrc(pipeline, gw_data_source_info, instrument, options.verbose)
hoftdict = multirate_datasource.mkwhitened_multirate_src(
pipeline,
src = src,
- rates = set(rate for rate in banks_dict[instrument][options.sub_bank_id].get_rates()),
+ rates = set(rate for rate in banks_dict[instrument][options.bank_number].get_rates()),
instrument = instrument,
psd = psds_dict[instrument],
psd_fft_length = options.psd_fft_length,
@@ -429,7 +421,7 @@ if options.mode == 0:
width = options.output_width,
statevector = statevector,
dqvector = dqvector,
- fir_whiten_reference_psd = banks_dict[instrument][options.sub_bank_id].processed_psd
+ fir_whiten_reference_psd = banks_dict[instrument][options.bank_number].processed_psd
)
snr = lloidparts.mkLLOIDhoftToSnrSlices(
@@ -466,7 +458,7 @@ elif options.mode == 1:
# Delete this attribute because it is not used here
for snr in snr_dict.values():
- del snr.sub_bank_id
+ del snr.bank_number
itacac_dict = {}
dummy_bank_id = 0
diff --git a/gstlal-inspiral/python/svd_bank_snr.py b/gstlal-inspiral/python/svd_bank_snr.py
index 65ee1bdbb2fe9a5aa594b59a0b819ce52c83a19d..f3bf279f4957ddc597929762fcd8937b2246c1d7 100644
--- a/gstlal-inspiral/python/svd_bank_snr.py
+++ b/gstlal-inspiral/python/svd_bank_snr.py
@@ -65,11 +65,11 @@ class SNR(object):
This is a class that defines the approximate start time and end time for which
the SNR should be collected.
"""
- def __init__(self, start, end, instrument, banks, sub_bank_id = 0):
+ def __init__(self, start, end, instrument, banks, bank_number = 0):
if start >= end:
raise ValueError("Start time must be less than end time.")
- self.sub_bank_id = sub_bank_id
- self.sngl_inspiral_table = banks[sub_bank_id].sngl_inspiral_table
+ self.bank_number = bank_number
+ self.sngl_inspiral_table = banks[bank_number].sngl_inspiral_table
self.s = start
self.e = end
self.epoch = None
@@ -259,12 +259,12 @@ class SNRPipelineHandler(lloidhandler.Handler):
# FIXME: it is a bit messy. Any possible fixes should follow the naming convention, otherwise gstlal_inspiral_plot_snr tools might breaks.
# LLOID
- if hasattr(snrs, "sub_bank_id"):
+ if hasattr(snrs, "bank_number"):
if row_number is None:
- outname = "%s-SVD_BANK_SNR_%d-%d-%d.xml.gz" % (instrument, snrs.sub_bank_id, snrs.start, snrs.duration)
+ outname = "%s-SVD_BANK_SNR_%d-%d-%d.xml.gz" % (instrument, snrs.bank_number, snrs.start, snrs.duration)
write_url(make_xmldoc({instrument: snrs[:]}), os.path.join(outdir, outname), verbose = self.verbose)
else:
- outname = "%s-SVD_BANK_SNR_%d_%d-%d-%d.xml.gz" % (instrument, snrs.sub_bank_id, row_number, snrs.start, snrs.duration)
+ outname = "%s-SVD_BANK_SNR_%d_%d-%d-%d.xml.gz" % (instrument, snrs.bank_number, row_number, snrs.start, snrs.duration)
write_url(make_xmldoc({instrument: [snrs[row_number]]}), os.path.join(outdir, outname), verbose = self.verbose)
# FIR
else:
@@ -539,7 +539,7 @@ def scan_svd_banks_for_row(coinc_xmldoc, banks_dict):
banks_dict (dict): A dictionary of SVD banks key by instrument containing the event template.
Returns:
- sub_bank_id (int)
+ bank_number (int)
row_number (int)
"""
@@ -547,18 +547,18 @@ def scan_svd_banks_for_row(coinc_xmldoc, banks_dict):
assert len(set([row.template_id for row in eventid_trigger_dict.values()])) == 1, "Templates should have the same template_id."
- sub_bank_id = None
+ bank_number = None
row_number = None
for i, bank in enumerate(banks_dict.values()[0]):
for j, row in enumerate(bank.sngl_inspiral_table):
if row.template_id == eventid_trigger_dict.values()[0].template_id:
- sub_bank_id = i
+ bank_number = i
row_number = j
break
- if sub_bank_id is not None:
+ if bank_number is not None:
break
- assert sub_bank_id is not None, "Cannot find the template listed in the coinc.xml."
- return sub_bank_id, row_number
+ assert bank_number is not None, "Cannot find the template listed in the coinc.xml."
+ return bank_number, row_number
def svd_banks_from_event(gid, outdir=".", save=False, verbose=False):
"""Find location of the SVD banks from gracedb event id.
@@ -571,7 +571,7 @@ def svd_banks_from_event(gid, outdir=".", save=False, verbose=False):
Returns:
banks_dict (dict of :obj: `Bank`): The SVD banks for an event key by instrument.
- sub_bank_id (int)
+ bank_number (int)
row_number (int)
"""
@@ -603,9 +603,9 @@ def svd_banks_from_event(gid, outdir=".", save=False, verbose=False):
# Just get one of the template bank from any instrument,
# the templates should all have the same template_id because they are exact-matched.
- sub_bank_id, row_number = scan_svd_banks_for_row(coinc_xmldoc, banks_dict)
+ bank_number, row_number = scan_svd_banks_for_row(coinc_xmldoc, banks_dict)
- return banks_dict, sub_bank_id, row_number
+ return banks_dict, bank_number, row_number
def framecache_from_event(gid, observatories, frame_types, time_span = 500, outdir = ".", filename = "frame.cache", verbose = False):
"""Get the frame cache for an event given the gracedb event id.