Settings File

In addition to the built in options available either through code or the GUI, SightLab has some additional global settings that can be set. Here is a list of those settings.

To change any of these per script you can use code similar to this (this is for the start text). You just need to add this before importing SightLab into your script. For changing the vizconnect (hardware configurations) you can use the built in parameters.

# Import before sightlab
from sightlab_utils import settings



def update_settings(setting_name, value):
    setattr(settings, setting_name, value)


# Change Starting Text
update_settings("START_TEXT", "Press Trigger to Continue")

# Change vizconnect using built in parameter
sightlab = sl.SightLab(vizconnectconfiglist=["Desktop", "Meta Quest Pro"])

Settings Availabe

WINDOW_SIZE = viz.MainWindow.getSize(mode=viz.WINDOW_PIXELS)
# print(WINDOW_SIZE)
proportionFactor = 0.75
viz.window.setSize(WINDOW_SIZE[0] * proportionFactor, WINDOW_SIZE[1] * proportionFactor)
# viz.window.setSize(1600, 900)
SCALE_FACTOR = viz.window.getSize()[1] / 900
# Add to this if you have a custom vizconnect file you would like to use
VIZCONNECT_DICT = {
    "Vive Pro Eye": "vizconnect_config_vive_pro.py",
    "Pupil Labs": "vizconnect_config_vive_pupil_labs.py",
    "Vive Tobii": "vizconnect_config_vive_tobii.py",
    "Desktop": "vizconnect_config_desktop_3d.py",
    "Desktop_360": "vizconnect_config_desktop_360.py",
    "Meta No Eyetracker": "vizconnect_config_oculus_simulate.py",
    "Vive/ Vive Pro, Vive Pro 2": "vizconnect_config_vive.py",
    "StarVROne": "vizconnect_config_starVR.py",
    "HP Omnicept": "vizconnect_config_omnicept.py",
    "Vive Focus 3": "vizconnect_config_vive_focus.py",
    "Driving Desktop": "vizconnect_config_desktop_driving.py",
    "Driving Vive": "vizconnect_config_vive_pro_driving.py",
    "Driving Omnicept": "vizconnect_config_omnicept_driving.py",
    "Driving SteamVR": "vizconnect_config_vive_driving.py",
    "Driving Meta": "vizconnect_config_meta_driving.py",
    "Driving OpenXR No EyeTR": "vizconnect_config_openxr_driving_no_eyetr.py",
    "Driving Quest Pro": "vizconnect_config_openxr_driving.py",
    "Driving Varjo": "vizconnect_config_openxr_driving.py",
    "Meta Quest Pro": "vizconnect_config_openxr.py",
    "Meta Pro Hand": "vizconnect_config_meta_hand.py",
    "Varjo": "vizconnect_config_varjo.py",
    "PPT HMD": "vizconnect_config_hmd_PPT.py",
    "Meta Quest 3": "vizconnect_quest_3.py",
    "Meta": "vizconnect_config_oculus_simulate.py",
    "SteamVR": "vizconnect_config_steamvr.py",
    "Vive Focus 3 OpenXR": "vizconnect_config_vive_focus_openXR.py",
    "OpenXR NoEyeTR": "vizconnect_opexr_no_eyetr.py",
    "OpenXR EyeTR": "vizconnect_config_openxr_eyetr.py",
    "Omnicept OpenXR": "vizconnect_config_openxr_omnicept.py",
    "Desktop Avatar": "vizconnect_config_desktop_avatar.py",
    "Meta Avatar": "vizconnect_config_meta_avatar.py",
    "Driving Birds Eye Desktop": "vizconnect_config_desktop_driving_birds_eye.py",
    "Driving Birds Eye SteamVR": "vizconnect_config_driving_steamvr_birdseye",
    "EyeTracking Data Only": "vizconnect_config_no_display.py",
    "Omnicept Recorder": "vizconnect_config_desktop_3d.py",
    "Vive Focus 3 Recorder": "vizconnect_config_desktop_3d.py",
    "Vive Trackers SteamVR": "vizconnect_config_viveTrackers.py",
    "Vive Trackers CC": "vizconnect_config_viveTrackers_CC.py",
    "Open XR Feet": "vizconnect_config_openxr_feet.py",
    "Head and Hands OpenXR": "vizconnect_config_openxr_head_and_hands.py",
    "Head and Hands OpenXR No Eye": "vizconnect_config_OpenXR_NoEyeTr_head_and_hands.py",
    "Manus OpenXR": "vizconnect_config_manus_openxr.py",
    "Manus SteamVR": "vizconnect_config_manus_steamvr.py",
    "Manus head and hands": "vizconnect_config_head_and_hands_manus.py",
}
VIZCONNECT_CONFIG_LIST = [
    "Desktop",
    "Vive Pro Eye",
    "Vive Focus 3",
    "Vive Focus 3 OpenXR",
    "HP Omnicept",
    "SteamVR",
    "Meta Quest Pro",
    "Meta No Eyetracker",
    "Meta Quest 3",
    "Vive/ Vive Pro, Vive Pro 2",
    "Meta Pro Hand",
    "Varjo",
    "OpenXR EyeTR",
    "OpenXR NoEyeTR",
    "Pupil Labs",
    "StarVROne",
    "Vive Tobii",
    "PPT HMD",
    "Omnicept OpenXR",
    "EyeTracking Data Only",
    "Vive Trackers SteamVR",
    "Vive Trackers CC",
    "Head and Hands OpenXR",
    "Manus OpenXR",
    "Manus SteamVR",
]
VIZCONNECT_CONFIG = None
CONTINUE_EVENT_KEY = " "
# Compress videos, requires moviepy library
COMPRESS_VIDEOS = True
# .mp4, .avi or .mpg
VIDEO_FILE_TYPE = ".mp4"
BIT_RATE = "500k"
VIDEO_RECORDING_WINDOW_HEIGHT = viz.setOption("viz.AVIRecorder.maxWidth", "800")
VIDEO_RECORDING_WINDOW_WIDTH = viz.setOption("viz.AVIRecorder.maxHeight", "720")
START_TEXT = "Press Spacebar to Start"
BIOPAC_TOGGLE = False
DWELL_THRESHOLD = 0.5
ADDITIONAL_SETTINGS = {"Console": True, "Gaze Path Visible": False}
FADE_IN_TIME = 0
FADE_OUT_TIME = 0
TRIAL_OR_SCENE = "Trial"
SHIFT_LOCK_TOGGLE = True

PARTICIPANT_INFO1 = 'Last Name'
PARTICIPANT_INFO2 = 'First Name'