Events

You can annotate key points in time in your recordings using Events. This could for example be the start and end of a stimulus presentation in your experiment. Alternatively you could create an event to mark an anomaly that occured during data collection to later exclude this section from your analysis.

An event is essentially a timestamp in a recording with an assigned name. All events associated with a recording are saved as part of it and can be accessed afterwards.

In Pupil Cloud, events can also be used in the definition of enrichments to indicate what sections of your recordings should get processed. See here for details.

Creating Events

At recording time, you can use the Monitor App to create events manually. Alternatively, you can use the real-time API to create events programmatically. See for example this guide on using the real-time API to automatically track progress of an experiment.

TIP

When sending events in real time via the real-time API or the Monitor App, Neon assigns the timestamp based on the time of arrival by default. If you are synchronizing Neon with external systems (e.g., EEG or stimulus software), it is recommended to use the API's manual clock offset correction for improved temporal alignment. See details here.

Post hoc you can add events to recordings in Pupil Cloud.