python.pipeparts.source Namespace Reference

Classes
class	AudioTestWaveform
class	NDSChannelType
class	SrcDeferredLink

Functions
pipetools.Element	fake_ligo (pipetools.Pipeline pipeline, str instrument=None, str channel_name=None, int blocksize=16384 *8 *1)
pipetools.Element	fake_aligo (pipetools.Pipeline pipeline, str instrument=None, str channel_name=None, int blocksize=16384 *8 *1)
pipetools.Element	fake_avirgo (pipetools.Pipeline pipeline, str instrument=None, str channel_name=None, int blocksize=16384 *8 *1)
pipetools.Element	segment (pipetools.Pipeline pipeline, List[Tuple[pipetools.TimeGPS, pipetools.TimeGPS]] segment_list, int blocksize=4096 *1 *1, bool invert_output=False)
	Adds a lal_segmentsrc element to a pipeline with useful default properties.
pipetools.Element	cache (pipetools.Pipeline pipeline, str location, bool use_mmap=True, **properties)
	Adds a lal_cachesrc element to a pipeline with useful default properties.
pipetools.Element	lvshm (pipetools.Pipeline pipeline, str shm_name, **properties)
pipetools.Element	devshm (pipetools.Pipeline pipeline, str shm_dirname, **properties)
pipetools.Element	framexmit (pipetools.Pipeline pipeline, str multicast_group='0.0.0.0', int port=0, **properties)
pipetools.Element	nds (pipetools.Pipeline pipeline, str host, str instrument, str channel_name, str channel_type, int blocksize=16384 *8 *1, int port=31200)
pipetools.Element	audio_test (pipetools.Pipeline pipeline, float freq=440, float volume=0.8, int wave=AudioTestWaveform.Sine, int samples_per_buffer=1024, **properties)
	Adds a audiotestsrc element to a pipeline with useful default properties.
pipetools.Element	fake (pipetools.Pipeline pipeline, str instrument, str channel_name, int blocksize=None, float volume=1e-20, bool is_live=False, int wave=AudioTestWaveform.GaussianNoise, int rate=16384, **properties)
	see documentation for mktaginject() mkcapsfilter() and mkaudiotestsrc()
pipetools.Element	files (pipetools.Pipeline pipeline, Iterable[Union[str, pathlib.Path]] paths, str instrument, str channel_name, Optional[Union[str, pathlib.Path]] cache_path=None)

Variables
str	BYTE_ORDER = "little" else 'BE'

Detailed Description

Module for producing source elements

Function Documentation

audio_test()

pipetools.Element audio_test	(	pipetools.Pipeline	pipeline,
		float	freq = 440,
		float	volume = 0.8,
		int	wave = AudioTestWaveform.Sine,
		int	samples_per_buffer = 1024,
		**	properties )

Adds a audiotestsrc element to a pipeline with useful default properties.

AudioTestSrc can be used to generate basic audio signals. It support several different waveforms and
    allows to set the base frequency and volume. Some waveforms might use additional properties.

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        freq:
            float, Frequency of test signal. The sample rate needs to be at least 2 times higher.
        volume:
            float, default 0.8, Volume of test signal
        wave:
            int, default 0, the type of waveform to produce. Options are:
                sine (0) – Sine
                square (1) – Square
                saw (2) – Saw
                triangle (3) – Triangle
                silence (4) – Silence
                white-noise (5) – White uniform noise
                pink-noise (6) – Pink noise
                sine-table (7) – Sine table
                ticks (8) – Periodic Ticks
                gaussian-noise (9) – White Gaussian noise
                red-noise (10) – Red (brownian) noise
                blue-noise (11) – Blue noise
                violet-noise (12) – Violet noise
        samples_per_buffer:
            int, default 1024, Number of samples in each outgoing buffer. Must be at least twice 'freq'
        **properties:

    References:
        [1] https://gstreamer.freedesktop.org/documentation/audiotestsrc/index.html?gi-language=python

    Returns:
        Element

Definition at line 300 of file source.py.

cache()

pipetools.Element cache	(	pipetools.Pipeline	pipeline,
		str	location,
		bool	use_mmap = True,
		**	properties )

Adds a lal_cachesrc element to a pipeline with useful default properties.

Retrieve frame files from locations recorded in a LAL cache file.

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        location:
            str, Path to LAL cache file.
        use_mmap:
            bool, default True, if True Use mmap() instead of read()
        **properties:

    References:
        Implementation: gstlal/gst/lal/gstlal_cachesrc.c

    Returns:
        Element

Definition at line 188 of file source.py.

devshm()

pipetools.Element devshm	(	pipetools.Pipeline	pipeline,
		str	shm_dirname,
		**	properties )

LIGO-Virgo /dev/shm frame file source element

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        shm_dirname:
            str, Shared memory directory name (full path).  Suggestion:  /dev/shm/kafka/L1_O3ReplayMDC
        **properties:

    References:
        Implementation: gstlal-ugly/gst/gds/devshmsrc.cc

    Returns:
        Element

Definition at line 227 of file source.py.

fake()

pipetools.Element fake	(	pipetools.Pipeline	pipeline,
		str	instrument,
		str	channel_name,
		int	blocksize = None,
		float	volume = 1e-20,
		bool	is_live = False,
		int	wave = AudioTestWaveform.GaussianNoise,
		int	rate = 16384,
		**	properties )

see documentation for mktaginject() mkcapsfilter() and mkaudiotestsrc()

