The eyevec-dump command-line utility enables you to dump the content of an EyeVec data file (a binary file) in plain text format. You can use this program to inspect the contents of an EyeVec data file without converting it to CSV.

Synopsis

eyevec-dump [<option> ...] <file>

Options

Option Default Description

-u

show basic usage message

-h

show usage details, examples and version information

-v=num

0

verbosity level

-inf

on

show general file info

-cfg

off

show configuration records

-bas

off

show baseline start/end records

-cal

off

show calibration start/end records

-val

off

show validation start/end records

-dc

off

show drift-check start/end records

-rec

off

show recording start/end records

-msg

off

show text message records

-fix

off

show fixation start/end event records

-sac

off

show saccade start/end event records

-bli

off

show blink start/end event records

-fxu

off

show fixation update event records

-blu

off

show blink update event records

-eye

off

show eye sample record

-pp

off

show pupil data in eye sample record

-cr

off

show cr data in eye sample record

-ir

off

show iris data in eye sample record

-gz

off

show gaze data in eye sample record

-hd

off

show head sample record

-all

off

enable all show options above

-right

on

select right eye records

-left

on

select left eye records

-mean

on

select mean eye records (events records only)

-both

off

select only both-eyes records (eye sample records only)

-orc

off

also process gaze events and eye samples outside recording

-px

off

convert logical gaze positions to pixels

-mm

off

convert logical gaze positions to millimeters

-utc

off

show timestamps in UTC, otherwise relative to start

-s

off

express relative timestamps in s rather than ms

-sort

on

sort records chronologically

  • The '=' symbol in options that have an argument may be replaced by a colon : or by whitespace. So -opt:arg or -opt arg are effectively the same as -opt=arg.

  • To turn off options that are on by default, put a dash after the option; for example, -foo- will turn off option foo. You may also specify -foo=x where x is one of false, true, no, yes, off, on, F, T, Y, N, 0, 1.

  • Options may be specified in any order. The order does not affect the program’s behavior.

Arguments

The program expects the name of one EyeVec data file (e.g. results.bed).

Examples

In the examples below we’ll be inspecting the following file: results-p15.bed

  • Processing results-p15.bed, only showing basic file information:

eyevec-dump results-p15.bed

.000                           FILEINFO

  • The same, now with record content.

eyevec-dump results-p15.bed -v=1

0.000                           FILEINFO
    file name:                  results-p15.bed
    create time:                2025-06-25T15:08:31 UTC
    create time [us]:           1750864111889027
    timezone offset [s]:        7200
    file version:               3
    eyevec version:             1.1.0
    help:                       https://www.eyevec.com

  • Showing all records in the file, without actual record content:

eyevec-dump results-p15.bed -all

This yields: output.txt (truncated)

  • The same but with record content (attention, may yield very long output):

eyevec-dump results-p15.bed -all -v=1

This yields: output.txt (truncated)

  • Showing only fixations, saccades and blinks:

eyevec-dump results-p15.bed -fix -sac -bli -v=1

This yields: output.txt

  • The same but not showing records for right and left eye, leaving only the mean eye:

eyevec-dump results-p15.bed -fix -sac -bli -right=no -left=no -v=1

This yields: output.txt

  • Showing only eye samples, with gaze information:

eyevec-dump results-p15.bed -eye -gz -v=1

This yields: output.txt (truncated)

  • The same with also pupil, cr and iris information:

eyevec-dump results-p15.bed -eye -pp -cr -ir -gz -v=1

This yields: output.txt (truncated)