GSTLALWhiten

GSTLALWhiten

Synopsis

#define             GSTLAL_PSDMODE_TYPE
#define             GSTLAL_WHITEN_TYPE
struct              GSTLALWhiten;
struct              GSTLALWhitenClass;

Object Hierarchy

  GObject
   +----GstObject
         +----GstElement
               +----GstBaseTransform
                     +----GSTLALWhiten

Properties

  "average-samples"          guint                 : Read / Write / Construct
  "delta-f"                  gdouble               : Read
  "expand-gaps"              gboolean              : Read / Write / Construct
  "f-nyquist"                gdouble               : Read
  "fft-length"               gdouble               : Read / Write / Construct
  "mean-psd"                 GValueArray*          : Read / Write
  "median-samples"           guint                 : Read / Write / Construct
  "n-samples"                guint                 : Read
  "psd-mode"                 GSTLAL_PSDMODE        : Read / Write / Construct
  "sigma-squared"            gdouble               : Read
  "spectral-correlation"     GValueArray*          : Read
  "zero-pad"                 gdouble               : Read / Write / Construct

Description

Details

GSTLAL_PSDMODE_TYPE

#define             GSTLAL_PSDMODE_TYPE


GSTLAL_WHITEN_TYPE

#define             GSTLAL_WHITEN_TYPE


struct GSTLALWhiten

struct GSTLALWhiten;

struct GSTLALWhitenClass

struct GSTLALWhitenClass {
	GstBaseTransformClass parent_class;
};

Property Details

The "average-samples" property

  "average-samples"          guint                 : Read / Write / Construct

Number of FFTs to be used in PSD average.

Allowed values: >= 1

Default value: 32


The "delta-f" property

  "delta-f"                  gdouble               : Read

PSD frequency resolution in Hz.

Allowed values: >= 0

Default value: 0


The "expand-gaps" property

  "expand-gaps"              gboolean              : Read / Write / Construct

expand gaps to fill entire fft length.

Default value: FALSE


The "f-nyquist" property

  "f-nyquist"                gdouble               : Read

Nyquist frequency in Hz.

Allowed values: >= 0

Default value: 0


The "fft-length" property

  "fft-length"               gdouble               : Read / Write / Construct

Total length of the FFT convolution (including zero padding) in seconds.

Allowed values: >= 0

Default value: 8


The "mean-psd" property

  "mean-psd"                 GValueArray*          : Read / Write

Mean power spectral density being used to whiten the data. First bin is at 0 Hz, last bin is at f-nyquist, bin spacing is delta-f.


The "median-samples" property

  "median-samples"           guint                 : Read / Write / Construct

Number of FFTs to be used in PSD median history.

Allowed values: >= 1

Default value: 9


The "n-samples" property

  "n-samples"                guint                 : Read

Number of FFTs used for PSD average. Stops increasing after the number of FFTs equals average-samples.

Default value: 0


The "psd-mode" property

  "psd-mode"                 GSTLAL_PSDMODE        : Read / Write / Construct

PSD estimation mode.

Default value: GSTLAL_PSDMODE_RUNNING_AVERAGE


The "sigma-squared" property

  "sigma-squared"            gdouble               : Read

FFT window mean square.

Allowed values: >= 0

Default value: 0


The "spectral-correlation" property

  "spectral-correlation"     GValueArray*          : Read

Two-point spectral correlation function for output stream. Bin index is |k - k'|.


The "zero-pad" property

  "zero-pad"                 gdouble               : Read / Write / Construct

Length of the zero-padding to include on both sides of the FFT in seconds.

Allowed values: >= 0

Default value: 2