Merge pull request #63 from TheD2Lab/ui-help-page

UI Help Page
TheD2Lab · Oct 24, 2024 · 7b1d391 · 7b1d391
2 parents 8986aff + 0c1000d
commit 7b1d391
Show file tree

Hide file tree

Showing 32 changed files with 242 additions and 169 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
-**B**each **E**nvironment for the **A**nalyti**c**s of **H**uman **Gaze** (BEACH-Gaze) provides reuseable and extensible support to the broader scientific community interested in descriptive and predictive gaze analytics applied to a wide range of domains. 
+**B**each **E**nvironment for the **A**nalyti**c**s of **H**uman **Gaze** (BEACH-Gaze) provides reuseable and extensible support to the broader scientific community interested in descriptive and predictive gaze analytics applied to a wide range of domains. BEACH-Gaze is open-source software issued under the GNU General Public License.
 
 # Abstract
 
-The purpose of this codebase is to provide an eye gaze analysis tool that utilizes machine learning algorithms to predict the fatigue level of participants. The codebase is compatible with Gazepoint's GP3 Desktop and GP3HD V2 eyetrackers and uses the WEKA software collection for its data mining procedures.
+The purpose of this codebase is to provide an eye gaze analysis tool that utilizes machine learning algorithms to predict the fatigue level of participants. The codebase is compatible with Gazepoint's GP3 and GP3HD eyetrackers and uses the WEKA software collection for its data mining procedures.
 
 # Setup
 

diff --git a/documentation.pdf b/documentation.pdf
diff --git a/img/ui-descriptive-analytics.png b/img/ui-descriptive-analytics.png
diff --git a/img/ui-predictive-analytics.png b/img/ui-predictive-analytics.png
diff --git a/src/main/java/com/github/thed2lab/analysis/Analysis.java b/src/main/java/com/github/thed2lab/analysis/Analysis.java
@@ -1,3 +1,6 @@
+/*
+ * BEACH-Gaze is open-source software issued under the GNU General Public License.
+ */
 package com.github.thed2lab.analysis;
 
 import static com.github.thed2lab.analysis.Constants.SCREEN_HEIGHT;

diff --git a/src/main/java/com/github/thed2lab/analysis/Angles.java b/src/main/java/com/github/thed2lab/analysis/Angles.java
@@ -1,3 +1,6 @@
+/*
+ * BEACH-Gaze is open-source software issued under the GNU General Public License.
+ */
 package com.github.thed2lab.analysis;
 
 import static com.github.thed2lab.analysis.Constants.FIXATION_ID;

diff --git a/src/main/java/com/github/thed2lab/analysis/AreaOfInterests.java b/src/main/java/com/github/thed2lab/analysis/AreaOfInterests.java
@@ -1,3 +1,6 @@
+/*
+ * BEACH-Gaze is open-source software issued under the GNU General Public License.
+ */
 package com.github.thed2lab.analysis;
 
 import static com.github.thed2lab.analysis.Constants.AOI_LABEL;

diff --git a/src/main/java/com/github/thed2lab/analysis/Blinks.java b/src/main/java/com/github/thed2lab/analysis/Blinks.java
@@ -1,3 +1,6 @@
+/*
+ * BEACH-Gaze is open-source software issued under the GNU General Public License.
+ */
 package com.github.thed2lab.analysis;
 
 import static com.github.thed2lab.analysis.Constants.BLINK_ID;

diff --git a/src/main/java/com/github/thed2lab/analysis/ClassifierResult.java b/src/main/java/com/github/thed2lab/analysis/ClassifierResult.java
@@ -1,3 +1,6 @@
+/*
+ * BEACH-Gaze is open-source software issued under the GNU General Public License.
+ */
 package com.github.thed2lab.analysis;
 
 import weka.classifiers.*;

diff --git a/src/main/java/com/github/thed2lab/analysis/Constants.java b/src/main/java/com/github/thed2lab/analysis/Constants.java
@@ -1,3 +1,6 @@
+/*
+ * BEACH-Gaze is open-source software issued under the GNU General Public License.
+ */
 package com.github.thed2lab.analysis;
 
 /**

diff --git a/src/main/java/com/github/thed2lab/analysis/ConvexHull.java b/src/main/java/com/github/thed2lab/analysis/ConvexHull.java
@@ -1,3 +1,6 @@
+/*
+ * BEACH-Gaze is open-source software issued under the GNU General Public License.
+ */
 package com.github.thed2lab.analysis;
 
 import static com.github.thed2lab.analysis.Constants.FIXATION_X;

diff --git a/src/main/java/com/github/thed2lab/analysis/Coordinate.java b/src/main/java/com/github/thed2lab/analysis/Coordinate.java
@@ -1,3 +1,6 @@
+/*
+ * BEACH-Gaze is open-source software issued under the GNU General Public License.
+ */
 package com.github.thed2lab.analysis;
 
 /** Simple data class for holding fixation coordinate information. */

diff --git a/src/main/java/com/github/thed2lab/analysis/DataEntry.java b/src/main/java/com/github/thed2lab/analysis/DataEntry.java
@@ -1,3 +1,6 @@
+/*
+ * BEACH-Gaze is open-source software issued under the GNU General Public License.
+ */
 package com.github.thed2lab.analysis;
 
 import java.util.ArrayList;

diff --git a/src/main/java/com/github/thed2lab/analysis/DataFilter.java b/src/main/java/com/github/thed2lab/analysis/DataFilter.java
@@ -1,3 +1,6 @@
+/*
+ * BEACH-Gaze is open-source software issued under the GNU General Public License.
+ */
 package com.github.thed2lab.analysis;
 
 import static com.github.thed2lab.analysis.Constants.FIXATION_ID;

