LAL  7.5.0.1-08ee4f4
lal.series Namespace Reference

Functions

def build_REAL4FrequencySeries (series, comment=None)
 
def parse_REAL4FrequencySeries (elem)
 
def build_REAL8FrequencySeries (series, comment=None)
 
def parse_REAL8FrequencySeries (elem)
 
def build_COMPLEX8FrequencySeries (series, comment=None)
 
def parse_COMPLEX8FrequencySeries (elem)
 
def build_COMPLEX16FrequencySeries (series, comment=None)
 
def parse_COMPLEX16FrequencySeries (elem)
 
def build_REAL4TimeSeries (series, comment=None)
 
def parse_REAL4TimeSeries (elem)
 
def build_REAL8TimeSeries (series, comment=None)
 
def parse_REAL8TimeSeries (elem)
 
def build_COMPLEX8TimeSeries (series, comment=None)
 
def parse_COMPLEX8TimeSeries (elem)
 
def build_COMPLEX16TimeSeries (series, comment=None)
 
def parse_COMPLEX16TimeSeries (elem)
 
def make_psd_xmldoc (psddict, xmldoc=None, root_name=u"psd")
 Construct an XML document tree representation of a dictionary of frequency series objects containing PSDs. More...
 
def read_psd_xmldoc (xmldoc, root_name=u"psd")
 Parse a dictionary of PSD frequency series objects from an XML document. More...
 

Variables

 Attributes = ligolw.sax.xmlreader.AttributesImpl
 

Function Documentation

◆ build_REAL4FrequencySeries()

def lal.series.build_REAL4FrequencySeries (   series,
  comment = None 
)

Definition at line 114 of file series.py.

◆ parse_REAL4FrequencySeries()

def lal.series.parse_REAL4FrequencySeries (   elem)

Definition at line 119 of file series.py.

◆ build_REAL8FrequencySeries()

def lal.series.build_REAL8FrequencySeries (   series,
  comment = None 
)

Definition at line 123 of file series.py.

◆ parse_REAL8FrequencySeries()

def lal.series.parse_REAL8FrequencySeries (   elem)

Definition at line 128 of file series.py.

◆ build_COMPLEX8FrequencySeries()

def lal.series.build_COMPLEX8FrequencySeries (   series,
  comment = None 
)

Definition at line 132 of file series.py.

◆ parse_COMPLEX8FrequencySeries()

def lal.series.parse_COMPLEX8FrequencySeries (   elem)

Definition at line 137 of file series.py.

◆ build_COMPLEX16FrequencySeries()

def lal.series.build_COMPLEX16FrequencySeries (   series,
  comment = None 
)

Definition at line 141 of file series.py.

◆ parse_COMPLEX16FrequencySeries()

def lal.series.parse_COMPLEX16FrequencySeries (   elem)

Definition at line 146 of file series.py.

◆ build_REAL4TimeSeries()

def lal.series.build_REAL4TimeSeries (   series,
  comment = None 
)

Definition at line 150 of file series.py.

◆ parse_REAL4TimeSeries()

def lal.series.parse_REAL4TimeSeries (   elem)

Definition at line 155 of file series.py.

◆ build_REAL8TimeSeries()

def lal.series.build_REAL8TimeSeries (   series,
  comment = None 
)

Definition at line 159 of file series.py.

◆ parse_REAL8TimeSeries()

def lal.series.parse_REAL8TimeSeries (   elem)

Definition at line 164 of file series.py.

◆ build_COMPLEX8TimeSeries()

def lal.series.build_COMPLEX8TimeSeries (   series,
  comment = None 
)

Definition at line 168 of file series.py.

◆ parse_COMPLEX8TimeSeries()

def lal.series.parse_COMPLEX8TimeSeries (   elem)

Definition at line 173 of file series.py.

◆ build_COMPLEX16TimeSeries()

def lal.series.build_COMPLEX16TimeSeries (   series,
  comment = None 
)

Definition at line 177 of file series.py.

◆ parse_COMPLEX16TimeSeries()

def lal.series.parse_COMPLEX16TimeSeries (   elem)

Definition at line 182 of file series.py.

◆ make_psd_xmldoc()

def lal.series.make_psd_xmldoc (   psddict,
  xmldoc = None,
  root_name = u"psd" 
)

Construct an XML document tree representation of a dictionary of frequency series objects containing PSDs.

See also read_psd_xmldoc() for a function to parse the resulting XML documents.

If xmldoc is None (the default), then a new XML document is created and the PSD dictionary added to it inside a LIGO_LW element. If xmldoc is not None then the PSD dictionary is appended to the children of that element inside a new LIGO_LW element. In both cases, the LIGO_LW element's Name attribute is set to root_name. This will be looked for by read_psd_xmldoc() when parsing the PSD document.

Definition at line 207 of file series.py.

◆ read_psd_xmldoc()

def lal.series.read_psd_xmldoc (   xmldoc,
  root_name = u"psd" 
)

Parse a dictionary of PSD frequency series objects from an XML document.

See also make_psd_xmldoc() for the construction of XML documents from a dictionary of PSDs. Interprets an empty frequency series for an instrument as None.

The XML document tree is searched for a LIGO_LW element whose Name attribute is root_name (default is "psd"). If root_name is None all REAL8Frequency series objects below xmldoc are included in the return value.

Definition at line 229 of file series.py.

Variable Documentation

◆ Attributes

lal.series.Attributes = ligolw.sax.xmlreader.AttributesImpl

Definition at line 37 of file series.py.