Create an audio_test source with several additional, lal-specific caps specified

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        instrument:
            str, name of instrument
        channel_name:
            str, name of input channel
        blocksize:
            int, default 1 second * rate samples/second * 8
        volume:
            float, default 1e-20, the sample volume
        is_live:
            bool, default False, whether or not audio_test source will behave like live source
        wave:
            int, default 9 (Gaussian Noise), see AudioTestWaveform enum for options
        rate:
            int, default 16384, sample rate
        **properties:

    Returns:
        Element

Definition at line 344 of file source.py.

fake_aligo()

pipetools.Element fake_aligo	(	pipetools.Pipeline	pipeline,
		str	instrument = None,
		str	channel_name = None,
		int	blocksize = 16384 * 8 * 1 )

Fake Advanced LIGO Source

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        instrument:
            str, default None
        channel_name:
            str, default None
        blocksize:
            int, default 16384 * 8 * 1, Number of samples in each outgoing buffer

    References:
        Implementation gstlal/gst/python/lal_fakeadvligosrc.py

    Returns:
        Element

Definition at line 110 of file source.py.

fake_avirgo()

pipetools.Element fake_avirgo	(	pipetools.Pipeline	pipeline,
		str	instrument = None,
		str	channel_name = None,
		int	blocksize = 16384 * 8 * 1 )

Fake Advanced Virgo Source

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        instrument:
            str, default None
        channel_name:
            str, default None
        blocksize:
            int, default 16384 * 8 * 1, Number of samples in each outgoing buffer

    References:
        Implementation gstlal/gst/python/lal_fakeadvvirgosrc.py

    Returns:
        Element

Definition at line 134 of file source.py.

fake_ligo()

pipetools.Element fake_ligo	(	pipetools.Pipeline	pipeline,
		str	instrument = None,
		str	channel_name = None,
		int	blocksize = 16384 * 8 * 1 )

Fake LIGO Source

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        instrument:
            str, default None
        channel_name:
            str, default None
        blocksize:
            int, default 16384 * 8 * 1, Number of samples in each outgoing buffer

    References:
        Implementation gstlal/gst/python/lal_fakeligosrc.py

    Returns:
        Element

Definition at line 86 of file source.py.

files()

pipetools.Element files	(	pipetools.Pipeline	pipeline,
		Iterable[Union[str, pathlib.Path]]	paths,
		str	instrument,
		str	channel_name,
		Optional[Union[str, pathlib.Path]]	cache_path = None )

Create a source from a list of file paths

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        paths:
            Iterable[Path or str], the full paths to the frame files
        cache_path:
            Path or str, default None, the path to write out the cache file if specified, else write to temporary directory

    Notes:
        This is a convenience utility around cache source and framecppdemux that creates a cache file
        from a list of file paths

    Returns:
        Element

Definition at line 381 of file source.py.

framexmit()

pipetools.Element framexmit	(	pipetools.Pipeline	pipeline,
		str	multicast_group = '0.0.0.0',
		int	port = 0,
		**	properties )

FrameXMIT based source element

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        multicast_group:
            str, default "0.0.0.0", The address of multicast group to join.  If no multicast address is supplied, the receiver will listen for
            UDP/IP broadcast transmissions at the specified port.
        port:
            int, default 0, The local port on which to receive broadcasts (0 = allocate).  These ports can be reused by multiple applications.
        **properties:

    References:
        Implementation: gstlal-ugly/gst/gds/framexmitsrc.cc

    Returns:
        Element

Definition at line 246 of file source.py.

lvshm()

pipetools.Element lvshm	(	pipetools.Pipeline	pipeline,
		str	shm_name,
		**	properties )

LIGO-Virgo shared memory frame file source element

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        shm_name:
            str, Shared memory partition name.  Suggestions:  LHO_Data, LLO_Data, VIRGO_Data
        **properties:

    References:
        Implementation: gstlal-ugly/gst/gds/lvshmsrc.cc

    Returns:
        Element

Definition at line 209 of file source.py.

nds()

pipetools.Element nds	(	pipetools.Pipeline	pipeline,
		str	host,
		str	instrument,
		str	channel_name,
		str	channel_type,
		int	blocksize = 16384 * 8 * 1,
		int	port = 31200 )

NDS-based src element

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        host:
            str, NDS1 or NDS2 remote host name or IP address
        instrument:
            str, name of instrument
        channel_name:
            str, Name of the desired NDS channel.
        channel_type:
            str, Type of the desired NDS channel.
        blocksize:
            int, default 16384 * 8 * 1, blocksize
        port:
            int, NDS1 or NDS2 remote host port

    References:
        Implementation: gstlal-ugly/gst/nds/ndssrc.c

    Returns:
        Element

Definition at line 268 of file source.py.

segment()

pipetools.Element segment	(	pipetools.Pipeline	pipeline,
		List[Tuple[pipetools.TimeGPS, pipetools.TimeGPS]]	segment_list,
		int	blocksize = 4096 * 1 * 1,
		bool	invert_output = False )

Adds a lal_segmentsrc element to a pipeline with useful default properties.

The output is a buffer of boolean values specifying when a list of segments are on and off.

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        segment_list:
            Iterable[Tuple[TimeGPS, TimeGPS]], list of segment start / stop times
        blocksize:
            int, default blocksize is 4096 seconds of unsigned integers at 1 Hz, e.g. segments without nanoseconds
        invert_output:
            bool, default False, False = output is high in segments (default), True = output is low in segments

    References:
        Implementation: gstlal/gst/lal/gstlal_segmentsrc.c

    Returns:
        Element

Definition at line 162 of file source.py.

Variable Documentation

BYTE_ORDER

str python.pipeparts.source.BYTE_ORDER = "little" else 'BE'

Definition at line 14 of file source.py.