diff --git a/src/main/java/com/github/thed2lab/analysis/DescriptiveStats.java b/src/main/java/com/github/thed2lab/analysis/DescriptiveStats.java
@@ -1,28 +1,7 @@
-package com.github.thed2lab.analysis;
 /*
- * Copyright (c) 2013, Bo Fu
- *
- * Permission is hereby granted, free of charge, to any person
- * obtaining a copy of this software and associated documentation
- * files (the "Software"), to deal in the Software without
- * restriction, including without limitation the rights to use,
- * copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the
- * Software is furnished to do so, subject to the following
- * conditions:
- *
- * The above copyright notice and this permission notice shall be
- * included in all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
- * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
- * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
- * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
- * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
- * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
- * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
- * OTHER DEALINGS IN THE SOFTWARE.
+ * BEACH-Gaze is open-source software issued under the GNU General Public License.
  */
+package com.github.thed2lab.analysis;
 
 import java.util.ArrayList;
 import java.util.Arrays;

diff --git a/src/main/java/com/github/thed2lab/analysis/Event.java b/src/main/java/com/github/thed2lab/analysis/Event.java
@@ -1,3 +1,6 @@
+/*
+ * BEACH-Gaze is open-source software issued under the GNU General Public License.
+ */
 package com.github.thed2lab.analysis;
 
 import static com.github.thed2lab.analysis.Constants.CURSOR_EVENT;

diff --git a/src/main/java/com/github/thed2lab/analysis/FileHandler.java b/src/main/java/com/github/thed2lab/analysis/FileHandler.java
@@ -1,3 +1,6 @@
+/*
+ * BEACH-Gaze is open-source software issued under the GNU General Public License.
+ */
 package com.github.thed2lab.analysis;
 
 import java.io.File;

diff --git a/src/main/java/com/github/thed2lab/analysis/Fixations.java b/src/main/java/com/github/thed2lab/analysis/Fixations.java
@@ -1,3 +1,6 @@
+/*
+ * BEACH-Gaze is open-source software issued under the GNU General Public License.
+ */
 package com.github.thed2lab.analysis;
 
 import static com.github.thed2lab.analysis.Constants.FIXATION_DURATION;

diff --git a/src/main/java/com/github/thed2lab/analysis/Gaze.java b/src/main/java/com/github/thed2lab/analysis/Gaze.java
@@ -1,3 +1,6 @@
+/*
+ * BEACH-Gaze is open-source software issued under the GNU General Public License.
+ */
 package com.github.thed2lab.analysis;
 
 import static com.github.thed2lab.analysis.Constants.*;

diff --git a/src/main/java/com/github/thed2lab/analysis/GazeEntropy.java b/src/main/java/com/github/thed2lab/analysis/GazeEntropy.java
@@ -1,3 +1,7 @@
+/*
+ * BEACH-Gaze is open-source software issued under the GNU General Public License.
+ */
+
 package com.github.thed2lab.analysis;
 
 import static com.github.thed2lab.analysis.Constants.AOI_LABEL;

diff --git a/src/main/java/com/github/thed2lab/analysis/Main.java b/src/main/java/com/github/thed2lab/analysis/Main.java
@@ -1,3 +1,6 @@
+/*
+ * BEACH-Gaze is open-source software issued under the GNU General Public License.
+ */
 package com.github.thed2lab.analysis;
 
 public class Main {

diff --git a/src/main/java/com/github/thed2lab/analysis/Parameters.java b/src/main/java/com/github/thed2lab/analysis/Parameters.java
@@ -1,3 +1,6 @@
+/*
+ * BEACH-Gaze is open-source software issued under the GNU General Public License.
+ */
 package com.github.thed2lab.analysis;
 
 import java.io.File;

diff --git a/src/main/java/com/github/thed2lab/analysis/Patterns.java b/src/main/java/com/github/thed2lab/analysis/Patterns.java
@@ -1,3 +1,6 @@
+/*
+ * BEACH-Gaze is open-source software issued under the GNU General Public License.
+ */
 package com.github.thed2lab.analysis;
 
 import java.util.ArrayList;

diff --git a/src/main/java/com/github/thed2lab/analysis/QuickStart.java b/src/main/java/com/github/thed2lab/analysis/QuickStart.java
@@ -1,3 +1,6 @@
+/*
+ * BEACH-Gaze is open-source software issued under the GNU General Public License.
+ */
 package com.github.thed2lab.analysis;
 
 import java.io.File;

diff --git a/src/main/java/com/github/thed2lab/analysis/SaccadeVelocity.java b/src/main/java/com/github/thed2lab/analysis/SaccadeVelocity.java
@@ -1,3 +1,6 @@
+/*
+ * BEACH-Gaze is open-source software issued under the GNU General Public License.
+ */
 package com.github.thed2lab.analysis;
 
 import static com.github.thed2lab.analysis.Constants.FIXATION_ID;

diff --git a/src/main/java/com/github/thed2lab/analysis/Saccades.java b/src/main/java/com/github/thed2lab/analysis/Saccades.java
@@ -1,3 +1,6 @@
+/*
+ * BEACH-Gaze is open-source software issued under the GNU General Public License.
+ */
 package com.github.thed2lab.analysis;
 
 import static com.github.thed2lab.analysis.Constants.FIXATION_DURATION;

diff --git a/src/main/java/com/github/thed2lab/analysis/Sequences.java b/src/main/java/com/github/thed2lab/analysis/Sequences.java
@@ -1,3 +1,6 @@
+/*
+ * BEACH-Gaze is open-source software issued under the GNU General Public License.
+ */
 package com.github.thed2lab.analysis;
 
 import static com.github.thed2lab.analysis.Constants.AOI_LABEL;