pygwb.spectral.fftgram

pygwb.spectral.fftgram(time_series_data: TimeSeries, fftlength: int, overlap_factor: float = 0.5, zeropad: bool = False, window_fftgram_dict: dict = {'window_fftgram': 'hann'})[source]

Create a fftgram from a timeseries.

Parameters:

time_series_data (gwpy.timeseries.TimeSeries) – Timeseries from which to compute the fftgram.
fftlength (int) – Length of each segment (in seconds) for computing FFT.
overlap_factor (float, optional) – Factor of overlap between adjacent FFT segments (values range from 0 to 1). Users should provide proper combination of overlap_factor and window_fftgram_dict. For “hann” window use 0.5 overlap_factor and for “boxcar” window use 0 overlap_factor. Default 0.5 (50% overlap).
zeropad (bool, optional) – Before doing FFT whether to zero pad the data equal to the length of FFT or not. Default is False.
window_fftgram_dict (dictionary, optional) – Dictionary containing name and parameters describing which window to use for producing FFTs. Default is “hann”.

Returns:

data_fftgram: gwpy.spectrogram.Spectrogram: fftgram containing several FFTs in a matrix format. Note this is a complex quantity.