gstlal_snax_whiten ================== ## ## Command line options -------------------- .. code-block:: none Usage: gstlal_snax_whiten [options] A program that whitens timeseries Options: -h, --help show this help message and exit -v, --verbose Be verbose. --out-path=path Write to this path. Default = . --high-pass Add a high-pass filter to the pipeline --high-pass-cutoff=HIGH_PASS_CUTOFF Set the high-pass filter cutoff, default = 12 Hz. --psd-fft-length=seconds The length of the FFT used to used to whiten the data (default is 32 s). --save-format=format Set the save format for whitened timeseries (gwf/txt). Default = gwf. --out-frame-type=name Set the frame type. Default = WHITEN. --frame-duration=s Set the duration of the output frames. The duration of the frame file will be multiplied by --frames-per- file. Default: 16s --frames-per-file=n Set the number of frames per file. Default: 4 Data Source Options: Use these options to set up the appropriate data source --data-source=source Set the data source from [framexmit|lvshm|frames|silence|white|white_live]. 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. --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 --frame-cache=filename Set the name of the LAL cache listing the LIGO-Virgo .gwf frame files (optional). This is required iff --data-source=frames --max-streams=MAX_STREAMS Maximum number of streams to process for a given pipeline at once. Used to split up channel lists into subsets that can then be processed in serial. Default = 50. --equal-subsets If set, forces an equal number of channels processed per channel subset. --max-sample-rate=MAX_SAMPLE_RATE Maximum sampling rate for a given channel. If a given channel has a higher native sampling rate, it will be downsampled to this target rate. Default = 4096. --min-sample-rate=MIN_SAMPLE_RATE Minimum sampling rate for a given channel when splitting a given channel into multiple frequency bands. If a channel has a lower sampling rate than this minimum, however, it will not be upsampled to this sampling rate. Default = 32. --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. --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-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-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 --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 --latency-output Print out latency output (s) at different stages of the pipeline (measured as current time - buffer time). Channel Options: Settings used for deciding which auxiliary channels to process. --channel-list=name Set the list of the channels to process. Command given as --channel-list=location/to/file --channel-name=name Set the name of the channels to process. Can be given multiple times as --channel-name=IFO:AUX-CHANNEL- NAME:RATE --section-include=SECTION_INCLUDE Set the channel sections to be included from the INI file. Can be given multiple times. Pass in spaces as underscores instead. If not specified, assumed to include all sections --safety-include=SAFETY_INCLUDE Set the safety values for channels to be included from the INI file. Can be given multiple times. Default = 'safe'. --fidelity-exclude=FIDELITY_EXCLUDE Set the fidelity values for channels to be excluded from the INI file. Can supply multiple values by repeating this argument. Each must be on of (add here) --safe-channel-include=SAFE_CHANNEL_INCLUDE Include this channel when reading the INI file (requires exact match). Can be repeated. If not specified, assume to include all channels. --unsafe-channel-include=UNSAFE_CHANNEL_INCLUDE Include this channel when reading the INI file, disregarding safety information (requires exact match). Can be repeated.