python.pipeparts.framecpp_channeldemux_set_units Class Reference

Inheritance diagram for python.pipeparts.framecpp_channeldemux_set_units:

Collaboration diagram for python.pipeparts.framecpp_channeldemux_set_units:

Public Member Functions
def	__init__ (self, elem, units_dict)

Static Public Member Functions
def	pad_added (element, pad, units_dict)

Public Attributes
	elem
	pad_added_handler_id

Detailed Description

Definition at line 145 of file __init__.py.

Constructor & Destructor Documentation

__init__()

def python.pipeparts.framecpp_channeldemux_set_units.__init__	(		self,
			elem,
			units_dict
	)

Connect a handler for the pad-added signal of the
framecpp_channeldemux element elem, and when a pad is added
to the element if the pad's name appears as a key in the
units_dict dictionary that pad's units property will be set
to the string value associated with that key in the
dictionary.

Example:

>>> framecpp_channeldemux_set_units(elem, {"H1:LSC-STRAIN": "strain"})

NOTE:  this is a work-around to address the problem that
most (all?) frame files do not have units set on their
channel data, whereas downstream consumers of the data
might require information about the units.  The demuxer
provides the units as part of a tag event, and
framecpp_channeldemux_set_units() can be used to override
the values, thereby correcting absent or incorrect units
information.

Definition at line 146 of file __init__.py.

---

The documentation for this class was generated from the following file:

• /home/abuild/rpmbuild/BUILD/gstlal-1.4.1/python/pipeparts/__init__.py