@@ -52,17 +52,29 @@ class Synchronization:
5252 ----------
5353 sensitivity : int, optional
5454 Size of the PLV history buffer. Larger values provide more temporal
55- context but increase memory usage. Must be positive (default: 100).
55+ context but increase memory usage. Must be positive integer between
56+ 1 and 10,000 (default: 100).
5657 output_phase : bool, optional
5758 If True, outputs phase synchronization status as "IN PHASE" or
58- "OUT OF PHASE" based on the phase_threshold (default: False).
59+ "OUT OF PHASE" based on the phase_threshold. Must be boolean
60+ (default: False).
5961 filter_params : tuple of (float, float, float) or None, optional
6062 Band-pass filter parameters as (lowcut_hz, highcut_hz, sampling_rate_hz).
61- If None, no filtering is applied. Example: (0.5, 30, 100) for 0.5-30 Hz
62- band with 100 Hz sampling (default: None).
63+ All frequencies must be positive with lowcut < highcut < sampling_rate/2.
64+ Example: (0.5, 30, 100) for 0.5-30 Hz band with 100 Hz sampling.
65+ If None, no filtering is applied (default: None).
6366 phase_threshold : float, optional
6467 PLV threshold for phase status determination. Values above this are
65- considered "IN PHASE". Must be between 0 and 1 (default: 0.7).
68+ considered "IN PHASE". Must be between 0 and 1 inclusive (default: 0.7).
69+
70+ Raises
71+ ------
72+ TypeError
73+ If sensitivity is not int, output_phase is not bool, phase_threshold
74+ is not numeric, or filter_params is not tuple/list.
75+ ValueError
76+ If sensitivity <= 0 or > 10,000, phase_threshold outside [0, 1],
77+ or filter_params contains invalid frequencies.
6678
6779 Attributes
6880 ----------
0 commit comments