Loading [MathJax]/extensions/TeX/AMSsymbols.js
LALSimulation 6.2.0.1-da3b9d3
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
lalsim-sgwb

Simulates a stochastic gravitational wave background.

Synopsis

lalsim-sgwb [options]

Description

The lalsim-sgwb utility produces a continuous stream of simulated detector stochastic gravitational wave background noise for a specified interval of time, for the specified detectors, and for a specified flat spectral energy density. The output is written to the standard output in multi-column ascii format data in which the first column contains the GPS times of each sample and the remaining columns contain the (correlated) noise strain values in the various detectors.

Options

-h, --help
print a help message and exit
-G, --geo
include GEO
-H, --hanford
include LHO
-L, --livingston
include LLO
-V, --virgo
include Virgo
-s, --start-time GPSSTART
GPS start time (s)
-t, --duration DURATION
(required) duration of data to produce (s)
-r, --sample-rate SRATE
sample rate (Hz) [16384]
-W, --Omega0 OMEGA0
(required) flat spectral energy density
-f, --low-frequency FLOW
low frequency cutoff (Hz) (default = 10 Hz)
-a, --alpha
sgwb spectrum power law power
-F, --reference-frequency FREF
reference frequency (Hz) for a powerlaw spectrum
-p, --path-to-file
path to a file including data for Omega (overrides other options)

Environment

The LAL_DEBUG_LEVEL can used to control the error and warning reporting of lalsim-sgwb. Common values are: LAL_DEBUG_LEVEL=0 which suppresses error messages, LAL_DEBUG_LEVEL=1 which prints error messages alone, LAL_DEBUG_LEVEL=3 which prints both error messages and warning messages, and LAL_DEBUG_LEVEL=7 which additionally prints informational messages.

The GSL_RNG_SEED and GSL_RNG_TYPE environment variables can be used to set the random number generator seed and type respectively.

Exit Status

The lalsim-sgwb utility exits 0 on success, and >0 if an error occurs.

Example

The command:

lalsim-sgwb -H -L -V -W 1e-6 -s 1000000000 -t 1000

will stream 1000 seconds of stochastic gravitational-wave background strain noise in the LHO, LLO, and Virgo detectors having \( {\Omega_0=10^{-6}} \) .