neuralib.facemap.plot.plot_facemap_keypoints

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

Plot all the keypoints

Parameters:

  • fmap (FaceMapResult) – FaceMapResult

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

  • keypoints (str | ndarray[tuple[Any, ...], dtype[str_]] | list[str] | tuple[str, ...] | pd.Series | pl.Series | None) – a keypoint name or multiple keypoints. If None, then show all the keypoints

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

  • output (str | Path | PathLike[str] | None) – output file. Show the fig if None

Return type:

None