Module dqTriggerUtils

Reads the list object data and returns a Sngl{Burst,Inspiral} object
with the correct columns seeded, based on the given string object etg.

Arguments:

  data : [ string | list ]
    string or list object containing the data to be parsed.

  etg : [ "ihope" | "kw" | "omega" | "omegadq" ]
    Defines how the data list is understood and parsed, based on the
    standard column layouts (comma-, space-, or tab-delimited) for each ETG.
    "ihope" is read as per the .csv files from ihope_daily. "omegadq"
    is read as per the .txt or .clst produced by the detchar scripts used to
    plot omega online events.

Write the given lsctables compatible table object to the file object file
in xml format.

Arguments:

  file: file object
    file object describing output file

  table: lsctable
    glue.ligolw.lsctables compatible table

Keyword Arguments:

  program: string
    name of generating executable, defaults to self
  params: list
    list of (param,type,value) tuples to append to process_params:table

Write the lsctables.table to the given file object file, in the standard format for the given etg.

If columns is given as a list, the standard format will be overwritten and only the given columns will be processed.

Reads a trigger table from the given table from the xml
file object file

Arguments:

  file : file object

Keyword arguments:

  start : [ float | int | LIGOTimeGPS ]
    GPS start time of requested period
  end : [ float | int | LIGOTimeGPS ]
    GPS end time of requested period
  tablename : string
    name of requested trigger table in xml file, defaults to
    'sngl_inspiral:table'

Reads the file object file containing standard columns for the given etg and
returns either a corresponding lsctable.

Arguments:

  file : file object
  etg : [ "ihope" | "kw" | "omega" | "omegadq" ]
    string defining how to read text file.
    "ihope" is read as per the .csv files from ihope_daily. "omegadq"
    is read as per the .txt or .clst produced by the detchar scripts used to
    plot omega online events.

Keyword arguments:

  start : [ float | int | LIGOTimeGPS ]
    GPS start time of requested period
  end : [ float | int | LIGOTimeGPS ]
    GPS end time of requested period
  tabletype : type
    Specific ligolw table type for output. By default tables will be
    SnglInspiralTable or SnglBurstTable type depending on ETG

Extract triggers froa given ETG from all files in a glue.lal.Cache object. Returns a glue.ligolw.Table relevant to the given trigger generator etg.

Generates glue.lal.Cache containing CacheEntires for all daily ihope
INSPIRAL files for given ifo and clustering between start and end time.

Arguments:

  start : [ float | int | LIGOTimeGPS ]
    GPS start time of requested period
  end : [ float | int | LIGOTimeGPS ]
    GPS end time of requested period
  ifo : [ "H1" | "L1" | "V1" ]
    IFO

Keyword arguments:
  cluster : [ "unclustered" | "100ms" | "30ms" | "16s" ]
    clustering time in human format
  filetype : [ "xml" | "csv" ]
    file format of desired cache contents
  cat : [ 0 | 1 | 2 | 3 | 4 ]
    int veto category of trigger files requested

Returns a glue.lal.Cache contatining CacheEntires for all omega online
trigger files between the given start and end time for the given ifo.
For S6 triggers are only available for each IFO on it's own site cluster.

Arguments:

  start : [ float | int | LIGOTimeGPS ]
    GPS start time of requested period
  end : [ float | int | LIGOTimeGPS ]
    GPS end time of requested period
  channel name or ifo : [ "H1" | "L1" | "V1" | "G1:SEI_TCC_STS2x" | ... ]
    IFO

Returns a glue.lal.Cache contatining CacheEntires for all omega online
trigger files between the given start and end time for the given ifo.
For S6 triggers are only available for each IFO on it's own site cluster.

Arguments:

  start : [ float | int | LIGOTimeGPS ]
    GPS start time of requested period
  end : [ float | int | LIGOTimeGPS ]
    GPS end time of requested period
  ifo : [ "H1" | "L1" | "V1" ]
    IFO

Arguments:

  start : [ float | int | LIGOTimeGPS ]
    GPS start time of requested period
  end : [ float | int | LIGOTimeGPS ]
    GPS end time of requested period
  ifo : [ "H1" | "L1" | "V1" ]
    IFO

Returns a list of KW trigger files between the given start and end
time for the given ifo. For S6 triggers are only available for each IFO on
it's own site cluster.

Arguments:

  start : [ float | int | LIGOTimeGPS ]
    GPS start time of requested period
  end : [ float | int | LIGOTimeGPS ]
    GPS end time of requested period
  ifo : [ "H1" | "L1" | "V1" ]
    IFO

Cluster the lsctable triggers in the each of the pairs (column,width),
using the rank column.

