Module plotsegments

source code

Author: Nickolas Fotopoulos <nvf@gravity.phys.uwm.edu>

Classes

[hide private]

PlotSegmentsPlot
Represent a plotsegments plot.

Functions

[hide private]

plotsegmentlistdict(segdict, outfile, keys=None, t0=None, highlight_segments=None, insetlabels=None, **kwargs)
Plots a glue.segments.segmentlistdict using the PlotSegmentsPlot class from pylal.plotutils.

source code

plothistogram(segdict, outfile, keys=None, num_bins=100, **kwargs)
Plots a histogram of segment duration for each entry in the glue.segments.segmentlistdict segdict.

source code

plotdutycycle(segdict, outfile, binlength=3600, keys=None, t0=None, showmean=False, **kwargs)
Plot the percentage duty cycle each flag in the given glue.segments.segmentlistdict, binned over the given duration.

source code

Function Details

[hide private]

plotsegmentlistdict(segdict, outfile, keys=None, t0=None, highlight_segments=None, insetlabels=None, **kwargs)

source code


Plots a glue.segments.segmentlistdict using the PlotSegmentsPlot class from
pylal.plotutils.

Arguments:

    segdict : glue.segments.segmentlistdict
        dictionary of (name, segmentlist) pairs to plot.
    outfile : str
        filepath to write to

Keyword arguments:

    keys : list
        ordered list of keys to use in this order on the plot
    t0 : float
        GPS time around which to zero plot
    highlight_segments : glue.segments.segmentlistdict
        list of segments to highlight with vertical red dashed lines
    insetlabels : [ True | False ]
        write labels inside the plot axis

Unnamed keyword arguments:

    xlabel : string
        label for x-axis
    ylabel : string
        label for y-axis
    title : string
        title for plot
    subtitle : string
        subtitle for plot
    bbox_inches : str
        use "tight" to get a bounding box tight to the axis.

plothistogram(segdict, outfile, keys=None, num_bins=100, **kwargs)

source code


Plots a histogram of segment duration for each entry in the
glue.segments.segmentlistdict segdict.

Arguments:

  segdict : glue.segments.segmentlistdict
      list of segments with which to veto triggers, use dict for multiple
      datasets
  outfile : string 
      string path for output plot

Keyword arguments:

    keys : [ str | list]
        ordered list of keys to use in this order on the plot
    num_bins : int
        number of bins.

Unnamed keyword arguments:

    logx : [ True | False ]
        display x-axis in log scale
    logy : [ True | False ]
        display y-axis in log scale
    xlim : tuple
        (xmin,xmax) limits for x-axis 
    ylim : tuple
        (ymin,ymax) limits for y-axis 
    xlabel : string
        label for x-axis
    ylabel : string
        label for y-axis
    title : string
        title for plot
    subtitle : string
        subtitle for plot
    bbox_inches : str
        use "tight" to get a bounding box tight to the axis.