Skip to content

Commit da9b253

Browse files
Add SPARC reference documentation and remove redundant validator comments
1 parent efbca98 commit da9b253

1 file changed

Lines changed: 12 additions & 3 deletions

File tree

pyeyesweb/mid_level/smoothness.py

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,12 @@ class Smoothness:
2626
and Jerk RMS metrics. It can optionally apply Savitzky-Golay filtering
2727
to reduce noise before analysis.
2828
29+
SPARC implementation is based on Balasubramanian et al. (2015) "On the analysis
30+
of movement smoothness" from Journal of NeuroEngineering and Rehabilitation.
31+
SPARC values are typically negative, with values closer to 0 indicating less
32+
smooth movements. Healthy reaching movements typically yield SPARC values around
33+
-1.4 to -1.6, while pathological movements may range from -3 to -10 or lower.
34+
2935
Read more in the [User Guide](/PyEyesWeb/user_guide/theoretical_framework/low_level/smoothness/)
3036
3137
Parameters
@@ -62,13 +68,16 @@ class Smoothness:
6268
1. SPARC: More negative values indicate smoother movement
6369
2. Jerk RMS: Lower values indicate smoother movement
6470
3. Requires at least 5 samples for meaningful analysis
71+
72+
References
73+
----------
74+
Balasubramanian, S., Melendez-Calderon, A., Roby-Brami, A., & Burdet, E. (2015).
75+
On the analysis of movement smoothness. Journal of NeuroEngineering and Rehabilitation,
76+
12(1), 1-11.
6577
"""
6678

6779
def __init__(self, rate_hz=50.0, use_filter=True):
68-
# Validate rate_hz using centralized validator
6980
self.rate_hz = validate_numeric(rate_hz, 'rate_hz', min_val=0.01, max_val=100000)
70-
71-
# Validate use_filter using centralized validator
7281
self.use_filter = validate_boolean(use_filter, 'use_filter')
7382

7483
def _filter_signal(self, signal):

0 commit comments

Comments
 (0)