Package pylal :: Module InspiralUtils

[frames] | no frames]

Module InspiralUtils

source code

Utilities for the inspiral plotting functions

Classes

[hide private]

InspiralPage
This is a class to contain all the bits of a inspiral page showing the results of a piece of code.

SummValueContentHandler
Content handler that only reads in the SummValue table

Functions

[hide private]

get_coinc_ifo_colors(ifo_set)
Given an ifo set, returns an html color code for plotting.

source code

savefig_pylal(filename=None, filename_thumb=None, doThumb=True, dpi=None, dpi_thumb=50, fig=None)
@param filename: filename in which to save the figure...

source code

ErrorMessagePlotting(opts, thisplot)

source code

message(opts, text)

source code

set_figure_tag(plot_description, datatype_plotted='', open_box=True)
Returns a string containing a standard naming convention for the tag part of a figure name.

source code

set_figure_name(opts, figure_tag)
return a string containing a standard output name for pylal plotting functions.

source code

write_coinc_summ_table(tableList=[], commentList=[], stat=None, statTag=None, number=None, format=None, followup=None, followupOpts=None)
picks out loudest coincident triggers from given CoincInspiralUtils Tables and returns info about the coincidences in a html or wiki table

source code

write_html_output(opts, args, fnameList, tagLists, doThumb=True, mapList=[], comment=None, CoincSummTable=None, html_tag='', add_box_flag=False)

source code

write_cache_output(opts, html_filename, fnameList)
write the output cache file of theplotting functions

source code

writeProcessParams(name, version, command)
Convert input parameters from the process params that the code was called with into a formatted string that can be saved within an other document (e.g., HTML)

source code

AddFileToCache(fname, cache)
Add the given file to the lal.Cache

source code

GenerateCache(fileList)
Generate a lal.Cache for the list of files

source code

initialise(opts, name, version=None)
Create suffix and prefix that will be used to name the output files.

source code

init_markup_page(opts)
Load the markup module, and initialise the HTML document if the opts argument contains enable_ouput option.

source code

readHorizonDistanceFromSummValueTable(fList, verbose=False, contenthandler=SummValueContentHandler)
read in the SummValueTables from a list of files and return the horizon distance versus total mass

source code

Variables

[hide private]

colors = {'G1': 'k', 'H1': 'r', 'H2': 'b', 'L1': 'g', 'V1': 'm'}

symbols = {'G1': 'Y', 'H1': 'x', 'H2': 'o', 'L1': '+', 'V1': '1'}

Function Details

[hide private]

savefig_pylal(filename=None, filename_thumb=None, doThumb=True, dpi=None, dpi_thumb=50, fig=None)

source code


@param filename: filename in which to save the figure
@param filename_thumb: filename into which save a thumbnail of the figure
@param doThumb: save the thumbnail or not (doThumb=True by default)
@param dpi: resolution of the figure
@param dpi_thumb: resolution of the thumbnail (dpi=50 by default)
@param fig: the particular figure you wish to save (current figure by
       default)
@return filename_thumb if a thumbnail was created (computed from filename
        by default)

set_figure_tag(plot_description, datatype_plotted='', open_box=True)

source code

Returns a string containing a standard naming convention for the tag part of a figure name. The convention used is: ${plot_description}_${DATATYPE}_PLOTTED(_OPEN_BOX)

write_coinc_summ_table(tableList=[], commentList=[], stat=None, statTag=None, number=None, format=None, followup=None, followupOpts=None)

source code

picks out loudest coincident triggers from given CoincInspiralUtils Tables and returns info about the coincidences in a html or wiki table

Parameters:

tableList - a list of CoincInspiralUtils.coincInspiralTables
commentList - comments about each table (e.g., file name)
stat - any CoincInspiralUtils.coincStatistic
statTag - string specifying what stat used
number - number of triggers to list
format - desired output format; can be either 'html' or 'wiki'

write_html_output(opts, args, fnameList, tagLists, doThumb=True, mapList=[], comment=None, CoincSummTable=None, html_tag='', add_box_flag=False)

source code

Parameters:

opts - The options from the calling code
args - The args from the calling code
fnameList - A list of the filenames
tagLists - A list for the tags, getting added to the links
doThumb - Uses the _thumb file as the sourcs for the images
mapList - A list of dictionaries to create the image maps

writeProcessParams(name, version, command)

source code

Convert input parameters from the process params that the code was called with into a formatted string that can be saved within an other document (e.g., HTML)

Parameters:

name - name of the executable/script
version - version of the executable/script
command - command line arguments from a pylal script @return text

AddFileToCache(fname, cache)

source code

Add the given file to the lal.Cache

Parameters:

fname
cache

GenerateCache(fileList)

source code

Generate a lal.Cache for the list of files

Parameters:

fileList - a list of files @return cache

initialise(opts, name, version=None)

source code

Create suffix and prefix that will be used to name the output files. 'version' is outdated and not used anymore.

Parameters:

opts - the user arguments (user_tag, gps_end_time and gps_start_time are used).
name - name of the calling function/executable @return prefix @return suffix

init_markup_page(opts)

source code

Load the markup module, and initialise the HTML document if the opts argument contains enable_ouput option.

Parameters:

opts - the user arguments @return page @return extra

readHorizonDistanceFromSummValueTable(fList, verbose=False, contenthandler=SummValueContentHandler)

source code

read in the SummValueTables from a list of files and return the horizon distance versus total mass

Parameters:

fList - list of input files
verbose - boolean (default False)