range_spectrogram

gwpy.astro.range_spectrogram(hoft, stride=None, fftlength=None, overlap=None, window='hann', method='median', nproc=1, range_func=None, **rangekwargs) → Spectrogram

Calculate the average range or range power spectrogram (Mpc or Mpc^2 / Hz) directly from strain.

Parameters:

hoftTimeSeries or Spectrogram

record of gravitational-wave strain output from a detector

stridefloat, optional

number of seconds in a single PSD (i.e., step size of spectrogram), required if hoft is an instance of TimeSeries

fftlengthfloat, optional

number of seconds in a single FFT

overlapfloat, optional

number of seconds of overlap between FFTs, defaults to the recommended overlap for the given window (if given), or 0

windowstr, numpy.ndarray, optional

window function to apply to timeseries prior to FFT, see scipy.signal.get_window() for details on acceptable formats

methodstr, optional

FFT-averaging method, defaults to median averaging, see spectrogram() for more details

nprocint, optional

number of CPUs to use in parallel processing of FFTs, default: 1

fminfloat, optional

low frequency cut-off (Hz), defaults to 1/fftlength

fmaxfloat, optional

high frequency cut-off (Hz), defaults to Nyquist frequency of hoft

range_funccallable, optional

the function to call to generate the range for each stride, defaults to inspiral_range unless energy is given as a keyword argument to the range function

**rangekwargsdict, optional

additional keyword arguments to burst_range_spectrum() or inspiral_range_psd() (see “Notes” below), defaults to inspiral range with mass1 = mass2 = 1.4 solar masses

Returns:

outSpectrogram

time-frequency spectrogram of astrophysical range

See also

gwpy.timeseries.TimeSeries.spectrogram

for the underlying power spectral density estimator

inspiral_range_psd

for the function that computes inspiral range integrand

burst_range_spectrum

for the function that computes burst range integrand

range_timeseries

for TimeSeries trends of the astrophysical range

Notes

This method is designed to show the contribution to a gravitational-wave detector’s sensitive range across frequency bins as a function of time. It supports the range to compact binary inspirals and to unmodelled GW bursts, each a class of transient event.

If inspiral range is requested and fmax exceeds the frequency of the innermost stable circular orbit (ISCO), the output will extend only up to the latter.