Tags

Tags — Extra tags to help describe gravitational-wave data streams.

Functions

Types and Values

Includes

#include <gstlal/gstlal_tags.h>

Description

Functions

gstlal_register_tags ()

void
gstlal_register_tags (void);

Register the tags with the GStreamer tags system. This function must be invoked at least once before the tags can be used. It is OK to call this function more than once. The gstlal plugin calls this function when loaded, so applications using GSTLAL elements need not invoke this function.

Types and Values

GSTLAL_TAG_INSTRUMENT

#define GSTLAL_TAG_INSTRUMENT "instrument"

The name (prefix in the jargon of the frame file spec) of the instrument from which this data stream has been collected. E.g., "H1", "L1", etc..


GSTLAL_TAG_CHANNEL_NAME

#define GSTLAL_TAG_CHANNEL_NAME "channel-name"

The channel name (without the prefix). E.g., "LSC-STRAIN".


GSTLAL_TAG_BIAS

#define GSTLAL_TAG_BIAS "adc-dc-bias"

DC bias on channel: units @ count = 0.


GSTLAL_TAG_SLOPE

#define GSTLAL_TAG_SLOPE "adc-slope"

ADC calibration: units/count.


GSTLAL_TAG_UNITS

#define GSTLAL_TAG_UNITS "units"

The units for this channel, encoded using the function XLALUnitAsString().