range_timeseries

gwpy.astro.range_timeseries(

hoft: TimeSeries | Spectrogram,

stride: float | None = None,

fftlength: float | None = None,

overlap: float | None = None,

window: str | numpy.ndarray = 'hann',

method: str = 'median',

nproc: int = 1,

range_func: Callable | None = None,

**rangekwargs,

) → TimeSeries

Estimate timeseries of astrophysical range (Mpc).

Parameters:

hoftTimeSeries, Spectrogram

Detector (strain) data from which to estimate range.

stridefloat, optional

Desired step size (seconds) of range timeseries, 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

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() or inspiral_range() (see “Notes” below), defaults to inspiral range with mass1 = mass2 = 1.4 solar masses

Returns:

outTimeSeries

timeseries trends of astrophysical range

See also

gwpy.timeseries.TimeSeries.spectrogram

for the underlying power spectral density estimator

inspiral_range

for the function that computes inspiral range

burst_range

for the function that computes burst range

range_spectrogram

for a Spectrogram of the range integrand

Notes

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