Module dqFrameUtils

Extract 1D data for given channel from the GWF format frame filename.
Returns (x, data) pair of numpy arrays (x is array of times or frequencies.

Arguments:

  filename : string
    path to GWF frame file
  channel : string
    channel name to extract

Keyword arguments:

  start : float
    GPS start time (s) or minimum frequency (Hz) to return
  end : float
    GPS end time (s) or maximum frequency (Hz) to return

Write numpy array data to GWF frame file using the given arguments.

Arguments:

  filename : string
    name of file to write
  channel : string
    name of channel to write
  data : numpy.array
    array of data to write
  start : float
    GPS start time (s) or minimum frequency (Hz)
  dx : float
    GPS time step (s) or frequency step (Hz)

Unnamed arguments are held in frargs. For usage, see documentation for
pylal.Fr.frputvect.

Extract data for given channel from glue.lal.Cache object cache. Returns 
(time, data) pair of numpy arrays.

Arguments:

  cache : glue.lal.Cache
    Cache list of frame files to read
  channel : string
    channel name to extract

Keyword arguments:

  start : float
    GPS start time (s) or minimum frequency (Hz) to return
  end : float
    GPS end time (s) or maximum frequency (Hz) to return

This function will return the frame data for the given channel of the given
type in the given [start,end] time range and will construct a gps time
vector to go with it. The nds option is not yet supported, and the dmt
option will return data for dmt channels in frames not available on the
datafind server.

>>> grab_data(997315215, 997315225, 'G1:DER_DATA_QUALITY', 'G1_RDS_C01_L3')
(array([  9.97315215e+08,   9.97315216e+08,   9.97315217e+08,
         9.97315218e+08,   9.97315219e+08,   9.97315220e+08,
         9.97315221e+08,   9.97315222e+08,   9.97315223e+08,
         9.97315224e+08]),
 array([ 256.,  256.,  256.,  256.,  256.,  256.,  256.,  256.,  256.,
         256.]))

Arguments:

  start : float
    GPS start time (s).
  end : float
    GPS end time (s).
  channel : string
    channel name to extract, e.g. 'G1:DER_DATA_H'.
  type : string
    frame data type to use, e.g. 'G1_RDS_C01_L3'.

Keyword arguments:

  nds : [ True | False ]
    use NDS connection to data server (UNSUPPORTED).
  dmt : [ True | False ]
    frame type is DMT product (DMT data not found by datafind server).

Queries the LSC datafind server and returns a glue.lal.Cache object
containing the frame file paths in the given GPS (start, end) interval
for the given ifo and type (can be lists).

framecache=True returns a pylal.dq.dqFrameUTils.FrameCache object in stead.

Arguments:

  start : float
    GPS start time (s).
  end : float
    GPS end time (s).
  ifo : [ string | list ]
    ifo (or list of) to find, e.g. 'G1'.
  ftype : [ string | list ]
    frame data type (or list of) to find, e.g. 'G1_RDS_C01_L3'.

Returns the latest frame available in the LSC datafind server for the given
ifo and frame type.

Arguments:

  ifo : string
    observatory to find
  ftype : string
    frame data type to find

Query the LSC datafind server and return a list of sites for which data is available. Does not differentiate between H1 and H2.

Example:

>>> find_ifos()
['G', 'H', 'L', 'V']

This function will return a valid list of LIGO frame types given the list of
type strings. The search option defines the breadth of the search, to speed
up the search, the following search options are supported:
'standard','short','full'. 

The 'R', 'T', and 'M' (raw, raw second trends, and raw minute trends) are 
treated as special cases, so as not to return all types containing those 
letters. 

Example:

>>>find_types(ftype='H1_RDS')
['H1_RDS_C01_LX',
 'H1_RDS_C02_LX',
 'H1_RDS_C03_L1',
 'H1_RDS_C03_L2',
 'H1_RDS_C03_L2_ET',
 'H1_RDS_C03_L2_ET2',
 'H1_RDS_C03_L2_ET30',
 'H1_RDS_C04_LX',
 'H1_RDS_R_L1',
 'H1_RDS_R_L3',
 'H1_RDS_R_L4']

>>>find_types(ftype=['H1_RDS','R'],search='short')
['H1_RDS_R_L1', 'H1_RDS_R_L3', 'H1_RDS_R_L4', 'R']

Keyword arguments:

  ifo : [ string | list ]
    ifo (or list of) to find, e.g. 'G1'.
  ftype : [ string | list ]
    frame data type (or list of) to find, e.g. 'G1_RDS_C01_L3'.
  search : string
    descriptor of how deep to search for frame type.

Returns a ChannelList containing Channels for all data channels matching
the given attributes from frames matching the given GPS time (defaults to
now).

Keyword arguments:

  name : [ string | list ]
    channel name (or list of) to match in search. Can be part of name,
    e.g. ['STRAIN', 'DARM_ERR']
  ftype : [ string | list ]
    frame data type (or list of) to find, e.g. 'G1_RDS_C01_L3'.
  ifo : [ string | list ]
    ifo (or list of) to find, e.g. 'G1'.
  not_name : [ string | list ]
    channel name (or list of) to negatively match in search. Can be part of
    name, e.g. 'ETMY_EXC_DAQ'
  not_ftype : [ string | list ]
    frame data type (or list of) to remove from search.
  exact_match : [ True | False]
    require complete match with given name list, not just partial match.
  time : float
    GPS time to which to restrict search. Data transfer latency means that
    the very latest data is not always available, best to give a 'recent'
    time.
  unique : [ True | False ]
    return unique list of channels from different types (since the same
    channel can exist in multiple types).

This function will return a list of frame files in the given start and stop 
time interval for the give IFO using the given DMT frame type. This is
required if ligo_data_find will not return the dmt frames.

Example:

>>>dmt_cache(960000000,960010000,'H1','LockLoss_H1')
['/archive/frames/dmt/LHO/LockLoss_H1/H-M-960/H-LockLoss_H1_M-960001200-3600.gwf',
 '/archive/frames/dmt/LHO/LockLoss_H1/H-M-960/H-LockLoss_H1_M-960004800-3600.gwf']