gstlal_ll_dq
============

Command line options
--------------------



.. code-block:: none

   Usage: gstlal_ll_dq [options]
   
   Options:
     -h, --help            show this help message and exit
     --sample-rate=Hz      Sample rate at which to generate the PSD, default
                           16384 Hz
     --psd-fft-length=s    FFT length, default 8s
     --scald-config=path   sets ligo-scald options based on yaml configuration.
     --output-kafka-server=addr
                           Set the server address and port number for output
                           data. Optional
     --analysis-tag=tag    Set the string to identify the analysis in which this
                           job is part of. Used when --output-kafka-server is
                           set. May not contain "." nor "-". Default is test.
     --injection-channel   if True, compute noise and range history from
                           injection channels.
     --reference-psd=filename
                           Load spectrum from this LIGO light-weight XML file.
                           The noise spectrum will be measured and tracked
                           starting from this reference. (optional).
     --horizon-approximant=HORIZON_APPROXIMANT
                           Specify a waveform approximant to use while
                           calculating the horizon distance and range. Default is
                           IMRPhenomD.
     --horizon-f-min=Hz    Set the frequency at which the waveform model is to
                           begin for the horizon distance and range calculation.
                           Default is 15 Hz.
     --horizon-f-max=Hz    Set the upper frequency cut off for the waveform model
                           used in the horizon distance and range calculation.
                           Default is 900 Hz.
     -v, --verbose         Be verbose (optional).
   
     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.