Module seriesutils

Convert numpy.array to REAL8TimeSeries. Use frequencyseries to return
REAL8FrequencySeries.

Arguments:

    array : numpy.array
        input data array

Keyword arguments:

    name : str
        name of data source
    epoch : lal.LIGOTimeGPS
        GPS start time for array
    deltaT : float
        sampling time for data (or frequency spacing for FrequencySeries)
    f0 : float
        lower frequency limit for data
    sampleUnits : lal.Unit
        amplitude unit for array

Read data from the GWF format framefile into a REAL?TimeSeries.
Restrict data with the gpsstart and duration parameters.

Arguments:

    framefile : str
        path to input frame file
    chname : str
        name of channel to read

Keyword arguments:

    start : lal.LIGOTimeGPS
        GPS start time of requested data
    duration : float
        length of requested data series in seconds
    datatype : int
        LAL enum for requested datatype, -1 == read from frame metadata
    verbose : [ True | False ]
        verbose output

Read data from a cache object into a REAL?TimeSeries.
Restrict data with the gpsstart and duration parameters.

Arguments:

    cache : [ filepath | file | glue.lal.Cache | lalframe.FrCache ]
        object to be read to lalframe.FrCache
    chname : str
        name of channel to read

Keyword arguments:

    start : lal.LIGOTimeGPS
        GPS start time of requested data
    duration : float
        length of requested data series in seconds
    datatype : int
        LAL enum for requested datatype, -1 == read from frame metadata
    verbose : [ True | False ]
        verbose output

Read data from the lalframe.LALFrStream object stream into a REAL?TimeSeries.
Restrict data with the gpsstart and duration parameters.

Arguments:

    stream : lalframe.FrStream
        frame stream to read
    chname : str
        name of channel to read

Keyword arguments:

    start : lal.LIGOTimeGPS
        GPS start time of requested data
    duration : float
        length of requested data series in seconds
    datatype : int
        LAL enum for requested datatype, -1 == read from frame metadata
    verbose : [ True | False ]
        verbose output

Resample a REAL?TimeSeries to the new rate (Hertz). By default resampling
is done in-place and a copy of the series is returned, but if requested
the original series is duplicated before resampling and so is unaffected.

Arguments:

    series : swiglal.REAL?TimeSeries
        input timeseries to resample
    rate : float
        sampling rate (Hertz) to resample to

Keyword arguments:

    inplace : [ True | False ]
        perform resampling inplace on input series, default: True.
        If False, input series is duplicated and so is left in the original
        state.

Apply Butterworth high pass filter to REAL?TimeSeries.

Arguments:

    series : swiglal.REAL?TimeSeries
        input series to highpass
    frequency : float
        frequency below which to attenuate

Keyword arguments:

    amplitude : float
        desired amplitude response of filter
    filtorder : int
        desired order of filter
    inplace : [ True | False ]
        perform resampling inplace on input series, default: True.
        If False, input series is duplicated and so is left in the original
        state.

Apply Butterworth low pass filter to REAL?TimeSeries.

Arguments:

    series : swiglal.REAL?TimeSeries
        input series to lowpass
    frequency : float
        frequency above which to attenuate

Keyword arguments:

    amplitude : float
        desired amplitude response of filter
    filtorder : int
        desired order of filter
    inplace : [ True | False ]
        perform resampling inplace on input series, default: True.
        If False, input series is duplicated and so is left in the original
        state.

Apply Butterworth band pass filter to REAL?TimeSeries.

Arguments:

    series : swiglal.REAL?TimeSeries
        input series to lowpass
    fmin : float
        frequency below which to attenuate
    fmax : float
        frequency above which to attenuate

Keyword arguments:

    amplitude : float
      desired amplitude response of filter
    filtorder : int
       desired order of filter

Duplicate a TimeSeries or FrequencySeries.

Arguments:

    series : [ TimeSeries | FrequencySeries ]
        input series to duplicate

Calculate the average (power) spectrum of the given REAL?TimeSeries

Arguments:

    seglen : int
        length of FFT (in samples)
    stride : int
        gap between FFTs (in samples)

Keyword arguments:

    window : lal.REAL8Window
        swiglal window
    plan : lal.REAL8FFTPlan
        plan for FFT
    spectrum : [ 'median' | 'medianmean' | 'welch' ]
        averaging method for spectrum, default: 'medianmean'
    unit : lal.Unit
        LAL unit for data

Compute the average (power) spectrogram of the given REAL?TimeSeries by
stacking together average spectra for each timestep.

Arguments:

    series : REAL8TimeSeries
        input data
    step : int
        length of single average spectrum (in samples)
    seglen : int
        length of FFT (in samples)
    stride : int
        gap between FFTs (in samples)

Keyword arguments:

    window : lal.REAL8Window
        swiglal window
    plan : lal.REAL8FFTPlan
        plan for FFT
    spectrum : [ 'median' | 'medianmean' | 'welch' ]
        averaging method for spectrum, default: 'medianmean'
    unit : lal.Unit
        LAL unit for data

Convert a glue.lal.Cache object to a lalframe.FrCache object.
Writes cache to temporary file and reads to FrCache.

Arguments:

    cache : glue.lal.Cache
        LAL cache object from GLUE to convert