QPlane#

class gwpy.signal.qtransform.QPlane( q: float, frange: tuple[float, float], duration: float, sampling: float, mismatch: float = 0.2, )[source]#

Bases: QBase

Iterable representation of a Q-transform plane.

For a given Q, an array of frequencies can be iterated over, yielding a QTile each time.

Parameters:

qfloat: The Q-value for this plane.
frangetuple of float: (low, high) range of frequencies for this plane.
durationfloat: The duration of the data to be Q-transformed.
samplingfloat: Sampling rate (in Hertz) of data to be Q-transformed.
mismatchfloat: Maximum fractional mismatch between neighbouring tiles.

Attributes Summary

`farray`	Array of frequencies for the lower-edge of each frequency bin.
`frequencies`	Array of central frequencies for this `QPlane`.
`whitening_duration`	The recommended data duration required for whitening.

Methods Summary

transform(fseries, *[, norm, epoch, search])

Calculate the energy QGram for the given fseries.

Attributes Documentation

farray[source]#: Array of frequencies for the lower-edge of each frequency bin.

whitening_duration[source]#: The recommended data duration required for whitening.

Methods Documentation

transform( fseries: FrequencySeries, *, norm: bool | str = True, epoch: float | LIGOTimeGPS | None = None, search: Segment | None = None, ) → QGram[source]#

Calculate the energy QGram for the given fseries.

Parameters:

fseriesFrequencySeries: The complex FFT of a time-series data set.
normbool, str: Normalize the energy of the output by the median (if True or 'median') or the 'mean', if False the output is the complex ifft output of the Q-tranform.
epochLIGOTimeGPS, float: The epoch of these data, only used for metadata in the output TimeSeries, and not requires if the input fseries has the epoch populated.
searchSegment: Search window of interest to determine the loudest Q-plane.

Returns:

resultsQGram: The complex energies of the Q-transform of the input fseries at each frequency.