From 91e2b419c27fa9e092e94920ef01a15d9116eeef Mon Sep 17 00:00:00 2001 From: Chad Hanna <chad.hanna@ligo.org> Date: Mon, 30 Apr 2018 20:26:22 -0400 Subject: [PATCH] gstlal_inspiral_injection_snr: NEW DOC --- .../bin/gstlal_inspiral_injection_snr | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/gstlal-inspiral/bin/gstlal_inspiral_injection_snr b/gstlal-inspiral/bin/gstlal_inspiral_injection_snr index 4fe5f12bf0..fb03bee090 100755 --- a/gstlal-inspiral/bin/gstlal_inspiral_injection_snr +++ b/gstlal-inspiral/bin/gstlal_inspiral_injection_snr @@ -16,17 +16,14 @@ # with this program; if not, write to the Free Software Foundation, Inc., # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -## @file gstlal_inspiral_injection_snr -# Used to assign characteristic SNRs to injections -# -# ### Usage: -# Takes an injection xml and a cache of reference PSDs and calculated characteristic SNRs. The values -# will be written to the alpha1 and alpha2 columns in the sim_inspiral table. -# -# ### Command line options -# + `--reference-psd-cache[filename]: Set the reference PSD cache file. -# + `--injection-file[filename]: Set the injection xml file. -# + `--flow [float]: Set the low frequency for waveform generation and SNR integral. +### Used to assign characteristic SNRs to injections +### +### Usage: +### ------ +### +### Takes an injection xml and a cache of reference PSDs and calculated characteristic SNRs. The values +### will be written to the alpha1 and alpha2 columns in the sim_inspiral table. +### """ This program calculates characteristic SNRs given an injection xml and a cache of reference PSDs. -- GitLab