Package glue :: Package ligolw :: Module ligolw

Module ligolw

This module provides class definitions corresponding to the elements that can be found in a LIGO Light Weight XML file. It also provides a class representing an entire LIGO Light Weight XML document, a ContentHandler class for use with SAX2 parsers, and a convenience function for constructing a parser.

Version: git id 8cbd1b7187ce3ed9a825d6ed11cc432f3cfde9a5

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

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

Classes

[hide private]

AdcData
AdcData element.

AdcInterval
AdcInterval element.

Array
Array element.

Column
Column element.

Comment
Comment element.

Detector
Detector element.

Dim
Dim element.

Document
Description of a LIGO LW file.

Element
Base class for all element types.

ElementError
Base class for exceptions generated by elements.

EmptyElement
Parent class for Elements that cannot contain text.

FilteringLIGOLWContentHandler
LIGO LW content handler that loads everything but those parts of a document that match some criteria.

IGWDFrame
IGWDFrame element.

LIGOLWContentHandler
ContentHandler class for parsing LIGO Light Weight documents with a SAX2-compliant parser.

LIGO_LW
LIGO_LW element.

LLWNameAttr
Baseclass to hide pattern-matching of various element names.

Param
Param element.

PartialLIGOLWContentHandler
LIGO LW content handler object that loads only those parts of the document matching some criteria.

Stream
Stream element.

Table
Table element.

Time
Time element.

attributeproxy
Expose an XML attribute of an Element subclass as Python instance attribute with support for an optional default value.

Functions

[hide private]

WalkChildren(elem)
Walk the XML tree of children below elem, returning each in order.

source code

make_parser(handler)
Convenience function to construct a document parser with namespaces enabled and validation disabled.

source code

Variables

[hide private]

Header = u'<?xml version='1.0' encoding='utf-8...

Indent = u' '

NameSpace = u'http://ldas-sw.ligo.caltech.edu/doc/ligolwAPI/ht...

__package__ = 'glue.ligolw'

Function Details

[hide private]

make_parser(handler)

source code

Convenience function to construct a document parser with namespaces enabled and validation disabled. Document validation is a nice feature, but enabling validation can require the LIGO LW DTD to be downloaded from the LDAS document server if the DTD is not included inline in the XML. This requires a working connection to the internet and the server to be up.

Variables Details

[hide private]

Header

Value:

u'''<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE LIGO_LW SYSTEM "http://ldas-sw.ligo.caltech.edu/doc/ligolwAP
I/html/ligolw_dtd.txt">'''

NameSpace

Value:

u'http://ldas-sw.ligo.caltech.edu/doc/ligolwAPI/html/ligolw_dtd.txt'