pylal.omegautils

Module omegautils

Auxiliary functions for running and postprocessing Omega pipeline code.

Version: 8cbd1b7187ce3ed9a825d6ed11cc432f3cfde9a5

Date: 2017-12-05 15:29:36 +0000

Author: Duncan Macleod <duncan.macleod@ligo.org>

Functions

trigger(line, columns=lsctables.SnglBurst.__slots__, virgo=False, ifo=None, channel=None)
Convert a line from an Omega-format ASCII file into a SnglBurst object.

source code

fromfile(fobj, start=None, end=None, ifo=None, channel=None, columns=None, virgo=False)
Load triggers from an Omega format text file into a SnglBurstTable object.

source code

tofrequencyseries(bursttable, fcol='peak_frequency', pcol=None, name="", epoch=LIGOTimeGPS(), deltaF=0, f0=0, unit=lalStrainUnit)
Returns a numpy.array and REAL8FrequencySeries built from these OmegaSpectrum triggers.

source code

get_cache(start, end, ifo, channel, mask='DOWNSELECT', checkfilesexist=False, **kwargs)
Returns a glue.lal.Cache contatining CacheEntires for all omega online trigger files between the given start and end time for the given ifo.

source code

fromfiles(filelist, start=None, end=None, columns=None, verbose=False, virgo=False, channel=None)
Read omega triggers from a list of ASCII filepaths.

source code

fromlalcache(cache, start=None, end=None, columns=None, verbose=False, virgo=False, channel=None)
Read omega triggers from a glue.lal.Cache list of ASCII CacheEntries.

source code

Variables

[hide private]

_comment = re.compile('[#%]')

_delim = re.compile('[\t\,\s]+')

Function Details

[hide private]

fromfile(fobj, start=None, end=None, ifo=None, channel=None, columns=None, virgo=False)

source code


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
    virgo : [ True | False ]
        fobj written in Virgo OmegaOnline format

tofrequencyseries(bursttable, fcol='peak_frequency', pcol=None, name="", epoch=LIGOTimeGPS(), deltaF=0, f0=0, unit=lalStrainUnit)

source code

Returns a numpy.array and REAL8FrequencySeries built from these OmegaSpectrum triggers. The array holds the discrete frequencies at which the sectrum was calculated and the series holds the data and associated metadata.

If pcol is not given, the series data is the square of the SNR of each 'trigger'.