Development documentation · 0.2.3 30c2f8ba · Intro examples tested with 0.2.3 · Version details · Known limitations

Case study conditions

Audience

Scientific Python User

Level

Intermediate

Dependencies

GWexpy base dependencies

Data

Synthetic data generated by the code below

Execution

Passed · 3.6 s · GWexpy 0.2.3 (Measured in the build environment; cached builds retain the original runtime. Optional section skips are reported in the output.)

Validation

Illustrative example. Successful execution does not establish an independent review of the physical model.

Case Study: Event-Synchronized Analysis

This tutorial shows a real-world workflow: matching events from two different logs, applying clock corrections, and generating event-by-event summary plots.

The event windows are still represented by gwpy.segments.Segment, while gwexpy provides the table-management and apply()-driven batch workflow through SegmentTable. The division between GWpy base classes and gwexpy extensions is the same as in SegmentTable: Basics.

import warnings


import warnings

with warnings.catch_warnings():

    import pandas as pd
    from gwpy.segments import Segment

    from gwexpy.table import SegmentTable

    # 1. Simulate finding events
    events_df = pd.DataFrame({
    "gps": [1234567890.1, 1234567895.5, 1234567900.2],
    "snr": [15, 8, 22]
    })

    # 2. Create SegmentTable from events
    # Define a 4-second window around each GPS time
    segs = [Segment(t-2, t+2) for t in events_df["gps"]]
    st = SegmentTable.from_segments(segs, snr=events_df["snr"])
    st

/home/runner/micromamba/envs/gwexpy/lib/python3.11/site-packages/gwpy/time/_ligotimegps.py:42: UserWarning: Wswiglal-redir-stdio:

SWIGLAL standard output/error redirection is enabled in IPython.
This may lead to performance penalties. To disable locally, use:

with lal.no_swig_redirect_standard_output_error():
    ...

To disable globally, use:

lal.swig_redirect_standard_output_error(False)

Note however that this will likely lead to error messages from
LAL functions being either misdirected or lost when called from
Jupyter notebooks.

To suppress this warning, use:

import warnings
warnings.filterwarnings("ignore", "Wswiglal-redir-stdio")
import lal

  from lal import LIGOTimeGPS

Batch Plot Generation

We can use apply() to generate plots for each event and save them, storing the paths back in the table.

import os

os.makedirs("outputs", exist_ok=True)

def generate_event_plot(row):
    # Simulate plotting
    path = f"outputs/event_{row.index}.png"
    # plot = row["raw"].plot() -> plot.save(path)
    with open(path, "w") as f: f.write("Dummy PNG")
    return {"plot_path": path}

st_plots = st.apply(generate_event_plot)
st_plots.display()

	span	snr	plot_path
0	(1234567888.1, 1234567892.1)	15	outputs/event_0.png
1	(1234567893.5, 1234567897.5)	8	outputs/event_1.png
2	(1234567898.2, 1234567902.2)	22	outputs/event_2.png

Result Summary

Finally, we can filter the table and export results.

st_best = st_plots.select(mask=st_plots.to_pandas()["snr"] > 10)
st_best.to_pandas()

	span	snr	plot_path
0	(1234567888.1, 1234567892.1)	15	outputs/event_0.png
1	(1234567898.2, 1234567902.2)	22	outputs/event_2.png