Arguments:

  triggers: glue.ligowl.Table
    Table containing trigger columns for clustering

  params : list
    List object containing (column,width) pairs. Clustering is nested in
    order

  rank: string
    Column by which to rank clusters
  test

Compute autocorrelation of lsctable triggers in the each of the pairs
(column,width), using the rank column.

Arguments:

  triggers: glue.ligowl.Table
    Table containing trigger columns for clustering

  column:
    On which trigger column to auto-correlate, almost always time

  timeStep:
    Step (bin width) for the autocorrelation

  timeRange:
    Longest time to consider for autocorrelation
    

Extract column from the given glue.ligolw.table lsctable as numpy array. Tries to use a 'get_col() function if available, otherwise uses getColumnByName(), treating 'time' as a special case for the known Burst/Inspiral/Ringdown tables.

Returns a ligolw table of those triggers outwith the given seglist. If inverse=True is given, the opposite is returned, i.e. those triggers within the given seglist.

Returns the opposite of veto, i.e. those triggers that lie within the given seglist.

Load triggers from an Omega format text file into a SnglBurstTable object.
Use start and end to restrict the returned triggers, and give ifo and
channel to fill those columns in the table.

If columns is given as a list, only those columns in the table will be
filled. This is advisable to speed up future operations on this table.

Arguments :

  fname : file or str
    file object or filename path to read with numpy.loadtext

Keyword arguments :

  start : float
    minimum peak time for returned triggers
  end : float
    maximum peak time for returned triggers
  ifo : str
    name of IFO to fill in table
  channel : str
    name of channel to fill in table
  columns : iterable
    list of columnnames to populate in table

Load triggers from a KW format text file into a SnglBurstTable object.
Use start and end to restrict the returned triggers, and give ifo and
channel to fill those columns in the table.

If columns is given as a list, only those columns in the table will be
filled. This is advisable to speed up future operations on this table.

Arguments :

  fname : file or str
    file object or filename path to read with numpy.loadtext

Keyword arguments :

  start : float
    minimum peak time for returned triggers
  end : float
    maximum peak time for returned triggers
  ifo : str
    name of IFO to fill in table
  channel : str
    name of channel to fill in table
  columns : iterable
    list of columnnames to populate in table

Load triggers from an OmegaSpectrum format text file into a SnglBurstTable
object.
Use start and end to restrict the returned triggers, and give ifo and
channel to fill those columns in the table.

If columns is given as a list, only those columns in the table will be
filled. This is advisable to speed up future operations on this table.

Arguments :

  fname : file or str
    file object or filename path to read with numpy.loadtext

Keyword arguments :

  start : float
    minimum peak time for returned triggers
  end : float
    maximum peak time for returned triggers
  ifo : str
    name of IFO to fill in table
  channel : str
    name of channel to fill in table
  columns : iterable
    list of columnnames to populate in table

Load triggers from an OmegaDQ format text file into a SnglBurstTable object.
Use start and end to restrict the returned triggers, and give ifo and
channel to fill those columns in the table.

If columns is given as a list, only those columns in the table will be
filled. This is advisable to speed up future operations on this table.

Arguments :

  fname : file or str
    file object or filename path to read with numpy.loadtext

Keyword arguments :

  start : float
    minimum peak time for returned triggers
  end : float
    maximum peak time for returned triggers
  ifo : str
    name of IFO to fill in table
  channel : str
    name of channel to fill in table
  columns : iterable
    list of columnnames to populate in table

Load triggers from a HACR format text file into a SnglBurstTable object.
Use start and end to restrict the returned triggers, and give ifo and
channel to fill those columns in the table.

If columns is given as a list, only those columns in the table will be
filled. This is advisable to speed up future operations on this table.

Arguments :

  fname : file or str
    file object or filename path to read with numpy.loadtext

Keyword arguments :

  start : float
    minimum peak time for returned triggers
  end : float
    maximum peak time for returned triggers
  ifo : str
    name of IFO to fill in table
  channel : str
    name of channel to fill in table
  columns : iterable
    list of columnnames to populate in table

Load triggers from an iHope format CSV file into a SnglInspiralTable object.
Use start and end to restrict the returned triggers, and give ifo and
channel to fill those columns in the table.

If columns is given as a list, only those columns in the table will be
filled. This is advisable to speed up future operations on this table.

Arguments :

  fname : file or str
    file object or filename path to read with numpy.loadtext

Keyword arguments :

  start : float
    minimum peak time for returned triggers
  end : float
    maximum peak time for returned triggers
  ifo : str
    name of IFO to fill in table
  channel : str
    name of channel to fill in table
  columns : iterable
    list of columnnames to populate in table