scanpathplot#

pymovements.plotting.scanpathplot(events: EventDataFrame, gaze: Gaze | None = None, position_column: str = 'location', cval: np.ndarray | None = None, cmap: matplotlib.colors.Colormap | None = None, cmap_norm: matplotlib.colors.Normalize | str | None = None, cmap_segmentdata: LinearSegmentedColormapType | None = None, cbar_label: str | None = None, show_cbar: bool = False, padding: float | None = None, pad_factor: float | None = 0.05, figsize: tuple[int, int] = (15, 5), title: str | None = None, savepath: str | None = None, show: bool = True, color: str = 'blue', alpha: float = 0.5, add_traceplot: bool = False, gaze_position_column: str = 'pixel', add_stimulus: bool = False, path_to_image_stimulus: str | None = None, stimulus_origin: str = 'upper') → None[source]#

Plot scanpath from positional data.

Parameters:

  • events (EventDataFrame) – The EventDataFrame to plot.

  • gaze (Gaze | None) – Optional Gaze Dataframe. (default: None)

  • position_column (str) – The column name of the x and y position data (default: ‘location’)

  • cval (np.ndarray | None) – Line color values. (default: None)

  • cmap (matplotlib.colors.Colormap | None) – Color map for line color values. (default: None)

  • cmap_norm (matplotlib.colors.Normalize | str | None) – Normalization for color values. (default: None)

  • cmap_segmentdata (LinearSegmentedColormapType | None) – Color map segmentation to build color map. (default: None)

  • cbar_label (str | None) – String label for color bar. (default: None)

  • show_cbar (bool) – Shows color bar if True. (default: False)

  • padding (float | None) – Absolute padding value. If None it is inferred from pad_factor and limits. (default: None)

  • pad_factor (float | None) – Relative padding factor to construct padding value if not given. (default: 0.5)

  • figsize (tuple[int, int]) – Figure size. (default: (15, 5))

  • title (str | None) – Set figure title. (default: None)

  • savepath (str | None) – If given, figure will be saved to this path. (default: None)

  • show (bool) – If True, figure will be shown. (default: True)

  • color (str) – Color of fixations. (default: ‘blue’)

  • alpha (float) – Alpha value of scanpath. (default: 0.5)

  • add_traceplot (bool) – Boolean value indicating whether to add traceplot to the scanpath plot. (default: False)

  • gaze_position_column (str) – Position column in the gaze dataframe. (default: ‘pixel’)

  • add_stimulus (bool) – Boolean value indicationg whether to plot the scanpath on the stimuls. (default: False)

  • path_to_image_stimulus (str | None) – Path of the stimulus to be shown. (default: None)

  • stimulus_origin (str) – Origin of stimuls to plot on the stimulus. (default: ‘upper’)

Raises:

ValueError – If length of x and y coordinates do not match or if cmap_norm is unknown.

On this page

This Page