Merge pull request #113 from immersivecognition/personal/jack/2022-improvements

feb 2022 improvements

Author: jackbrookes

Assets/UXF/Scripts/Etc/Block.cs

@@ -8,7 +8,7 @@ namespace UXF
     /// <summary>
     /// A set of trials, often used to group a number of consecutive Trial objects that share something in common.
     /// </summary>
-    public class Block : ISettingsContainer
+    public class Block : IExperimentUnit
     {
         /// <summary>
         /// List of trials associated with this block
@@ -33,13 +33,21 @@ public class Block : ISettingsContainer
         /// <summary>
         /// Block settings. These will be overridden by trial settings if set.
         /// </summary>
-        public Settings settings { get; private set; }
+        public Settings settings { get; protected set; }
 
         /// <summary>
         /// The session associated with this block
         /// </summary>
         public Session session { get; private set; }
 
+        /// <summary>
+        /// Should data be saved for this session?
+        /// </summary>
+        public bool saveData
+        {
+            get => settings.GetBool(Constants.SAVE_DATA_SETTING_NAME, true);
+            set => settings.SetValue(Constants.SAVE_DATA_SETTING_NAME, value);
+        }
 
         /// <summary>
         /// Create a block with a given number of trials under a given session

Assets/UXF/Scripts/Etc/Constants.cs

@@ -0,0 +1,9 @@
+using UnityEngine;
+
+namespace UXF
+{
+    public static class Constants
+    {
+        public const string SAVE_DATA_SETTING_NAME = "_UXFInternal_SaveData";
+    }
+}

Assets/UXF/Scripts/Etc/Constants.cs.meta

@@ -4,16 +4,18 @@
 
 namespace UXF.EditorUtils
 {
-    [CustomEditor(typeof(UXF.Tracker), true)]
+    [CustomEditor(typeof(Tracker), true)]
     [CanEditMultipleObjects]
     public class TrackerEditor : Editor
     {
-        SerializedProperty customHeader, measurementDescriptor;
+        GUIStyle smallText = new GUIStyle();
+        Tracker thisTracker;
 
         void OnEnable()
         {
-            customHeader = serializedObject.FindProperty("customHeader");
-            measurementDescriptor = serializedObject.FindProperty("measurementDescriptor");
+            smallText.font = EditorStyles.miniFont;
+            smallText.fontSize = 9;
+            thisTracker = (Tracker)serializedObject.targetObject;
         }
 
         public override void OnInspectorGUI()
@@ -31,34 +33,38 @@ public override void OnInspectorGUI()
             {
                 if (field.IsPublic || field.GetCustomAttribute(typeof(SerializeField)) != null)
                 {                    
-                    if (field.Name != measurementDescriptor.name && field.Name != customHeader.name)
-                    {
-                        var prop = serializedObject.FindProperty(field.Name);
-                        EditorGUILayout.PropertyField(prop);
-                    }
+                    var prop = serializedObject.FindProperty(field.Name);
+                    EditorGUILayout.PropertyField(prop);
                 }
             }
 
             EditorGUILayout.Space();
-            GUI.enabled = false;
 
-            EditorGUILayout.LabelField(customHeader.displayName);
+            EditorGUILayout.LabelField("Custom Header");
+            EditorGUILayout.TextField("(\"time\" is added automatically)", smallText);
             EditorGUI.indentLevel += 1;
-
-            foreach (SerializedProperty element in customHeader)
-            {
-                EditorGUILayout.TextField(element.stringValue);
-            }
+            GUI.enabled = false;
+            EditorGUILayout.TextField(string.Join(", ", thisTracker.CustomHeader));
+            GUI.enabled = true;
             EditorGUI.indentLevel -= 1;
 
             EditorGUILayout.Space();
 
-            EditorGUILayout.LabelField(measurementDescriptor.displayName);
+            EditorGUILayout.LabelField("Measurement Descriptor");
             EditorGUI.indentLevel += 1;
-            EditorGUILayout.TextField(measurementDescriptor.stringValue);
+            GUI.enabled = false;
+            EditorGUILayout.TextField(thisTracker.MeasurementDescriptor);
+            GUI.enabled = true;
             EditorGUI.indentLevel -= 1;
 
+            EditorGUILayout.Space();
+            EditorGUILayout.LabelField("Example Filename");
+            EditorGUI.indentLevel += 1;
+            GUI.enabled = false;
+            EditorGUILayout.TextField(string.Format("{0}_T001.csv", thisTracker.DataName));
             GUI.enabled = true;
+            EditorGUI.indentLevel -= 1;
+
             serializedObject.ApplyModifiedProperties();
         }
     }

Assets/UXF/Scripts/Etc/Editor/TrackerEditor.cs

@@ -0,0 +1,19 @@
+using System;
+using System.Linq;
+using System.Collections;
+using System.Collections.Generic;
+using UnityEngine;
+
+namespace UXF
+{
+    /// <summary>
+    /// Represents a unit of an experiment.
+    /// </summary>
+    public interface IExperimentUnit : ISettingsContainer
+    {
+        /// <summary>
+        /// Sets wether data should be saved for this experiment unit.
+        /// </summary>
+        bool saveData { get; }
+    }
+}

Assets/UXF/Scripts/Etc/IExperimentUnit.cs

@@ -2,6 +2,7 @@
 using System.Collections;
 using System.IO;
 using System.Collections.Generic;
+using System.Linq;
 
 namespace UXF
 {
@@ -10,6 +11,9 @@ namespace UXF
     /// </summary>
     public abstract class Tracker : MonoBehaviour
     {
+        private bool recording = false;
+        private static string[] baseHeaders = new string[] { "time" };
+
         /// <summary>
         /// Name of the object used in saving
         /// </summary>
@@ -18,47 +22,29 @@ public abstract class Tracker : MonoBehaviour
         /// <summary>
         /// Description of the type of measurement this tracker will perform.
         /// </summary>
-        [Tooltip("Description of the type of measurement this tracker will perform.")]
-        public string measurementDescriptor;
+        public abstract string MeasurementDescriptor { get; }  
 
         /// <summary>
-        /// Custom column headers for tracked objects. Time is added automatically
+        /// Custom column headers for tracked objects.
         /// </summary>
-        [Tooltip("Custom column headers for each measurement.")]
-        public string[] customHeader = new string[] { };
+        public abstract IEnumerable<string> CustomHeader { get; }  
 
         /// <summary>
         /// A name used when saving the data from this tracker.
         /// </summary>
-        public string dataName
+        public string DataName
         {
             get
             {
-                Debug.AssertFormat(measurementDescriptor.Length > 0, "No measurement descriptor has been specified for this Tracker!");
-                return string.Join("_", new string[]{ objectName, measurementDescriptor });
+                Debug.AssertFormat(MeasurementDescriptor.Length > 0, "No measurement descriptor has been specified for this Tracker!");
+                return string.Join("_", new string[]{ objectName, MeasurementDescriptor });
             }
         }
 
-        private bool recording;
-
         public bool Recording { get { return recording; } }
 
-        public UXFDataTable data { get; private set; } = new UXFDataTable();
+        public UXFDataTable Data { get; private set; } = new UXFDataTable();
 
-        /// <summary>
-        /// The header that will go at the top of the output file associated with this tracker
-        /// </summary>
-        /// <returns></returns>
-        public string[] header
-        { 
-            get
-            {
-                var newHeader = new string[customHeader.Length + 1];
-                newHeader[0] = "time";
-                customHeader.CopyTo(newHeader, 1);
-                return newHeader;
-            }
-        }
 
         /// <summary>
         /// When the tracker should take measurements.
@@ -70,7 +56,6 @@ public string[] header
         void Reset()
         {
             objectName = gameObject.name.Replace(" ", "_").ToLower();
-            SetupDescriptorAndHeader();
         }
 
         // called by unity just before rendering the frame
@@ -90,19 +75,20 @@ void FixedUpdate()
         /// </summary>
         public void RecordRow()
         {
-            if (!recording) throw new System.InvalidOperationException("Tracker measurements cannot be taken when not in a trial!");
+            if (!recording) throw new System.InvalidOperationException("Tracker measurements cannot be taken when not recording!");
 
             UXFDataRow newRow = GetCurrentValues();
             newRow.Add(("time", Time.time));
-            data.AddCompleteRow(newRow);
+            Data.AddCompleteRow(newRow);
         }
 
         /// <summary>
         /// Begins recording.
         /// </summary>
         public void StartRecording()
         {
-            data = new UXFDataTable(header);
+            var header = baseHeaders.Concat(CustomHeader);
+            Data = new UXFDataTable(header.ToArray());
             recording = true;
         }
 
@@ -120,11 +106,6 @@ public void StopRecording()
         /// <returns></returns>
         protected abstract UXFDataRow GetCurrentValues();
 
-        /// <summary>
-        /// Override this method and define your own descriptor and header.
-        /// </summary>
-        protected abstract void SetupDescriptorAndHeader();
-
     }
 
     /// <summary>

Assets/UXF/Scripts/Etc/IExperimentUnit.cs.meta

@@ -13,7 +13,7 @@ namespace UXF
     /// The base unit of experiments. A Trial is usually a singular attempt at a task by a participant after/during the presentation of a stimulus.
     /// </summary>
     [Serializable]
-    public class Trial : ISettingsContainer, IDataAssociatable
+    public class Trial : IExperimentUnit, IDataAssociatable
     {
 
         /// <summary>
@@ -46,7 +46,16 @@ public class Trial : ISettingsContainer, IDataAssociatable
         /// <summary>
         /// Trial settings. These will override block settings if set.
         /// </summary>
-        public Settings settings { get; private set; }
+        public Settings settings { get; protected set; }
+
+        /// <summary>
+        /// Should data be saved for this session?
+        /// </summary>
+        public bool saveData
+        {
+            get => settings.GetBool(Constants.SAVE_DATA_SETTING_NAME, true);
+            set => settings.SetValue(Constants.SAVE_DATA_SETTING_NAME, value);
+        }
 
         /// <summary>
         /// Dictionary of results in a order.
@@ -121,34 +130,10 @@ public void End()
             status = TrialStatus.Done;
             endTime = Time.time;
             result["end_time"] = endTime;
-
-            // check no duplicate trackers
-            List<string> duplicateTrackers = session.trackedObjects.Where(tracker => tracker != null)
-              .GroupBy(tracker => tracker.dataName)
-              .Where(g => g.Count() > 1)
-              .Select(y => y.Key)
-              .ToList(); 
-
-            if (duplicateTrackers.Any()) throw new InvalidOperationException(string.Format("Two or more trackers in the Tracked Objects field in the Session Inspector have the following object name and descriptor pair, please change the object name fields on the trackers to make them unique: {0}", string.Join(",", duplicateTrackers)));
-
-            // log tracked objects
-            foreach (Tracker tracker in session.trackedObjects)
-            {
-                try
-                {
-                    tracker.StopRecording();
-                    SaveDataTable(tracker.data, tracker.dataName, dataType: UXFDataType.Trackers);
-                }
-                catch (NullReferenceException)
-                {
-                    Utilities.UXFDebugLogWarning("An item in the Tracked Objects field of the UXF session if empty (null)!");
-                }
-            }
-
-            // log any settings we need to for this trial
-            foreach (string s in session.settingsToLog)
+            
+            if (saveData)
             {
-                result[s] = settings.GetObject(s, string.Empty);
+                SaveData();
             }
 
             session.onTrialEnd.Invoke(this);
@@ -262,7 +247,37 @@ public void SaveBytes(byte[] bytes, string dataName, UXFDataType dataType = UXFD
             }
         }
 
+        private void SaveData()
+        {
+            // check no duplicate trackers
+            List<string> duplicateTrackers = session.trackedObjects.Where(tracker => tracker != null)
+              .GroupBy(tracker => tracker.DataName)
+              .Where(g => g.Count() > 1)
+              .Select(y => y.Key)
+              .ToList();
+
+            if (duplicateTrackers.Any()) throw new InvalidOperationException(string.Format("Two or more trackers in the Tracked Objects field in the Session Inspector have the following object name and descriptor pair, please change the object name fields on the trackers to make them unique: {0}", string.Join(",", duplicateTrackers)));
+
+            // log tracked objects
+            foreach (Tracker tracker in session.trackedObjects)
+            {
+                try
+                {
+                    tracker.StopRecording();
+                    SaveDataTable(tracker.Data, tracker.DataName, dataType: UXFDataType.Trackers);
+                }
+                catch (NullReferenceException)
+                {
+                    Utilities.UXFDebugLogWarning("An item in the Tracked Objects field of the UXF session if empty (null)!");
+                }
+            }
 
+            // log any settings we need to for this trial
+            foreach (string s in session.settingsToLog)
+            {
+                result[s] = settings.GetObject(s, string.Empty);
+            }
+        }
     }