Updated documentation

DataReprojDetection.m

@@ -1,21 +1,21 @@
 % DataReprojDetection.m
 %
-% This function detects eye movement by reprojectinig 360-degree
-% equirectangular data and calling another eye movement detection function. It
-% woks by splitting the equirectangular input data into intervals where the
+% This function detects eye movements by reprojectinig the 360-degree
+% equirectangular data and calling an external eye movement detection function.
+% It woks by splitting the equirectangular input data into intervals where the
 % vertical spread is no more than 45 degrees. It then reprojects them around
-% the equatorial line of the sphere and creates a new ARFF that is equivalent
+% the equatorial line of the sphere and creates coordinates that are equivalent
 % to a monitor recorded experiment. Finally we can call the provided monitor
 % designed algorithm with the new ARFF object as input. The input data should
 % have the relation "gaze_360" to mark they were recorded in 360-degree
-% equirectangular.
+% equirectangular experiment.
 %
 % The eye movement detection function is provided as string in the input
 % arguments. This function should have at least 3 input variables, namely
 % data, metadata, and attributes as loaded from the LoadArff function. If the
 % provided detection function requires more input than the 3 default arguments,
-% these can be provided as extra arguments in the argument list of the
-% current function. The extra arguments are placed in the provided order after
+% these can be provided as extra arguments in the argument list of the current
+% function. The extra arguments are placed in the order that they appear after
 % the 3 default arguments in the detection function. The output of the
 % detection function should be a vector with a unique integer value for each
 % detected eye movement. These should correspond to the provided attValues
@@ -29,9 +29,8 @@
 %                 form '{unassigned, fixation, sacacde, sp, noise}'
 %   detFuncName - detection function name
 %   varargin    - required extra arguments for calling the detection function.
-%                 The data, metadata, attributes are passed to the detection
-%                 function by default in this order followed by the varargin
-%                 arguments
+%                 The data, metadata, attributes are used by default in this
+%                 order followed by the varargin arguments
 
 function DataReprojDetection(arffFile, outFile, outputAtt, attValues, detFuncName, varargin)
     DetectionFunction = str2func(detFuncName);

DataReprojFovDetection.m

@@ -1,18 +1,18 @@
 % DataReprojFovDetection.m
 %
-% This function detects eye movement by reprojectinig the 360-degree
+% This function detects eye movements by reprojectinig the 360-degree
 % equirectangular data in the field-of-view (FOV) coordinates of the headset.
-% By doing this we disentagle the head from the eye motion. On the converted data
-% we can then call another eye movement detection function. The input data should
-% have the relation "gaze_360" to mark they were recorded in 360-degree
-% equirectangular.
+% By doing this we disentagle the head from the eye motion. On the converted
+% data we can then call an external eye movement detection function. The input
+% data should have the relation "gaze_360" to mark they were recorded in
+% 360-degree equirectangular.
 %
 % The eye movement detection function is provided as string in the input
 % arguments. This function should have at least 3 input variables, namely
 % data, metadata, and attributes as loaded from the LoadArff function. If the
 % provided detection function requires more input than the 3 default arguments,
-% these can be provided as extra arguments in the argument list of the
-% current function. The extra arguments are placed in the provided order after
+% these can be provided as extra arguments in the argument list of the current
+% function. The extra arguments are placed in the order that they appear after
 % the 3 default arguments in the detection function. The output of the
 % detection function should be a vector with a unique integer value for each
 % detected eye movement. These should correspond to the provided attValues

DetectBlinks360.m

@@ -1,9 +1,10 @@
 % DetectBlinks360.m
 %
-% This function detects blinks by using intervals of noise in arff as well as
-% saccade detection. For every noise interval searches on both direction
-% (forward and backwards in time) and if it finds a saccade within a given time
-% distance it labels the noise and saccade interval as blink.
+% This function detects blinks by using intervals of noise in the provided ARFF
+% data together with saccade detection. For every noise interval searches on
+% both directions (forward and backwards in time) and if it finds a saccade
+% within a given time distance it labels the noise, the saccade interval, and
+% the samples in between as blink.
 %
 % input:
 %   data        - data from the ARFF file

DetectSaccades360File.m

@@ -3,9 +3,6 @@
 % This function detects saccades from the input file and store them in the provided
 % attribute of the output file. The values of the attribute in the output 
 % file are '{unassigned, saccade}'
-
-% It tries to replicate SaccadeDetector
-% of dsf for use in matlab. So for comparison of the logic look this documentation
 %
 % input:
 %   inputfile   - ARFF file containing gaze coordinates

ProjectEquirect2Fov.m

@@ -4,7 +4,6 @@
 % the FOV and returns the new data. The change is indicated throught the
 % relation name, which is set to gaze_fov.
 %
-%
 % input:
 %   data        - data from the ARFF file
 %   metadata    - metadata from the ARFF file