ETracker.show_status

ETracker.show_status(decision_key='space', video_help=True)

Real-time visualization of participant’s eye position in track box.

Creates interactive display showing left/right eye positions and distance from screen. Useful for positioning participants before data collection. Updates continuously until exit key is pressed.

Optionally displays an instructional video in the background to help guide participant positioning. You can use the built-in video, disable the video, or provide your own custom MovieStim object.

Parameters

Name Type Description Default
decision_key str Key to press to exit visualization. Default ‘space’. 'space'
video_help bool or visual.MovieStim Controls background video display: - True: Uses built-in instructional video (default) - False: No video displayed - visual.MovieStim: Uses your pre-loaded custom video. You are responsible for scaling (size) and positioning (pos) the MovieStim to fit your desired layout. Default True. True

Details

In simulation mode, use scroll wheel to adjust simulated distance. Eye positions shown as green (left) and red (right) circles.

The built-in video (when video_help=True) is sized at (1.06, 0.6) in height units and positioned at (0, -0.08) to avoid covering the track box.

Examples

Basic Usage

Default with built-in video

    ET_controller.show_status()

Without background video

    ET_controller.show_status(video_help=False)

Customization Options

Custom exit key

    ET_controller.show_status(decision_key='return')

Custom video with specific size and position

    from psychopy import visual
    my_video = visual.MovieStim(
        win, 
        'instructions.mp4', 
        size=(0.8, 0.6), 
        pos=(0, -0.1)
    )
    ET_controller.show_status(video_help=my_video)

Complete Workflows

Position participant before calibration

    # Position participant
    ET_controller.show_status()
    
    # Run calibration
    success = ET_controller.calibrate(5)
    
    # Start recording if calibration successful
    if success:
        ET_controller.start_recording('data.h5')
Back to top