gwdetchar.scattering.plot module

Plotting routines for scattering checks

gwdetchar.scattering.plot._format_spectrogram(ax, qspecgram, colormap='viridis')[source]

Helper tool to format a Spectrogram plot axis

gwdetchar.scattering.plot._format_timeseries(ax, gps, fringe, multipliers=(1, 2, 4, 8), linewidth=1, thresh=None)[source]

Helper tool to format a TimeSeries plot axis

gwdetchar.scattering.plot.spectral_comparison(gps, qspecgram, fringe, output, thresh=15, multipliers=(1, 2, 4, 8), colormap='viridis', figsize=[12, 8])[source]

Compare a high-resolution spectrogram with projected fringe frequencies

Parameters:
gpsfloat

reference GPS time (in seconds) to serve as the origin

qspecgramSpectrogram

an interpolated high-resolution spectrogram

fringeTimeSeries

projected fringe frequencies (in Hz)

outputstr

name of the output file

threshfloat, optional

frequency threshold (Hz) for scattering fringes, default: 15

multiplierstuple, optional

collection of fringe harmonic numbers to plot, can be given in any order, default: (1, 2, 4, 8)

colormapstr, optional

matplotlib colormap to use, default: viridis

figsizetuple, optional

size (width x height) of the final figure, default: (12, 8)

gwdetchar.scattering.plot.spectral_overlay(gps, qspecgram, fringe, output, multipliers=(1, 2, 4, 8), figsize=[12, 4])[source]

Overlay scattering fringe projections on top of a high-resolution spectrogram

Parameters:
gpsfloat

reference GPS time (in seconds) to serve as the origin

qspecgramSpectrogram

an interpolated high-resolution spectrogram

fringeTimeSeries

projected fringe frequencies (in Hz)

outputstr

name of the output file

multiplierstuple, optional

collection of fringe harmonic numbers to plot, can be given in any order, default: (1, 2, 4, 8)

figsizetuple, optional

size (width x height) of the final figure, default: (12, 4)