Skip to content

Commit a007622

Browse files
authored
Update README.md
1 parent d6b0f1c commit a007622

File tree

1 file changed

+37
-4
lines changed

1 file changed

+37
-4
lines changed

README.md

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,44 @@
11
# SaccadeVR-mobile:
22

3-
A software package on Unity to use HTC VIVE Pro Eye, a head-mounted display with virtual reality technology, for assessment of saccadic eye movement.
3+
A software package of Unity to use HTC VIVE Pro Eye, a head-mounted display with virtual reality technology, for assessment of saccadic eye movement.
44

55

6-
## Installation:
6+
## System set-up
77

8-
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
8+
###### Software version
9+
The following software is used for the measurement system.
10+
- Unity: 2019.2.5f1
11+
- Steam VR: 1.11.11
12+
- SRanipal, a software development kit for eye tracking provided by HTC: 1.1.0.1
13+
- SR Runtim: 1.1.2.0
14+
15+
###### Set-up procedures
16+
1. Open the folder of **SaccadeVR_ViveProEye** on Unity.
17+
2. Go to Building Settings --> Player Settings --> Player --> XR Settings. Click *Virtual Reality Supported* to enable the VR configuration.
18+
3. Start playing for the measurement.
19+
20+
21+
## Files
22+
###### Saccade_measure_rev1.cs
23+
C# programming file to configure the measurement system. The file is found SaccadeVR_ViveProEye --> Assets --> Scripts.
24+
25+
###### DisableTracking.cs
26+
C# programming file to disable the tracking of head movement of the VR headset. If the tracking is active, the position of the stimuli targets for saccade measurement changes when the user moves the head.
27+
28+
###### StandardSaccade_IDnumber.txt
29+
Data of eye movement are recorded in this text file. The text file is created under the folder of **SaccadeVR_ViveProEye**
30+
The measured parameters include
31+
- Frame sequence
32+
- Timestamp (ms)
33+
- Gaze origin (mm)
34+
- Gaze direction (normalised to between -1 and 1)
35+
- Pupil position (normalised to between 0 and 1)
36+
- Pupil diameter (mm)
37+
- Eye openness (normalised to between 0 and 1)
38+
- Validity of eye data
39+
40+
###### Saccade_Start_Time_IDnumber.txt
41+
Unixtime of the computer is recorded in this text file when the saccade task starts in each saccade trial. With the recorded time, the latency (response time) of saccadic eye movement is calculated.
942

1043

1144
## Summary of programming algorithm:
@@ -14,7 +47,7 @@ The following diagram explains the programming algorithm to measure saccadic eye
1447

1548
<img src="Image/Saccade_VR_programme_algorithm.jpg" width="70%">
1649

17-
The sample design of VR is shown below.
50+
A sample VR design for the measurement of saccadic eye movement
1851

1952
<img src="Image/Saccade_VR_sample.gif" width="70%">
2053

0 commit comments

Comments
 (0)