gstlal  1.4.1
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
python.pipeparts.framecpp_channeldemux_check_segments Class Reference
Inheritance diagram for python.pipeparts.framecpp_channeldemux_check_segments:
[legend]
Collaboration diagram for python.pipeparts.framecpp_channeldemux_check_segments:
[legend]

Public Member Functions

def __init__ (self, elem, seglists, jitter=LIGOTimeGPS(0, 1))
 
def pad_added (self, element, pad, seglists)
 
def set_probe (cls, pad, seglist, jitter=LIGOTimeGPS(0, 1))
 

Static Public Member Functions

def probe (pad, probeinfo, seglist, jitter, probe_id)
 

Public Attributes

 jitter
 
 probe_handler_ids
 
 pad_added_handler_id
 

Detailed Description

Utility to watch for missing data.  Pad probes are used to collect
the times spanned by buffers, these are compared to a segment list
defining the intervals of data the stream is required to have.  If
any intervals of data are found to have been skipped or if EOS is
seen before the end of the segment list then a ValueError exception
is raised.

There are two ways to use this tool.  To directly install a segment
list monitor on a single pad use the .set_probe() class method.
For elements with dynamic pads, the class can be allowed to
automatically add monitors to pads as they become available by
using the element's pad-added signal.  In this case initialize an
instance of the class with the element and a dictionary of segment
lists mapping source pad name to the segment list to check that
pad's output against.

In both cases a jitter parameter sets the maximum size of a skipped
segment that will be ignored (for example, to accomodate round-off
error in element timestamp computations).  The default is 1 ns.

Definition at line 179 of file __init__.py.


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