Package pylal :: Module rangeutils
[hide private]
[frames] | no frames]

Module rangeutils

source code

This module provides a bunch of user-friendly wrappers to the SWIG-bound REAL8TimeSeries and REAL8FrequencySeries objects and their associated functions.


Version: 8cbd1b7187ce3ed9a825d6ed11cc432f3cfde9a5

Date: 2017-12-05 15:29:36 +0000

Author: Duncan M. Macleod <duncan.macleod@ligo.org>

Functions [hide private]
float
inspiralrange(f, S, snr=8, m1=1.4, m2=1.4, fmin=10, fmax=None, horizon=False)
Calculate the sensitivity distance to an inspiral with the given masses, for the given signal-to-noise ratio.
source code
float
squeezing(f, S, dc=None, opgain=None, cavpf=None, fmin=1000, fmax=2000)
Calculate squeezing factor based on observed noise in given band and predicted shot noise
source code
float
fdependent_burstrange(f, S, snr=8, E=1e-2)
Calculate the sensitive distance to a GW burst with the given intrinsic energy for the given signal-to-noise ratio snr, as a function of f.
source code
float
burstrange(f, S, snr=8, E=1e-2, fmin=0, fmax=None, unit="Mpc")
Calculate the sensitive distance to a GW burst with the given intrinsic energy for the given signal-to-noise ratio snr, integrated over frequency.
source code
Function Details [hide private]

inspiralrange(f, S, snr=8, m1=1.4, m2=1.4, fmin=10, fmax=None, horizon=False)

source code 

Calculate the sensitivity distance to an inspiral with the given masses, for the given signal-to-noise ratio. See the following reference for information on the integral performed:

https://dcc.ligo.org/cgi-bin/private/DocDB/ShowDocument?docid=27267

Parameters:
  • f (numpy.array) - frequency array
  • S (numpy.array) - power spectral density array
  • snr (float) - signal-to-noise ratio at which to calculate range
  • m1 (float) - mass (in solar masses) of first binary component, default: 1.4
  • m2 (float) - mass (in solar masses) of second binary component, default: 1.4
  • fmin (float) - minimum frequency limit of integral, default: 10 Hz
  • fmax (float) - maximum frequency limit of integral, default: ISCO
  • horizon (bool) - return horizon distance in stead of angle-averaged, default: False
Returns: float
sensitive distance to an inspiral (in solar masses) for the given PSD and parameters

squeezing(f, S, dc=None, opgain=None, cavpf=None, fmin=1000, fmax=2000)

source code 

Calculate squeezing factor based on observed noise in given band and predicted shot noise

Parameters:
  • f (numpy.array) - frequency array
  • S (numpy.array) - power spectral density array
  • dc (float)
  • opgain (float)
  • cavpf (float)
  • fmin (float) - minimum frequency limit of integral, default: 1000 Hz
  • fmax (float) - maximum frequency limit of integral, default: 2000 Hz
Returns: float
squeezing ratio in dB

fdependent_burstrange(f, S, snr=8, E=1e-2)

source code 

Calculate the sensitive distance to a GW burst with the given intrinsic energy for the given signal-to-noise ratio snr, as a function of f.

Parameters:
  • f (float or numpy.array) - frequency of interest
  • S (numpy.array) - power spectral density
  • snr (float) - signal-to-noise ratio of burst
  • E (float) - instrinsic energy of burst, default: grb-like 0.01
Returns: float
sensitive distance in pc at which a GW burst with the given energy would be detected with the given SNR, as a function of it's frequency

burstrange(f, S, snr=8, E=1e-2, fmin=0, fmax=None, unit="Mpc")

source code 

Calculate the sensitive distance to a GW burst with the given intrinsic energy for the given signal-to-noise ratio snr, integrated over frequency.

Parameters:
  • f (float or numpy.array) - frequency of interest
  • S (numpy.array) - power spectral density
  • snr (float) - signal-to-noise ratio of burst, default: 8
  • E (float) - instrinsic energy of burst, default: grb-like 0.01
  • fmin (float) - minimum frequency limit of integral, default: 10 Hz
  • fmax (float) - maximum frequency limit of integral, default: ISCO
Returns: float
sensitive distance at which a GW burst with the given energy would be detected with the given SNR, integrated over frequency.