igwn_ligolw.ligolw Module

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.

Functions

WalkChildren(elem)

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

make_parser(handler)

Convenience function to construct a document parser with namespaces enabled and validation disabled.

Classes

AdcData([attrs])

AdcData element.

AdcInterval([attrs])

AdcInterval element.

Array(*args)

Array element.

Column([attrs])

Column element.

Comment([attrs])

Comment element.

Detector([attrs])

Detector element.

Dim([attrs])

Dim element.

Document([attrs])

Description of a LIGO LW file.

Element([attrs])

Base class for all element types.

ElementError

Base class for exceptions generated by elements.

EmptyElement([attrs])

Parent class for Elements that cannot contain text.

Encoding()

FilteringLIGOLWContentHandler(document, ...)

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

IGWDFrame([attrs])

IGWDFrame element.

LIGOLWContentHandler(document[, start_handlers])

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

LIGO_LW([attrs])

LIGO_LW element.

LLWNameAttr(name)

Baseclass to hide pattern-matching of various element names.

Param([attrs])

Param element.

PartialLIGOLWContentHandler(document, ...)

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

Stream(*args)

Stream element.

Table([attrs])

Table element that knows about its columns and a provides a list-like interface to its rows.

Time(*args)

Time element.

attributeproxy(name[, enc, dec, default, doc])

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

Class Inheritance Diagram

Inheritance diagram of igwn_ligolw.ligolw.AdcData, igwn_ligolw.ligolw.AdcInterval, igwn_ligolw.ligolw.Array, igwn_ligolw.ligolw.Column, igwn_ligolw.ligolw.Comment, igwn_ligolw.ligolw.Detector, igwn_ligolw.ligolw.Dim, igwn_ligolw.ligolw.Document, igwn_ligolw.ligolw.Element, igwn_ligolw.ligolw.ElementError, igwn_ligolw.ligolw.EmptyElement, igwn_ligolw.ligolw.Encoding, igwn_ligolw.ligolw.FilteringLIGOLWContentHandler, igwn_ligolw.ligolw.IGWDFrame, igwn_ligolw.ligolw.LIGOLWContentHandler, igwn_ligolw.ligolw.LIGO_LW, igwn_ligolw.ligolw.LLWNameAttr, igwn_ligolw.ligolw.Param, igwn_ligolw.ligolw.PartialLIGOLWContentHandler, igwn_ligolw.ligolw.Stream, igwn_ligolw.ligolw.Table, igwn_ligolw.ligolw.Time, igwn_ligolw.ligolw.attributeproxy