gstlal_inspiral_calc_snr ======================== Command line options -------------------- .. code-block:: none Usage: gstlal_inspiral_calc_snr [options] Using gstlal inspiral pipeline to calculate SNR for template(s) Options: -h, --help show this help message and exit Data source options: Use these options to set up the appropriate data source --data-source=source Set the data source from [frames|framexmit|lvshm|nds|silence|white]. Required. --block-size=bytes Data block size to read in bytes. Default 16384 * 8 * 512 (512 seconds of double precision data at 16384 Hz. This parameter is only used if --data-source is one of white, silence, AdvVirgo, LIGO, AdvLIGO, nds. --frame-cache=filename Set the name of the LAL cache listing the LIGO-Virgo .gwf frame files (optional). --frame-type=name Set the frame type for a given instrument. Can be given multiple times as --frame-type=IFO=FRAME-TYPE. Used with --data-source=frames --data-find-server=url Set the data find server for LIGO data discovery. Used with --data-source=frames --gps-start-time=seconds Set the start time of the segment to analyze in GPS seconds. Required unless --data-source=lvshm --gps-end-time=seconds Set the end time of the segment to analyze in GPS seconds. Required unless --data-source=lvshm --injection-file=filename Set the name of the LIGO light-weight XML file from which to load injections (optional). --channel-name=name Set the name of the channels to process. Can be given multiple times as --channel-name=IFO=CHANNEL-NAME --idq-channel-name=idqname iDQ channel names to process. Must also provide idq- state-channel-name. Can be given multiple times as --idq-channel-name=IFO=IDQ-CHANNEL-NAME --idq-state-channel-name=idqstatename iDQ state channel names to process. Can be given multiple times as --idq-state-channel-name=IFO=IDQ- STATE-CHANNEL-NAME --nds-host=hostname Set the remote host or IP address that serves nds data. This is required iff --data-source=nds --nds-port=portnumber Set the port of the remote host that serves nds data. This is required iff --data-source=nds --nds-channel-type=type Set the port of the remote host that serves nds data. This is required only if --data-source=nds. default==online --framexmit-addr=name Set the address of the framexmit service. Can be given multiple times as --framexmit- addr=IFO=xxx.xxx.xxx.xxx:port --framexmit-iface=name Set the multicast interface address of the framexmit service. --state-channel-name=name Set the name of the state vector channel. This channel will be used to control the flow of data via the on/off bits. Can be given multiple times as --channel-name=IFO=CHANNEL-NAME --dq-channel-name=name Set the name of the data quality channel. This channel will be used to control the flow of data via the on/off bits. Can be given multiple times as --channel-name=IFO=CHANNEL-NAME --shared-memory-partition=name Set the name of the shared memory partition for a given instrument. Can be given multiple times as --shared-memory-partition=IFO=PARTITION-NAME --shared-memory-dir=name Set the name of the shared memory directory for a given instrument. Can be given multiple times as --shared-memory-dir=IFO=DIR-NAME --shared-memory-assumed-duration=SHARED_MEMORY_ASSUMED_DURATION Set the assumed span of files in seconds. Default = 4. --shared-memory-block-size=SHARED_MEMORY_BLOCK_SIZE Set the byte size to read per buffer. Default = 4096. --frame-segments-file=filename Set the name of the LIGO light-weight XML file from which to load frame segments. Optional iff --data- source=frames --frame-segments-name=name Set the name of the segments to extract from the segment tables. Required iff --frame-segments-file is given --state-vector-on-bits=bits Set the state vector on bits to process (optional). The default is 0x7 for all detectors. Override with IFO=bits can be given multiple times. Only currently has meaning for online (lvshm) data. --state-vector-off-bits=bits Set the state vector off bits to process (optional). The default is 0x160 for all detectors. Override with IFO=bits can be given multiple times. Only currently has meaning for online (lvshm) data. --dq-vector-on-bits=bits Set the DQ vector on bits to process (optional). The default is 0x7 for all detectors. Override with IFO=bits can be given multiple times. Only currently has meaning for online (lvshm) data. --dq-vector-off-bits=bits Set the DQ vector off bits to process (optional). The default is 0x160 for all detectors. Override with IFO=bits can be given multiple times. Only currently has meaning for online (lvshm) data. Whiten / PSD Options: Adjust noise spectrum estimation parameter --reference-psd=filename Load noise spectrum from LIGO light-weight XML file (optional). --psd-fft-length=seconds Length of the FFT used to whiten strain data (default = 32 s). --track-psd Enable dynamic PSD tracking. Enabled by default if --reference-psd is not given. --zero-pad=seconds The zero padding of the Hanning window in seconds (default = 0). --average-samples=AVERAGE_SAMPLES The number of samples used to estimate the average value of the PSD --median-samples=MEDIAN_SAMPLES The number of samples used to estimate the median value of the PSD Template Options: Choose a template from a SVD bank file / a bank file (see svd_bank_snr.Bank). --svd-bank=filename 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). --coinc=filename 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) --bank-number=BANK_NUMBER Bank id is of the form ID_N where N is the sub bank id. (optional). SNRs in all banks will be used if it is not given. --bank-counts=BANK_COUNTS Number of banks to used; Counted from --bank-number; default = 1 --row-number=ROW_NUMBER The row number of the template (optional). All the SNRs will be outputed if it is not given. --row-counts=ROW_COUNTS Number of rows to be outputted; Counted from --row- number; default = 1 --bank=filename 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). Data Quality Options: Adjust data quality handling --ht-gate-threshold=sigma Set the threshold on whitened h(t) to excise glitches in units of standard deviation (defalut = inf). --veto-segments-file=filename Set the name of the LIGO light-weight XML file from which to load vetoes (optional). --veto-segments-name=name Set the name of the LIGO light-weight XML file from which to load vetoes (default = 'veto') (optional). GraceDb Event Options: Produce SNR time series for gstlal gracedb event. --gid=gracedb event id The gracedb event id. --observatory=OBS Name of the observatory (H,L,V ...), also see gwdatafind. --type=frame type Name of the observatory (H,L,V ...), also see gwdatafind. --time-span=seconds The time span around the event's trigger time, must be larger or equal to 500s (default = 500). Trigger Generator Control / Outputs Options: Adjust the trigger generator's behaviors and its outputs. --FAR-trialsfactor=trials Add trials factor to FAR before uploading to gracedb (default = 1.0). --likelihood-snapshot-interval=seconds How often to snapshot candidate and ranking statistic data to disk when running online (optional). --ranking-stat-pdf=url Set the URL from which to load the ranking statistic PDF. This is used to compute false-alarm probabilities and false-alarm rates and is required for online operation (when --data-source is framexmit or lvshm). It is forbidden for offline operation (all other data sources) --ranking-stat-input=url Set the URL from which to load a ranking statistic definition. When this is enabled, signal candidates will have ranking statistic values assigned on-the- fly. Required when --data-source is lvshm or framexmit; must also set --likelihood-snapshot- interval. --zerolag-rankingstat-pdf=url Record a histogram of the likelihood ratio ranking statistic values assigned to zero-lag candidates in this XML file. This is used to construct the extinction model and set the overall false-alarm rate normalization during online running. If it does not exist at start-up, a new file will be initialized, otherwise the counts will be added to the file's contents. Required when --data-source is lvshm or framexmit; optional otherwise. --time-slide-file=filename Set the name of the xml file to get time slide offsets (require). --min-instruments=count Set the minimum number of instruments that must contribute triggers to form a candidate (default = 2). --singles-threshold=SNR Set the SNR threshold at which to record single- instrument events in the output (default = +inf, i.e. don't retain singles). --control-peak-time=seconds Set a time window in seconds to find peaks in the control signal (optional, default is to disable composite detection statistic). --coincidence-threshold=seconds Set the coincidence window in seconds (default = 0.005 s). The light-travel time between instruments will be added automatically in the coincidence test (default = 0.005). --gracedb-service-url=url Fake graceDb service url. This can only be a local url (optional). --gracedb-far-threshold=Hertz False-alarm rate threshold for fake gracedb uploads in Hertz (default = do not upload to gracedb). --gracedb-group=name Gracedb group to which to upload events (default = 'Test'). --gracedb-pipeline=name Name of pipeline to provide in fake GracedB uploads (default = 'gstlal'). --gracedb-search=name Name of search to provide in fake GracedB uploads (default = 'event-followup'). --reconstruction-segment=start:stop Only reconstruct the SNRs for this time interval. Note: Use this carefully, this is not compatible with the option --start and --end. This is only added for coincidence document (optional). --ranking-stat-output=filename Set the name of the file to which to write ranking statistic data collected from triggers. This will not be prefixed by --outdir (optional). --coinc-output=filename Set the name of the LIGO light-weight XML output file *.{xml,xml.gz} or an SQLite database *.sqlite. This will not be prefixed by --outdir (default is disable coinc output) (Providing this would also enable triggers generation, otherwise trigger generator is not added to the pipeline). Output Control Options: Control SNR outputs. --outdir=directory Output directory for SNR(s) (default = .). --complex Choose whether to output the complex snr or not. --start=seconds Start SNR time series at GPS time '--start' (require). --end=seconds End SNR time series at GPS time '--end' (require). Program Options: Control Program Behaviour. --fir-stride=seconds Set the length of the fir filter stride in seconds. default = 8 --verbose Be verbsoe. --comment=message Set the string to be recorded in comment and tag columns in various places in the output file (optional). --save Save frame cache / svd bank / psd if using --gid (default = False). --mode=method The method (0 = LLOID / 1 = FIR) that is used to calculate SNR (default = 0). --output-width=bits The size of the output data, can only be 32 or 64 bits (default = 32 bits). -t path, --tmp-space=path 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.