Home       Trees       Indices       Help   
glue
Package glue :: Package ligolw :: Package utils :: Module search_summary
[hide private]
[frames] | no frames]

Module search_summary

source code

A collection of utilities to assist applications in manipulating the search_summary table in LIGO Light-Weight XML documents.

Version: git id 8cbd1b7187ce3ed9a825d6ed11cc432f3cfde9a5

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

Author: Kipp Cannon <kipp.cannon@ligo.org>

Functions [hide private]
 
append_search_summary(xmldoc, process, shared_object='standalone', lalwrapper_cvs_tag='', lal_cvs_tag='', comment=None, ifos=None, inseg=None, outseg=None, nevents=0, nnodes=1)
Append search summary information associated with the given process to the search summary table in xmldoc.		 source code
 
segmentlistdict_fromsearchsummary(xmldoc, program=None)
Convenience wrapper for a common case usage of the segmentlistdict class: searches the process table in xmldoc for occurances of a program named program, then scans the search summary table for matching process IDs and constructs a segmentlistdict object from the out segments in those rows.		 source code
 
segmentlistdict_fromsearchsummary_in(xmldoc, program=None)
Convenience wrapper for a common case usage of the segmentlistdict class: searches the process table in xmldoc for occurances of a program named program, then scans the search summary table for matching process IDs and constructs a segmentlistdict object from the in segments in those rows.		 source code
 
segmentlistdict_fromsearchsummary_out(xmldoc, program=None)
Convenience wrapper for a common case usage of the segmentlistdict class: searches the process table in xmldoc for occurances of a program named program, then scans the search summary table for matching process IDs and constructs a segmentlistdict object from the out segments in those rows.		 source code
Variables [hide private]
  __package__ = 'glue.ligolw.utils'
Function Details [hide private]

append_search_summary(xmldoc, process, shared_object='standalone', lalwrapper_cvs_tag='', lal_cvs_tag='', comment=None, ifos=None, inseg=None, outseg=None, nevents=0, nnodes=1)

source code 

Append search summary information associated with the given process to the search summary table in xmldoc. Returns the newly-created search_summary table row.

segmentlistdict_fromsearchsummary(xmldoc, program=None)

source code 

Convenience wrapper for a common case usage of the segmentlistdict class: searches the process table in xmldoc for occurances of a program named program, then scans the search summary table for matching process IDs and constructs a segmentlistdict object from the out segments in those rows.

Note: the segmentlists in the segmentlistdict are not necessarily coalesced, they contain the segments as they appear in the search_summary table.

segmentlistdict_fromsearchsummary_in(xmldoc, program=None)

source code 

Convenience wrapper for a common case usage of the segmentlistdict class: searches the process table in xmldoc for occurances of a program named program, then scans the search summary table for matching process IDs and constructs a segmentlistdict object from the in segments in those rows.

Note: the segmentlists in the segmentlistdict are not necessarily coalesced, they contain the segments as they appear in the search_summary table.

segmentlistdict_fromsearchsummary_out(xmldoc, program=None)

source code 

Convenience wrapper for a common case usage of the segmentlistdict class: searches the process table in xmldoc for occurances of a program named program, then scans the search summary table for matching process IDs and constructs a segmentlistdict object from the out segments in those rows.

Note: the segmentlists in the segmentlistdict are not necessarily coalesced, they contain the segments as they appear in the search_summary table.


   Home       Trees       Indices       Help   
glue
Generated by Epydoc 3.0.1 on Tue Dec 12 00:34:18 2017 http://epydoc.sourceforge.net