Skip to content

Pupil Finding Reference

candytaco edited this page Apr 2, 2021 · 2 revisions

Reference for everything on the SharpEyes main window.

Menu

File

Open Video: Loads an eyetracking video

Load timestamps: Loads saved timestamps from a video

Load eyetracking: Loads saved pupil locations from a video

Load templates: Loads saved pupil finding templates

Save timestamps: Saves the current timestamps

Save Eyetracking: Saves the current found pupils

Save templates: Saves the current templates

Save all: save everything to a directory; doesn't actually work yet

Auto save on exit: auto save anything in memory on window exit if checked.

Edit

has nothing right now

Tools

Stimulus view: opens a window to show the gaze position overlaid on the stimulus video

Help

Help: Opens to this wiki

Report bug: Opens a link to this repo's issues page for you to make a new but report

About: Shows build info

Toolbar

Open video: Opens an eyetracking video

Draw window: click to enter draw window mode to select a sub-patch of the video to search for pupils, instead of searching over the entire video frame. Click again to exit draw window mode. SharpEyes will also auto-exit draw window mode if you draw a window.

Move pupil: click to enter edit pupil mode. While in this mode, you can click and drage the pupil across the video, and scroll to change the pupil size

Video Player

Arrow buttons: Goes one frame forward or backwards

Play/pause button: Plays the video with existing pupil positions. Does not find pupils.

Lower left text: Shows pupil position and radius in video frame sizes. Confidence reflects the confidence that the algorithm has about where the pupil is. 0 is no confidence, 1 is full confidence. When using the template pupil finder, this is the correlation of the best match with the frame.

Show filtered video: If checked, displays the filtered frames instead of the raw frames.

Controls Panel

Pupil Finding

This tab contains all the controls for actually finding the pupils and also parameters for tuning how the pupil is found.

Read timestamps: Reads timestamps from the video.

Load timestamps: Loads saved timestamps

Reset: resets all parameters

Auto save: if checked, all values, i.e. timestamps, custom templates, and pupil positions, will be auto-saved into the same folder as the video every time something is changed.

Find pupils: Finds pupils in the next N frames. N is specified by the up-down picker below this button. If All Frames is checked, disregards N, and goes to the end of the video. When pupil finding is in progress, this changes to a Cancel button that interrupts the process.

All Frames: if checked, clicking Find Pupils will try to run to the end of the video instead of the next N frames

Step back: go back N frames. N specified by the up-down picker below the Find pupils button

Min radius: minimum pupil radius in pixels to look for

Max radius: maximum pupil radius in pixels to look for

Pupil Finder type: Which method to use. Currently, only "Template" is implemented. Honestly, though, it's way better than Hough Circles.

Template pupil finding options

Add current as template: add the part of the frame under the current pupil location as a custom template.

Auto add: if checked, will automatically add the frame under the current pupil location (if manually edited) as a custom template

Reset to default templates: clears custom templates and use idealized templates instead.

Use templates: combobox giving the choice to use all templates, or only the last N templates. N is specified by a up-down picker below the box when that option is selected.

Pause when confidence is below: if checked, SharpEyes will automatically pause pupil finding, and await manual adjustments, if confidence falls below X averaged across N frames. X and N are specified by the up-down pickers underneath this checkbox.

<Back: step backwards by N frames, where N is specified by the picker under the Pause when confidence is below check box.

Prev/Next: display previous/next template.

Delete template: remove the currently shown template

Image pre-filtering

Set filter parameters applied to the raw frames before the pupil finding is performed on the frame.

IMO filtering is unnecessary when using templates, but may be helpful for the Hough transform.

Bilateral blur: bilateral blur size, see Photoshop's surface blur for more details

Sigma color: color "width" to use when performing the bilateral blur

Sigma space: spatial size to use when performing the bilateral blur

Median blur: median blur size

Manual adjustments

When you adjust the pupil size in one file, the position in the following frames are also adjusted.

Adjustment mode:

Linear: the delta you apply to this frame from the auto-found pupil location is linearly faded for the next N frames

Exponential: the delta you apply to this frame from the auto-found pupil location is exponentially faded over the next frames, with a time constant of N frames.

The decay options give you pickers for picking N.

Automatically enter pupil edit mode on pause: if checked, pupil edit mode will be automatically enabled when pupil finding is pause, either manually or automatically.

Calibration

Just a skeleton right now. Does nothing.

Clone this wiki locally