Skip to content

Commit 0aed2ff

Browse files
Update documentation
1 parent b9c6770 commit 0aed2ff

3 files changed

Lines changed: 22 additions & 29 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ sparc, jerk = smoothness(window)
3939
4040
## Documentation
4141

42-
Comprehensive documentation for `PyEyesWeb` is available online and includes tutorials, API references, and the theoretical and scientific background of the implemented metrics:
42+
Documentation for `PyEyesWeb` is available online and includes tutorials, API references, and the theoretical and scientific background of the implemented metrics:
4343

4444
- [Getting Started](https://infomuscp.github.io/PyEyesWeb/getting_started): step-by-step guide to installation and basic usage.
4545
- [API Reference](https://infomuscp.github.io/PyEyesWeb/api_reference): technical descriptions of modules, classes, and functions.

docs/user_guide/theoretical_framework/low_level/contraction_expansion.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ def analyze_3d_movement_volume(trajectory_data):
172172
```
173173

174174
### Integration with Other Modules
175-
Consider combining with **other metrics** for a more comprehensive analysis.
175+
Consider combining with **other metrics** for a more detailed analysis.
176176

177177
#### Smoothness Analysis
178178
Combine spatial dynamics with movement smoothness:

examples/README.md

Lines changed: 20 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,45 @@
11
# PyEyesWeb Examples
22

3-
This directory contains example scripts and demonstrations showcasing the capabilities of PyEyesWeb modules.
3+
This directory contains example scripts demonstrating the capabilities of PyEyesWeb analysis features.
44

5-
## Structure
5+
## Available Examples
66

7-
- **`test_scripts/`** - Python scripts demonstrating various analysis modules
8-
- **`touchdesigner/`** - TouchDesigner integration examples and demos
7+
### Movement Analysis
98

10-
## Test Scripts
11-
12-
### Movement Analysis Examples
13-
14-
- **`bilateral_symmetry.py`** - Demonstrates bilateral symmetry analysis with realistic human gait simulation
15-
- **`contraction_expansion.py`** - Shows contraction and expansion analysis for movement data
16-
- **`equilibrium.py`** - Demonstrates equilibrium analysis with elliptical balance evaluation
17-
- **`smoothness.py`** - Examples of smoothness analysis for movement trajectories
18-
- **`synchronization.py`** - Synchronization analysis using webcam and MediaPipe pose detection
9+
- **`smoothness.py`** - Movement smoothness analysis using SPARC and jerk metrics
10+
- **`bilateral_symmetry.py`** - Left-right symmetry analysis for bilateral movements
11+
- **`equilibrium.py`** - Balance and postural stability evaluation
12+
- **`synchronization.py`** - Multi-signal synchronization and phase locking analysis
13+
- **`contraction_expansion.py`** - Body area expansion and contraction tracking
1914

2015
### Data Processing
2116

2217
- **`tsv_reader.py`** - Example of reading and processing TSV (Tab-Separated Values) files
2318

24-
## TouchDesigner Integration
25-
26-
The `touchdesigner/` folder contains:
27-
- TouchDesigner project files (`.toe`)
28-
- Setup scripts for Windows environment
29-
3019
## Running the Examples
3120

32-
Each Python script can be run independently:
21+
Each script can be run independently from the project root:
3322

3423
```bash
35-
python examples/test_scripts/bilateral_symmetry.py
36-
python examples/test_scripts/synchronization.py
24+
python examples/smoothness.py
25+
python examples/bilateral_symmetry.py
26+
python examples/synchronization.py
3727
# etc...
3828
```
3929

4030
## Requirements
4131

4232
- Python 3.x
4333
- PyEyesWeb package installed
44-
- Additional dependencies as specified in each script (e.g., OpenCV, MediaPipe for synchronization example)
34+
- Additional dependencies as specified in each script:
35+
- OpenCV and MediaPipe for webcam examples (`smoothness.py`, `synchronization.py`)
36+
- Matplotlib for visualization (`equilibrium.py`)
4537

4638
## Notes
4739

48-
These examples are designed to demonstrate the functionality of various PyEyesWeb modules. They include:
49-
- Realistic data simulation
40+
These examples demonstrate PyEyesWeb functionality using:
41+
- Real-time webcam processing (where applicable)
42+
- Simulated movement data
5043
- Interactive visualizations
51-
- Real-time processing capabilities
52-
- Integration with external tools
44+
45+
For automated testing with synthetic signals, see `tests/feature_test_cli.py`.

0 commit comments

Comments
 (0)