Functions
	trigger (pipetools.Pipeline pipeline, pipetools.Element src, int n, numpy.ndarray autocorrelation_matrix=None, numpy.ndarray mask_matrix=None, float snr_thresh=0, float sigmasq=None, bool max_snr=False)
	burst_trigger_gen (pipeline, src, **properties)
pipetools.Element	blcbc_trigger_gen (pipetools.Pipeline pipeline, pipetools.Element snr, pipetools.Element chisq, str template_bank_filename, float snr_threshold, pipetools.ValueArray sigmasq)
pipetools.Element	trigger_gen (pipetools.Pipeline pipeline, pipetools.Element snr, pipetools.Element chisq, str template_bank_filename, float snr_threshold, pipetools.ValueArray sigmasq)
pipetools.Element	itac (pipetools.Pipeline pipeline, pipetools.Element src, int n, str bank, numpy.ndarray autocorrelation_matrix=None, numpy.ndarray mask_matrix=None, snr_thresh=0, sigmasq=None)
	itacac (pipeline, srcs, **properties)

Detailed Description

Module for making trigger elements

Function Documentation

◆ blcbc_trigger_gen()

pipetools.Element blcbc_trigger_gen	(	pipetools.Pipeline	pipeline,
		pipetools.Element	snr,
		pipetools.Element	chisq,
		str	template_bank_filename,
		float	snr_threshold,
		pipetools.ValueArray	sigmasq )

Produce sngl_inspiral records from SNR and chi squared.
   A trigger is recorded for every instant at which the absolute value of the SNR
   is greater than snr-thresh, and also greater than at all of the window seconds
   of data that come before and after.  snr-thresh and window are properties of
   this element.  This element has a bounded latency of ~ window and is suitable
   for online applications, or applications where precise triggering behavior with
   small chunks of data is required

   The maximum possible trigger rate is (1/window) Hz per template.

   Args:
    pipeline:
        Gst.Pipeline, the pipeline to which the new element will be added
    snr:
        Gst.Element, the source element
    chisq:
        Element
    template_bank_filename:
        str, Path to XML file used to generate the template bank.  Setting this property resets sigmasq to a vector of 0s.
    snr_threshold:
        float, SNR Threshold that determines a trigger.
    sigmasq:
        Vector of \\sigma^{2} factors.

   References:
    [1] gstlal/gstlal-inspiral/gst/lal/gstlal_blcbc_triggergen.c

   Returns:
    Element, the blcbc trigger gen

Definition at line 74 of file trigger.py.

◆ burst_trigger_gen()

burst_trigger_gen	(		pipeline,
			src,
		**	properties )

Burst Triggergen, find burst triggers in snr streams

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        src:
            Gst.Element, the source element
        **properties:

    References:
        [1] BurstTriggerGen Implementation: gstlal/gstlal-burst/gst/lal/gstlal_burst_triggergen.c

    Returns:
        Element, the trigger gen element

Definition at line 55 of file trigger.py.

◆ itac()

pipetools.Element itac	(	pipetools.Pipeline	pipeline,
		pipetools.Element	src,
		int	n,
		str	bank,
		numpy.ndarray	autocorrelation_matrix = None,
		numpy.ndarray	mask_matrix = None,
			snr_thresh = 0,
			sigmasq = None )

Find inspiral triggers in snr streams

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        src:
            Gst.Element, the source element
        n:
            int, number of samples over which to identify itacs
        bank:
            str, Path to XML file used to generate the template bank.  Setting this property resets sigmasq to a vector of 0s.
        autocorrelation_matrix:
            array, Array of complex autocorrelation vectors.  Number of vectors (rows) in matrix sets number of channels.  All vectors must have the same length.
        mask_matrix:
            array, Array of integer autocorrelation mask vectors.  Number of vectors (rows) in mask sets number of channels.  All vectors must have the same
            length. The mask values are either 0 or 1 and indicate whether to use the corresponding matrix entry in computing the autocorrelation chi-sq statistic.
        snr_thresh:
            float, SNR Threshold that determines a trigger.
        sigmasq:
            array, Vector of \\sigma^{2} factors.  The effective distance of a trigger is \\sqrt{sigma^{2}} / SNR.

    References:
        Implementation: gstlal-inspiral/gst/lal/gstlal_itac.c

    Returns:
        Element

Definition at line 150 of file trigger.py.

◆ itacac()

itacac	(		pipeline,
			srcs,
		**	properties )

Find coincident inspiral triggers in snr streams from multiple detectors

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        srcs:
            Mapping[str, Gst.Element], maps detector strings to Gst.Elements
        **properties
            maps detector strings to pad properties

    References:
        Implementation: gstlal-inspiral/gst/lal/gstlal_itacac.c

    Returns:
        Element

Definition at line 193 of file trigger.py.

◆ trigger()

trigger	(	pipetools.Pipeline	pipeline,
		pipetools.Element	src,
		int	n,
		numpy.ndarray	autocorrelation_matrix = None,
		numpy.ndarray	mask_matrix = None,
		float	snr_thresh = 0,
		float	sigmasq = None,
		bool	max_snr = False )

Generic trigger generator, find triggers in snr streams

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        src:
            Gst.Element, the source element
        n:
            int, number of samples over which to identify triggers
        autocorrelation_matrix:
            ndarray, Array of complex autocorrelation vectors. Number of vectors (rows) in matrix sets number of channels.
            All vectors must have the same length.
        mask_matrix:
            ndarray, Array of integer autocorrelation mask vectors. Number of vectors (rows) in mask sets number of channels.
            All vectors must have the same length. The mask values are either 0 or 1 and indicate whether to use the corresponding
            matrix entry in computing the autocorrelation chi-sq statistic.
        snr_thresh:
            float, default 0, SNR Threshold that determines a trigger
        sigmasq:
            float, default None
        max_snr:
            bool, default False, Set flag to return single loudest trigger from buffer

    References:
        [1] GstLAL Trigger Implementation: gstlal/gstlal-burst/gst/lal/gstlal_trigger.c

    Returns:
        Element, the trigger element

Definition at line 10 of file trigger.py.

◆ trigger_gen()

pipetools.Element trigger_gen	(	pipetools.Pipeline	pipeline,
		pipetools.Element	snr,
		pipetools.Element	chisq,
		str	template_bank_filename,
		float	snr_threshold,
		pipetools.ValueArray	sigmasq )

Produce sngl_inspiral records from SNR and chi squared.
    A trigger is recorded for every instant at which the absolute value of the SNR
    is greater than snr-thresh, and also greater than at all of the max_gap seconds
    of data that come before and after.  snr-thresh and max_gap are properties of
    this element

    The maximum possible trigger rate is (1/max_gap) Hz per template.

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        snr:
            Gst.Element, the source element
        chisq:
            Element
        template_bank_filename:
            str, Path to XML file used to generate the template bank.  Setting this property resets sigmasq to a vector of 0s.
        snr_threshold:
            float, SNR Threshold that determines a trigger.
        sigmasq:
            Vector of \\sigma^{2} factors.

    References:
        Implementation: gstlal-inspiral/gst/lal/gstlal_triggergen.c

    Returns:
        Element

Definition at line 113 of file trigger.py.

Functions