GSTLALFIRBank

GSTLALFIRBank

Synopsis

#define             GSTLAL_FIRBANK_TYPE
struct              GSTLALFIRBank;
struct              GSTLALFIRBankClass;

Object Hierarchy

  GObject
   +----GstObject
         +----GstElement
               +----GstBaseTransform
                     +----GSTLALFIRBank

Properties

  "block-stride"             gint                  : Read / Write / Construct
  "fir-matrix"               GValueArray*          : Read / Write
  "latency"                  gint64                : Read / Write / Construct
  "time-domain"              gboolean              : Read / Write / Construct

Signals

  "rate-changed"                                   : Run First

Description

Details

GSTLAL_FIRBANK_TYPE

#define             GSTLAL_FIRBANK_TYPE


struct GSTLALFIRBank

struct GSTLALFIRBank;

struct GSTLALFIRBankClass

struct GSTLALFIRBankClass {
	GstBaseTransformClass parent_class;

	void (*rate_changed)(GSTLALFIRBank *, gint, void *);
};

Property Details

The "block-stride" property

  "block-stride"             gint                  : Read / Write / Construct

When using FFT convolutions, this many samples will be produced from each block. Smaller values decrease latency but increase computational cost. If very small values are desired, consider using time-domain convolution mode instead.

Allowed values: >= 1

Default value: 1


The "fir-matrix" property

  "fir-matrix"               GValueArray*          : Read / Write

Array of impulse response vectors. Number of vectors (rows) in matrix sets number of output channels. All filters must have the same length.


The "latency" property

  "latency"                  gint64                : Read / Write / Construct

Filter latency in samples.

Default value: 0


The "time-domain" property

  "time-domain"              gboolean              : Read / Write / Construct

Set to true to use time-domain (a.k.a. direct) convolution, set to false to use FFT-based convolution. For long filters FFT-based convolution is usually significantly faster than time-domain convolution but incurs a higher processing latency and requires more RAM.

Default value: FALSE

Signal Details

The "rate-changed" signal

void                user_function                      (GSTLALFIRBank *gstlalfirbank,
                                                        gint           arg1,
                                                        gpointer       user_data)          : Run First

gstlalfirbank :

the object which received the signal.

user_data :

user data set when the signal handler was connected.