aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSam Scholten2025-10-24 16:36:57 +1000
committerSam Scholten2025-10-24 16:36:57 +1000
commitec29d6eda97ce1e9d4121c6c19f91d12ec25947c (patch)
tree4e04d0564b4054a8d7f7e856b504669605ad00e8 /README.md
parent030523c8e06f925211247d2c89a6c250780b4738 (diff)
downloadtransivent-ec29d6eda97ce1e9d4121c6c19f91d12ec25947c.tar.gz
transivent-ec29d6eda97ce1e9d4121c6c19f91d12ec25947c.zip
Update documentation for v2.1.0 resampling feature
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2b52ac5..424b7ee 100644
--- a/README.md
+++ b/README.md
@@ -43,8 +43,12 @@ results = detect_from_wfm(
name="data.Wfm.bin",
sampling_interval=5e-7, # seconds
data_path="/path/to/data/",
+ target_sampling_interval=5e-6, # Optional: downsample to 200 kHz
detection_snr=3.0,
)
+```
+
+**New in v2.1.0**: Use `target_sampling_interval` to downsample oversampled data before detection. This improves SNR and processing speed for high-frequency data.
events = results["events"]
print(f"Found {len(events)} events")