GstLALCacheSrc

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

Properties

gchar * cache-dsc-regex Read / Write / Construct
gchar * cache-src-regex Read / Write / Construct
gchar * location Read / Write / Construct
gboolean use-mmap Read / Write / Construct

Types and Values

Object Hierarchy

    GObject
    ╰── GstObject
        ╰── GstElement
            ╰── GstBaseSrc
                ╰── GstLALCacheSrc

Implemented Interfaces

GstLALCacheSrc implements GstURIHandler.

Description

Loads files in order from a list of files stored in a LAL cache. Each file is placed into its own GstBuffer either by reading it into memory or mmap()ing the file.

Regular expressions can be used to select a subset of files from the cache. One regular expression can be applied to the "source" column, and one to the "description" column. The regular expression syntax is the syntax recognized by the XLALCacheSieve() function in LAL. At the time of writing, this function is implemented using the regcomp() POSIX standard library routine (see regex(7)).

The element advertises support for the "lalcache" URI protocol. The URI format is

lalcache:///path/to/cachefile?cache-src-regex=...?cache-dsc-regex=...

where the source and description regex components are both optional. See the dataurisrc element for more information.

Reviewed: a922d6dd59d0b58442c0bf7bc4cc4d740b8c6a43 2014-08-12 K. Cannon, J. Creighton, B. Sathyaprakash.

Functions

Types and Values

GSTLAL_CACHESRC_TYPE

#define             GSTLAL_CACHESRC_TYPE


struct GstLALCacheSrc

struct GstLALCacheSrc;

struct GstLALCacheSrcClass

struct GstLALCacheSrcClass {
	GstBaseSrcClass parent_class;
};

Members

GstBaseSrcClass parent_class;

the parent class

 

Property Details

The “cache-dsc-regex” property

  “cache-dsc-regex”          gchar *

Description regex for sieving cache (e.g. ".*RDS_C03.*").

Flags: Read / Write / Construct

Default value: NULL


The “cache-src-regex” property

  “cache-src-regex”          gchar *

Source/Observatory regex for sieving cache (e.g. "H.*").

Flags: Read / Write / Construct

Default value: NULL


The “location” property

  “location”                 gchar *

Path to LAL cache file.

Flags: Read / Write / Construct

Default value: NULL


The “use-mmap” property

  “use-mmap”                 gboolean

Use mmap() instead of read().

Flags: Read / Write / Construct

Default value: FALSE