gstlal 1.13.0
Loading...
Searching...
No Matches
python.pipeparts.mux.FrameCPPChannelDemuxSetUnitsHandler Class Reference
Inheritance diagram for python.pipeparts.mux.FrameCPPChannelDemuxSetUnitsHandler:
Collaboration diagram for python.pipeparts.mux.FrameCPPChannelDemuxSetUnitsHandler:

Public Member Functions

 __init__ (self, elem, units_dict)

Static Public Member Functions

 pad_added (element, pad, units_dict)

Public Attributes

 elem = elem
 pad_added_handler_id = elem.connect("pad-added", self.pad_added, units_dict)

Detailed Description

Definition at line 20 of file mux.py.

Constructor & Destructor Documentation

◆ __init__()

python.pipeparts.mux.FrameCPPChannelDemuxSetUnitsHandler.__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:

>>> FrameCPPChannelDemuxSetUnitsHandler(elem, {"H1:LSC-STRAIN": "strain"}) # doctest: +SKIP

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 21 of file mux.py.

Member Function Documentation

◆ pad_added()

python.pipeparts.mux.FrameCPPChannelDemuxSetUnitsHandler.pad_added ( element,
pad,
units_dict )
static

Definition at line 48 of file mux.py.

Member Data Documentation

◆ elem

python.pipeparts.mux.FrameCPPChannelDemuxSetUnitsHandler.elem = elem

Definition at line 43 of file mux.py.

◆ pad_added_handler_id

python.pipeparts.mux.FrameCPPChannelDemuxSetUnitsHandler.pad_added_handler_id = elem.connect("pad-added", self.pad_added, units_dict)

Definition at line 44 of file mux.py.


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