Module plottriggers

source code

This modules provides some wrapper functions for the classes defined in pylal.plotutils.

Version: 8cbd1b7187ce3ed9a825d6ed11cc432f3cfde9a5

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

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

Functions

[hide private]

get_column(lsctable, column)
Extract column from the given glue.ligolw.table lsctable as numpy array.

source code

plottable(lsctable, outfile, xcolumn="time", ycolumn="snr", colorcolumn=None, rankcolumn=None, t0=None, **kwargs)
Plot any column of a valid LigoLW table against any other, coloured by any other, or plot all the same if you're that way inclined.

source code

plothistogram(lsctable, outfile, column="snr", numbins=100, colorcolumn=None, colorbins=10, normalize=None, cumulative=None, bar=False, **kwargs)
Plot any column of a valid LigoLW table against any other, coloured by any other, or plot all the same if you're that way inclined.

source code

plotrate(lsctable, outfile, stride=60, column="peak_frequency", bins=[], t0=None, **kwargs)
Plot rate versus time for the given ligolw table triggers, binned by the given bincolumn using the bins list.

source code

Variables

[hide private]

pylab = plotutils.pylab

matplotlib = pylab.matplotlib

jet = copy.deepcopy(matplotlib.cm.jet)

Function Details

[hide private]

get_column(lsctable, column)

source code

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.

plottable(lsctable, outfile, xcolumn="time", ycolumn="snr", colorcolumn=None, rankcolumn=None, t0=None, **kwargs)

source code


Plot any column of a valid LigoLW table against any other, coloured by any
other, or plot all the same if you're that way inclined. Multiple tables
can be given for any non-coloured plot.

"time" as a column means the output of get_peak for Burst tables, get_end
for Inspiral tables, and get_start for ringdown tables

Arguments:

    tables : [ dict | glue.ligolw.table.Table ]
        dict of ("name", table) pairs, or single LigoLW tables
    outfile : string
        string path for output plot

Keyword arguments:

    xcolumn : string
        valid column of triggers table to plot on x-axis
    ycolumn : string
        valid column of triggers table to plot on y-axis
    zcolumn : string
        valid column of triggers table to use for colorbar (optional).

plothistogram(lsctable, outfile, column="snr", numbins=100, colorcolumn=None, colorbins=10, normalize=None, cumulative=None, bar=False, **kwargs)

source code


Plot any column of a valid LigoLW table against any other, coloured by any
other, or plot all the same if you're that way inclined. Multiple tables
can be given for any non-coloured plot.

"time" as a column means the output of get_peak for Burst tables, get_end
for Inspiral tables, and get_start for ringdown tables

Arguments:

    table : [ dict | glue.ligolw.table.Table ]
        dict of ("name", table) pairs, or single LigoLW table
    outfile : string
        string path for output plot

Keyword arguments:
    xcolumn : string
        valid column of triggers table to plot on x-axis
    ycolumn : string
        valid column of triggers table to plot on y-axis
    zcolumn : string
        valid column of triggers table to use for colorbar (optional).

plotrate(lsctable, outfile, stride=60, column="peak_frequency", bins=[], t0=None, **kwargs)

source code


Plot rate versus time for the given ligolw table triggers, binned by the
given bincolumn using the bins list.

Arguments:

    lsctable : glue.ligolw.table.Table
        LIGOLW table containing a list of triggers
    outfile : string
        string path for output plot