ZaksPhysicsLibrary 1.7.0__tar.gz → 1.8.0__tar.gz

{zaksphysicslibrary-1.7.0 → zaksphysicslibrary-1.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ZaksPhysicsLibrary
-Version: 1.7.0
+Version: 1.8.0
 Summary: Data processing and analysis library for TDT, Oxysoft NIRS, Terranova EFNMR lab data, and text-field studies
 Author: zakgm2
 License-Expression: MIT
@@ -173,7 +173,7 @@ Everything importable from `PhysicsLibrary` directly:
 |----------|-------|
 | Format detection | `detect_format`, `detect_format_file`, `DataFormat`, `Dataset` |
 | Loading | `load_dataset`, `load_dataset_file`, `load_any_file`, `load_pt2` |
-| TDT processing | `process_tdt_folder`, `validate_tdt_folder`, `get_tdt_struct`, `get_plot_data`, `correct_bleaching`, `denoise_signal`, `get_event_markers` |
+| TDT processing | `process_tdt_folder`, `validate_tdt_folder`, `get_tdt_struct`, `get_plot_data`, `correct_bleaching`, `denoise_signal`, `get_event_markers`, `debounce_events` |
 | Analysis | `get_zscore_slice`, `smooth_signal`, `bin_for_heatmap`, `compute_fft_slice`, `annotate_fft_peaks`, `compute_slope_segment`, `fit_model_to_segment` |
 | Curve fit models | `linear_model`, `single_exponential_model`, `exponential_rise_model`, `double_exponential_model`, `gaussian_model`, `sinusoidal_model`, `visibility_model` |
 | Text field study | `run_field_study_pipeline`, `load_field_study_folder`, `peek_fields`, `flag_low_quality`, `embed_text_fields`, `compute_delta_vector`, `compute_paired_similarity`, `permutation_test_similarity`, `wordcount_confound_check` |

{zaksphysicslibrary-1.7.0 → zaksphysicslibrary-1.8.0}/PhysicsLibrary/__init__.py

@@ -35,6 +35,7 @@ from .processing_TDT import (
     correct_bleaching,
     denoise_signal,
     get_event_markers,
+    debounce_events,
 )
 
 from .analysis import (

{zaksphysicslibrary-1.7.0 → zaksphysicslibrary-1.8.0}/PhysicsLibrary/processing_TDT.py

@@ -375,6 +375,42 @@ def get_event_markers(data):
     return markers
 
 
+def debounce_events(times, min_isi):
+    """
+    Collapse switch-bounce / double-tap duplicates out of a list of event
+    timestamps (e.g. lever-press onsets), independent of any fixed-ratio
+    schedule (FR1, FR3, ...).
+
+    A real lever contact and a bounce/duplicate reading of the same
+    physical press land within milliseconds of each other — far closer
+    than an animal can genuinely press again. Sorting the timestamps and
+    dropping anything within `min_isi` seconds of the last *kept* event
+    removes those duplicates while leaving genuinely fast consecutive
+    presses (e.g. during an FR3 burst) intact, as long as `min_isi` is
+    below the animal's real max press rate.
+
+    Parameters
+    ----------
+    times : sequence of float
+        Raw event timestamps, in seconds. Need not be sorted.
+    min_isi : float
+        Minimum inter-event interval, in seconds. Any event whose gap from
+        the previous kept event is smaller than this is dropped. The
+        first press of a bounce cluster is always the one kept.
+
+    Returns
+    -------
+    list of float
+        Sorted timestamps with sub-`min_isi` duplicates removed.
+    """
+    sorted_times = sorted(float(t) for t in times)
+    kept = []
+    for t in sorted_times:
+        if not kept or (t - kept[-1]) >= min_isi:
+            kept.append(t)
+    return kept
+
+
 def denoise_signal(signal, fs, cutoff=5, order=2):
     """
     Low-pass Butterworth filter for ΔF/F signals.

{zaksphysicslibrary-1.7.0 → zaksphysicslibrary-1.8.0}/README.md

@@ -145,7 +145,7 @@ Everything importable from `PhysicsLibrary` directly:
 |----------|-------|
 | Format detection | `detect_format`, `detect_format_file`, `DataFormat`, `Dataset` |
 | Loading | `load_dataset`, `load_dataset_file`, `load_any_file`, `load_pt2` |
-| TDT processing | `process_tdt_folder`, `validate_tdt_folder`, `get_tdt_struct`, `get_plot_data`, `correct_bleaching`, `denoise_signal`, `get_event_markers` |
+| TDT processing | `process_tdt_folder`, `validate_tdt_folder`, `get_tdt_struct`, `get_plot_data`, `correct_bleaching`, `denoise_signal`, `get_event_markers`, `debounce_events` |
 | Analysis | `get_zscore_slice`, `smooth_signal`, `bin_for_heatmap`, `compute_fft_slice`, `annotate_fft_peaks`, `compute_slope_segment`, `fit_model_to_segment` |
 | Curve fit models | `linear_model`, `single_exponential_model`, `exponential_rise_model`, `double_exponential_model`, `gaussian_model`, `sinusoidal_model`, `visibility_model` |
 | Text field study | `run_field_study_pipeline`, `load_field_study_folder`, `peek_fields`, `flag_low_quality`, `embed_text_fields`, `compute_delta_vector`, `compute_paired_similarity`, `permutation_test_similarity`, `wordcount_confound_check` |

{zaksphysicslibrary-1.7.0 → zaksphysicslibrary-1.8.0}/ZaksPhysicsLibrary.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ZaksPhysicsLibrary
-Version: 1.7.0
+Version: 1.8.0
 Summary: Data processing and analysis library for TDT, Oxysoft NIRS, Terranova EFNMR lab data, and text-field studies
 Author: zakgm2
 License-Expression: MIT
@@ -173,7 +173,7 @@ Everything importable from `PhysicsLibrary` directly:
 |----------|-------|
 | Format detection | `detect_format`, `detect_format_file`, `DataFormat`, `Dataset` |
 | Loading | `load_dataset`, `load_dataset_file`, `load_any_file`, `load_pt2` |
-| TDT processing | `process_tdt_folder`, `validate_tdt_folder`, `get_tdt_struct`, `get_plot_data`, `correct_bleaching`, `denoise_signal`, `get_event_markers` |
+| TDT processing | `process_tdt_folder`, `validate_tdt_folder`, `get_tdt_struct`, `get_plot_data`, `correct_bleaching`, `denoise_signal`, `get_event_markers`, `debounce_events` |
 | Analysis | `get_zscore_slice`, `smooth_signal`, `bin_for_heatmap`, `compute_fft_slice`, `annotate_fft_peaks`, `compute_slope_segment`, `fit_model_to_segment` |
 | Curve fit models | `linear_model`, `single_exponential_model`, `exponential_rise_model`, `double_exponential_model`, `gaussian_model`, `sinusoidal_model`, `visibility_model` |
 | Text field study | `run_field_study_pipeline`, `load_field_study_folder`, `peek_fields`, `flag_low_quality`, `embed_text_fields`, `compute_delta_vector`, `compute_paired_similarity`, `permutation_test_similarity`, `wordcount_confound_check` |

{zaksphysicslibrary-1.7.0 → zaksphysicslibrary-1.8.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ZaksPhysicsLibrary"
-version = "1.7.0"
+version = "1.8.0"
 description = "Data processing and analysis library for TDT, Oxysoft NIRS, Terranova EFNMR lab data, and text-field studies"
 requires-python = ">=3.10"
 readme = "README.md"