GSTLALGate

GSTLALGate — Flag buffers as gaps based on the value of a control input.

Properties

gint64 attack-length Read / Write / Construct
gboolean default-state Read / Write / Construct
gboolean emit-signals Read / Write / Construct
gint64 hold-length Read / Write / Construct
gboolean invert-control Read / Write / Construct
gboolean leaky Read / Write / Construct
gdouble threshold Read / Write / Construct

Signals

void rate-changed Run First
void start Run First
void stop Run First

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GstObject
            ╰── GstElement
                ╰── GSTLALGate

Description

Reviewed: 8466e17ed01185bd3182603207d2ac322f502967 2014-08-14 K. Cannon, J. Creighton, B. Sathyaprakash.

Completed Actions:

  • removed 64-bit support for control stream: not possibleto specify threshold to that precision

  • Why not signal control_queue_head_changed on receipt of NEW_SEGMENT? not needed.

Functions

Types and Values

GSTLAL_GATE_TYPE

#define             GSTLAL_GATE_TYPE

struct GSTLALGate

struct GSTLALGate;

struct GSTLALGateClass

struct GSTLALGateClass {
	GstElementClass parent_class;

	void (*rate_changed)(GSTLALGate *, gint, void *);
	void (*start)(GSTLALGate *, guint64, void *);
	void (*stop)(GSTLALGate *, guint64, void *);
};

Members

rate_changed ()

   

start ()

   

stop ()

   

Property Details

The “attack-length” property

  “attack-length”            gint64

Number of samples of the input stream ahead of negative-to-positive threshold crossing to include in non-gap output.

Flags: Read / Write / Construct

Default value: 0


The “default-state” property

  “default-state”            gboolean

Control state to assume when control input is not available.

Flags: Read / Write / Construct

Default value: FALSE


The “emit-signals” property

  “emit-signals”             gboolean

Emit start and stop signals (rate-changed is always emited). The start and stop signals are emited on gap-to-non-gap and non-gap-to-gap transitions in the output stream respectively.

Flags: Read / Write / Construct

Default value: FALSE


The “hold-length” property

  “hold-length”              gint64

Number of samples of the input stream following positive-to-negative threshold crossing to include in non-gap output.

Flags: Read / Write / Construct

Default value: 0


The “invert-control” property

  “invert-control”           gboolean

Logically invert the control input. If false (default) then the output is a gap if and only if the control is < threshold; if true then the output is a gap if and only if the control is >= threshold.

Flags: Read / Write / Construct

Default value: FALSE


The “leaky” property

  “leaky”                    gboolean

Drop buffers instead of forwarding gaps.

Flags: Read / Write / Construct

Default value: FALSE


The “threshold” property

  “threshold”                gdouble

Output will be flagged as non-gap when magnitude of control input is >= this value. See also invert-control.

Flags: Read / Write / Construct

Allowed values: [0,inf]

Default value: 0

Signal Details

The “rate-changed” signal

void
user_function (GSTLALGate *gstlalgate,
               gint        arg1,
               gpointer    user_data)

Flags: Run First


The “start” signal

void
user_function (GSTLALGate *gstlalgate,
               guint64     arg1,
               gpointer    user_data)

Flags: Run First


The “stop” signal

void
user_function (GSTLALGate *gstlalgate,
               guint64     arg1,
               gpointer    user_data)

Flags: Run First