Experimental data, processing code, processed results and figures for the paper:

Performance and analysis of feature tracking approaches in laser speckle instrumentation
T.O.H Charrett and R.P. Tatam
Sensors 2019, xx, 5; doi:10.3390/sxx010005 

Contents:
----------
\code [folder]           -      Processing code used for analysis and to produce figures
\data [folder]           -      Experimental data sets
\figures [folder]        -      Figures used in the paper
\results [folder]        -      Processed results stored for figure generation and analysis
\supplementary_data [folder]    -   Supplementary figures and videos


\data [folder]
---------------

Experimental datasets used in paper. All files are in HDF5 format


dataset1 continuous translation.hdf5        -   100 speckle patterns (512x512 pixels) acuqired 
                                                during continuous translation above an aluminium 
                                                plate at 5mm/s. 
                                                Dataset in file = 'imgs'


dataset2 random positions.hdf5              -   100 uncorrelated speckle patterns (512x512 pixels)
                                                acuqired at random positions above an aluminium 
                                                plate. 
                                                Dataset in file = 'imgs'

dataset3 stepped rotations.hdf5             -   Speckle patterns from aluminium plate rotation 0-360
                                                degrees in 0.5 degree steps.
                                                Datasets in file:
                                                    'imgs'=image arrays
                                                    'angles'=rotation angles
                                                
dataset4 surface samples translation        -   Folder containing hdf5 files for each surface sample
                                                tested.
                                                Each file is named with surface finish and surface 
                                                roughness Rz value.
                                                Datasets in each file: 
                                                    'imgs'=image arrays, 
                                                    'dxs'=applied translation in mm
                                                
dataset5 surface samples rotation           -   Folder containing df5 files for each surface sample 
                                                tested.
                                                Each file is named with surface finish and surface 
                                                roughness Rz value.
                                                Datasets in each file: 'imgs'=image arrays, 
                                                'angs'=applied rotation in degrees.
                                                
surface samples.hdf5                        -   Example speckle patterns from different surface 
                                                samples acquired with variable exposure time to have
                                                similiar intensities.
                                                Contains surface finishing method groups:
                                                    'flat lapping reaming'
                                                    'grinding'
                                                    'horizontal milling'
                                                    'turning'
                                                    'vertical milling'
                                                
                                                Each containing:
                                                    Rzs -   the surface roughness Rz values
                                                    exp_times - the exposure times used.
                                                    imgs - the speckle patterns (1280x1024 pixels)

\code [folder]
------------
- Python code used for analysis and figures (python version 2.7.11, opencv version 3.4.2).
- Each file is prefixed with the relevant paper section.
- Files labeled with 'figure' use preprocessed data (stored in \results folder) to produce figures.
- The 'lib' folder is a custom python package containing code used throughout the analysis.
- To run scripts recreate the folder structure shown above in contents by extracting the zip archives.
Then set the python working directory to \code and add this folder to the python search path to allow
the lib package to be imported. Scripts should then be able to access data & preprocessed results.

\results [folder]
-----------------
- HDF5 files used to store pre-processed results for latter plotting.
- Produced by scripts in \code folder - re-running these scripts may overwrite extisting results!
- Files are prefixed with the relevant paper section.

\supplementary_data [folder]
----------------------------
- Full page figures in pdf format showing results for all surface samples.
- These can be recreated using the scripts in the \code folder.
- Also included are mp4 videos showing output of window extraction phase to enable visualisation of 
speckle pattern changes under rotation and translation.
- Each file is prefixed with the relevant paper section.