neuralib.tracking.facemap.plot

neuralib.tracking.facemap.plot.plot_facemap_keypoints(fmap, frame_interval, keypoints=None, outlier_filter=True, output=None)

Plot all the keypoints

Parameters:

• fmap (FaceMapResult) – FaceMapResult

• frame_interval (tuple[int, int]) – frame interval (start/end) for the plot

• keypoints (str | ArrayLikeStr | None) – a keypoint name or multiple keypoints. If None, then show all the keypoints

• outlier_filter (bool) – remove jump and do the interpolation

• output (PathLike | None) – output file. Show the fig if None

Return type:

None

neuralib.tracking.facemap.plot.plot_cmap_time_series(x, y, *, cmap='viridis', ax=None, with_color_bar=True, color_bar_label='frames', output=None, **kwargs)

Plots a scatter plot with a colorbar

Parameters:

• x (np.ndarray) – X-axis values. Array[float, T]

• y (np.ndarray) – Y-axis values. Array[float, T]

• cmap (str) – Colormap to use

• ax (Axes | None) – matplotlib.axes.Axes

• with_color_bar (bool) – if show the colorbar

• color_bar_label (str) – color bar label

• output (PathLike | None) – Output file path to save the plot

• kwargs – pass through ax.scatter()

Return type:

None