GSTLALGate

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

Synopsis

struct              GSTLALGate;
struct              GSTLALGateClass;
#define             GSTLAL_GATE_TYPE

Object Hierarchy

  GObject
   +----GstObject
         +----GstElement
               +----GSTLALGate

Properties

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

Signals

  "rate-changed"                                   : Run First
  "start"                                          : Run First
  "stop"                                           : Run First

Description

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

Details

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 *);
};

GstElementClass parent_class;

the parent class

rate_changed ()

start ()

stop ()


GSTLAL_GATE_TYPE

#define             GSTLAL_GATE_TYPE

Property Details

The "attack-length" property

  "attack-length"            gint64                : Read / Write / Construct

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

Default value: 0


The "default-state" property

  "default-state"            gboolean              : Read / Write / Construct

Control state to assume when control input is not available.

Default value: FALSE


The "emit-signals" property

  "emit-signals"             gboolean              : Read / Write / Construct

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.

Default value: FALSE


The "hold-length" property

  "hold-length"              gint64                : Read / Write / Construct

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

Default value: 0


The "invert-control" property

  "invert-control"           gboolean              : Read / Write / Construct

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.

Default value: FALSE


The "leaky" property

  "leaky"                    gboolean              : Read / Write / Construct

Drop buffers instead of forwarding gaps.

Default value: FALSE


The "threshold" property

  "threshold"                gdouble               : Read / Write / Construct

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

Allowed values: [0,inf]

Default value: 0

Signal Details

The "rate-changed" signal

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

gstlalgate :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "start" signal

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

gstlalgate :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "stop" signal

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

gstlalgate :

the object which received the signal.

user_data :

user data set when the signal handler was connected.