Skip to content

fix manual frame extraction with symlinks #2527

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MMathisLab merged 1 commit into from
Mar 1, 2024
Merged

fix manual frame extraction with symlinks #2527

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 39 additions & 1 deletion deeplabcut/gui/tabs/extract_frames.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
# Licensed under GNU Lesser General Public License v3.0
#
from functools import partial
from pathlib import Path
from typing import Union

from PySide6 import QtWidgets
from PySide6.QtCore import Qt
Expand Down Expand Up @@ -194,7 +196,9 @@ def extract_frames(self):
config = self.root.config
mode = self.extraction_method_widget.currentText()
if mode == "manual":
_ = launch_napari(list(self.video_selection_widget.files)[0])
videos = list(self.video_selection_widget.files)
video_path_in_folder = self._check_symlink(videos[0])
_ = launch_napari(str(video_path_in_folder))
return

algo = self.extraction_algorithm_widget.currentText()
Expand Down Expand Up @@ -237,3 +241,37 @@ def _show_success_message(self):
msg.setStandardButtons(QtWidgets.QMessageBox.Ok)
msg.exec_()
self.root.writer.write("Frames successfully extracted.")

def _check_symlink(self, video_path: Union[str, Path]) -> Path:
"""Checks that a video is in the DeepLabCut 'videos' folder

This is required before launching manual frame extraction. When users select
a symlink of a video using the VideoSelectionWidget, the path is resolved to the
true path of the video (which leads napari-deeplabcut to save the frames in the
incorrect folder).

Args:
video_path: the path to a video in a DeepLabCut project or a video that was
added to the project

Returns:
the path to the video (or symlink) in the project's 'videos' folder

Raises:
FileNotFoundError if there is no symlink or video in the 'videos' folder for
the given video
"""
video_path = Path(video_path).resolve()
project_videos = (Path(self.root.config).parent / "videos").resolve()
if video_path.parent == project_videos:
return video_path

symlink_path = project_videos / video_path.name
if not symlink_path.exists():
raise FileNotFoundError(
f"Could not find the video {video_path.name} in your project videos. "
f"Did you add the video (you can do so in the 'Manage Project' tab)? "
f"There should be a file in {symlink_path}."
)

return symlink_path