diff --git a/genindex.html b/genindex.html index 7c6abf9..66c118f 100644 --- a/genindex.html +++ b/genindex.html @@ -562,6 +562,8 @@
Synchronize gaze data to video frames by applying windowed averaging -around each video frame timestamp.
-Recording object containing gaze and video data.
-The size of the time window (in nanoseconds)
+around timestamps of each video frame.
+See pyneon.stream.NeonStream.window_average()
for details.
window_size (int, optional) – The size of the time window (in nanoseconds)
over which to compute the average around each new timestamp.
If None
(default), the window size is set to the median interval
between the new timestamps, i.e., np.median(np.diff(new_ts))
.
The window size must be larger than the median interval between the original data timestamps,
-i.e., window_size > np.median(np.diff(data.index))
.
window_size > np.median(np.diff(data.index))
.inplace (bool, optional) – Whether to replace the gaze data in the instance with the window averaged data.
Gaze object containing data synchronized to video frames.
+Gaze object containing data synchronized to video frames.
NeonGaze
+Map fixations to video frames.
-Gaze data synchronized to video frames. If None (default), a windowed average is applied to synchronize gaze data to video frames.
@@ -647,7 +645,7 @@Plot scanpath on top of the video frames. The resulting video can be displayed and/or saved.
Notes
Motion-BIDS is an extension to the Brain Imaging Data Structure (BIDS) to -standardize the organization of motion data for reproducible research [1]. +standardize the organization of motion data for reproducible research [1]. For more information, see https://bids-specification.readthedocs.io/en/stable/modality-specific-files/motion.html.
References
Synchronize gaze data to video frames by applying windowed averaging
-around each video frame timestamp. See window_average()
for details
-on the averaging process.
Recording object containing gaze and video data.
-The size of the time window (in nanoseconds)
-over which to compute the average around each new timestamp.
-If None
(default), the window size is set to the median interval
-between the new timestamps, i.e., np.median(np.diff(new_ts))
.
-The window size must be larger than the median interval between the original data timestamps,
-i.e., window_size > np.median(np.diff(data.index))
.
DataFrame containing gaze data mapped to video timestamps.
+Plot scanpath on top of the video frames. The resulting video can be displayed and/or saved.
+scanpath (pandas.DataFrame
) – DataFrame containing the fixations and gaze data.
circle_radius (int) – Radius of the fixation circles in pixels. Defaults to 10.
line_thickness (int or None) – Thickness of the lines connecting fixations. If None, no lines are drawn. +Defaults to 2.
max_fixations (int) – Maximum number of fixations to plot per frame. Defaults to 10.
show_video (bool) – Whether to display the video with fixations overlaid. Defaults to False.
video_output_path (pathlib.Path
or str or None) – Path to save the video with fixations overlaid. If None, the video is not saved.
+Defaults to ‘scanpath.mp4’.
NeonVideo.width
NeonVideo.height
NeonVideo.plot_frame()
NeonVideo.plot_scanpath_on_video()
sync_gaze_to_video()
estimate_scanpath()
Plot scanpath on top of the video frames. The resulting video can be displayed and/or saved.