========================================================================

  Eye-Movement analysis with Switching Hidden Markov Models (SHMMs)
  emshmm-toolbox

  Antoni B. Chan, City University of Hong Kong
  Janet H. Hsiao, University of Hong Kong
  Tim Chuk, University of Hong Kong
  
  Copyright (c) 2019, City University of Hong Kong & University of Hong Kong

========================================================================

--- DESCRIPTION ---
This is a MATLAB toolbox for analyzing eye movement data with switching
hidden Markov Models (SHMMs). 


--- BRIEF INSTRUCTIONS ---
To test the SHMM code in MATLAB:
1) open MATLAB and navigate to this directory.
2) run "setup_shmm.m" to setup the paths.
3) run "demo_shmm.m" to see the demo for learning one SHMM.

To run the experiment in the BRM paper:
4) run "run_experiment.m" to learn SHMMs for each subject, and then 
   cluster them into 2 groups. The results images and mat file are stored
   in the "results_shmm" directory.
5) run "run_analysis.m" to make the gaze cascade plot, and other figures.
6) run "loo_run_experiment.m" to learn models for inferring subject 
   preference using SHMMs.
7) run "loo_run_analysis.m" to run the inference experiment using the
   previously learned models.

More information about the output data structures can be found in 
the "demo_shmm.m" and "run_experiment.m" scripts.

The directory "shmm/" contains the code for SHMMs.
The directory "experiment/" contains the code for running the SHMM experiments
in the BRM paper.
The directory "results_shmm/" contains the results from the experiment.

Note: this toolbox uses the EMHMM toolbox, which is included in the zip file.

--- REFERENCES ---
If you use this toolbox, please cite the following papers:

  Tim Chuk, Antoni B. Chan, Shinsuke Shimojo, and Janet H. Hsiao,
  "Eye movement analysis with switching hidden Markov models."
  Behavior Research Methods, 2019.
  https://doi.org/10.3758/s13428-019-01298-y

--- CHANGE LOG ---
see CHANGELOG.txt for version information.

--- CONTACT INFO ---
Please send comments, bug reports, feature requests to Antoni Chan (abchan at cityu dot edu . hk).

--- NOTICE ---

See the attached copyright notice. This software is for non-commercial purposes only.
For commercial purposes, please contact the authors.

--- ACKNOWLEDGEMENTS ---
We are grateful to the Research Grant Council of Hong Kong (project 17609117 to J.H.H.
and CityU 110513 to A.B.C.).

