q_scan

gwpy.signal.qtransform.q_scan(

data: TimeSeries,

mismatch: float = 0.2,

qrange: tuple[float, float] = (4, 64),

frange: tuple[float, float] = (0, inf),

duration: float | None = None,

sampling: float | None = None,

**kwargs,

) → tuple[QGram, float]

Transform data by scanning over a QTiling.

This utility is provided mainly to allow direct manipulation of the QTiling.transform output. Most users probably just want to use q_transform(), which wraps around this.

Parameters:

dataTimeSeries or ndarray

The time- or frequency-domain input data.

mismatchfloat

Maximum allowed fractional mismatch between neighbouring tiles.

qrangetuple of float

(low, high) range of Qs to scan.

frangetuple of float

(low, high) range of frequencies to scan.

durationfloat

Duration (seconds) of input, required if data is not a TimeSeries.

samplingfloat

Sample rate (Hertz) of input, required if data is not a TimeSeries.

kwargs

Other keyword arguments to be passed to QTiling.transform(), including 'epoch' and 'search'

Returns:

qgramQGram

The raw output of QTiling.transform().

farfloat

Expected false alarm rate (Hertz) of white Gaussian noise with the same peak energy and total duration as qgram.