bilby_pipe.plotting_utils

Plotting helper functions.

Functions

`safe_run`(func)	Try-catch gwpy_func_wrapper.
`strain_spectrogram_plot`(det, data, data_directory[, ...])	Save a timeseries and Q-transform spectrogram plot of the detector's data.
`strain_spectogram_plot`(det, data, data_directory[, ...])	Deprecated due to typo in name.
`_filter_strain_data`(data)	Apply general filtering and whitening techniques to clean strain data.
`plot_whitened_data`(interferometers, data_directory, label)	Save a plot of the whitened time and frequency domain strain data.

Module Contents

bilby_pipe.plotting_utils.safe_run(func)[source]: Try-catch gwpy_func_wrapper.

bilby_pipe.plotting_utils.strain_spectrogram_plot(det: str, data: gwpy.timeseries.TimeSeries, data_directory: str, label: str | None = 'spectrogram', extra_label: str | None = '', trigger_time: int | None = None, duration: int | None = None, post_trigger_duration: int | None = None)[source]

Save a timeseries and Q-transform spectrogram plot of the detector’s data.

Parameters:

det: str: The detector name corresponding to the key in data-dict
data: gwpy.TimeSeries: the timeseries strain data of a detector
trigger_time: None or int: The trigger time to where the plot is zoomed. If none, then will not zoom plot.
duration: None or int: The data duration to help zoom the plot to the trigger time If none, then will not zoom plot.
post_trigger_duration: None or int: The post_trigger_duration time to help zoom the plot to the trigger time. If none, then will not zoom plot.
data_directory: str: The data dir where the plot is stored.
label: str
extra_label: str: A string identifier added to the name of the file

Returns:

None
File by the name <outdir>/data/<Detector>_<Label>_<ExtraLabel>_data.png
is saved

bilby_pipe.plotting_utils.strain_spectogram_plot(det: str, data: gwpy.timeseries.TimeSeries, data_directory: str, label: str | None = 'spectrogram', extra_label: str | None = '', trigger_time: int | None = None, duration: int | None = None, post_trigger_duration: int | None = None)[source]: Deprecated due to typo in name.

bilby_pipe.plotting_utils._filter_strain_data(data)[source]

Apply general filtering and whitening techniques to clean strain data.

Methods adapted from https://gwpy.github.io/docs/stable/examples/signal/gw150914.html and https://gwpy.github.io/docs/stable/examples/spectrogram/spectrogram2/

Parameters:

data: gwpy.timeseries.TimeSeries: Strain data to be filtered

Returns:

filtered_data: gwpy.timeseries.TimeSeries: The whitened filtered strain data.

bilby_pipe.plotting_utils.plot_whitened_data(interferometers: bilby.gw.detector.InterferometerList, data_directory: str, label: str)[source]

Save a plot of the whitened time and frequency domain strain data.

Parameters:

interferometers: bilby.gw.detector.InterferometerList: Interferometers to make the plot for
data_directory: str: The data dir where the plot is stored.
label: str: A string identifier added to the name of the file

Returns:

None
File by the name <outdir>/data/<Detector>_<label>_whitened_data.png
is saved