Skip to content

Free Motion Capture for Everyone πŸ’€βœ¨

TypeScript

Update sample data hosting (#701)

Aaron Cherian1b8bbf7f52f4
diff --git a/freemocap/diagnostics/calibration/run_calibration.py b/freemocap/diagnostics/calibration/run_calibration.py
index 4c45c271..39fe1a1c 100644
--- a/freemocap/diagnostics/calibration/run_calibration.py
+++ b/freemocap/diagnostics/calibration/run_calibration.py
@@ -16,7 +16,7 @@ from freemocap.data_layer.recording_models.recording_info_model import \
RecordingInfoModel
from freemocap.diagnostics.calibration.calibration_utils import \
get_charuco_2d_data
-from freemocap.diagnostics.download_data import download_test
+from freemocap.utilities.download_sample_data import download_test_data
# Configure logging
logger = logging.getLogger(__name__)
@@ -38,7 +38,7 @@ def setup_session():
"""
logger.info("Downloading sample data...")
- SessionInfo.sample_session_folder_path = download_test()
+ SessionInfo.sample_session_folder_path = download_test_data()
logger.info("Initializing recording model...")
SessionInfo.recording_info_model = RecordingInfoModel(
diff --git a/freemocap/diagnostics/download_data.py b/freemocap/diagnostics/download_data.py
deleted file mode 100644
index 87d1f81e..00000000
--- a/freemocap/diagnostics/download_data.py
+++ /dev/null
@@ -1,69 +0,0 @@
-import io
-import logging
-import zipfile
-from dataclasses import dataclass
-from pathlib import Path
-
-import requests
-
-from freemocap.system.paths_and_filenames.path_getters import \
- get_recording_session_folder_path
-
-logger = logging.getLogger(__name__)
-
-
-@dataclass
-class Sample:
- url: str
-
-
-DATASETS = {
- "test": Sample(
- url="https://github.com/freemocap/skellysamples/releases/download/test_data_v06_09_25/freemocap_test_data.zip"
- )
-}
-
-
-def get_dataset(key: str) -> Path:
- try:
- spec = DATASETS[key]
- except KeyError:
- raise ValueError(f"Unknown dataset '{key}'. Options: {list(DATASETS)}")
-
- return Path(download_data(spec.url))
-
-
-def download_data(zip_file_url) -> str:
- try:
- logger.info(f"Downloading data from {zip_file_url}...")
- recording_session_folder_path = Path(get_recording_session_folder_path())
- recording_session_folder_path.mkdir(parents=True, exist_ok=True)
- r = requests.get(zip_file_url, stream=True, timeout=(5, 60))
- r.raise_for_status()
-
- z = zipfile.ZipFile(io.BytesIO(r.content))
- z.extractall(recording_session_folder_path)
-
- recording_name = {
- Path(p).parts[0] for p in z.namelist() if not p.endswith("/")
- } # gets name of recording (top-level folder in zip file)
- if len(recording_name) != 1:
- raise ValueError(f"{zip_file_url!r} contained {len(recording_name)} top-level entries: {recording_name}")
-
- data_path = recording_session_folder_path / recording_name.pop()
- logger.info(f"Data extracted to {str(data_path)}")
- return str(data_path)
- except requests.exceptions.RequestException as e:
- logger.error(f"Request failed: {e}")
- raise e
- except zipfile.BadZipFile as e:
- logger.error(f"Failed to unzip the file: {e}")
- raise e
-
-
-def download_test() -> str:
- """
- Downloads the test data zip file and extracts it to the recording session folder.
- Returns the path to the extracted data.
- """
- return download_data(DATASETS["test"].url)
diff --git a/freemocap/gui/qt/actions_and_menus/actions.py b/freemocap/gui/qt/actions_and_menus/actions.py
index 2b68e0e0..3352b210 100644
--- a/freemocap/gui/qt/actions_and_menus/actions.py
+++ b/freemocap/gui/qt/actions_and_menus/actions.py
@@ -3,16 +3,16 @@ from PySide6.QtGui import QAction, QDesktopServices
from freemocap.system.paths_and_filenames.file_and_folder_names import (
DOCUMENTATION_WELCOME_URL,
- FIGSHARE_SAMPLE_ZIP_FILE_URL,
- FIGSHARE_TEST_ZIP_FILE_URL,
)
+from freemocap.utilities.download_sample_data import DATASETS
+from freemocap.gui.qt.actions_and_menus.sample_data_actions import make_download_data_action
+
+
CREATE_NEW_RECORDING_ACTION_NAME = "New Recording"
LOAD_MOST_RECENT_RECORDING_ACTION_NAME = "Load Most Recent Recording"
LOAD_RECORDING_ACTION_NAME = "Load Recording"
IMPORT_VIDEOS_ACTION_NAME = "Import Videos"
-DOWNLOAD_SAMPLE_DATA_ACTION_NAME = "Download Sample Data (3 cameras, ~1000 frames)"
-DOWNLOAD_TEST_DATA_ACTION_NAME = "Download Test Data (3 cameras, ~200 frames)"
SET_DATA_FOLDER_ACTION_NAME = "Set Freemocap Data Folder Location"
RESET_TO_DEFAULTS_ACTION_NAME = "Reset to Default GUI Settings"
KILL_THREADS_AND_PROCESSES_ACTION_NAME = "Kill Threads and Processes"
@@ -28,13 +28,9 @@ DONATE_ACTION_NAME = "Donate to Freemocap"
class Actions:
def __init__(self, freemocap_main_window):
# File
- self.create_new_recording_action = QAction(
- CREATE_NEW_RECORDING_ACTION_NAME, parent=freemocap_main_window
- )
+ self.create_new_recording_action = QAction(CREATE_NEW_RECORDING_ACTION_NAME, parent=freemocap_main_window)
self.create_new_recording_action.setShortcut("Ctrl+N")
- self.create_new_recording_action.triggered.connect(
- freemocap_main_window.handle_start_new_session_action
- )
+ self.create_new_recording_action.triggered.connect(freemocap_main_window.handle_start_new_session_action)
self.load_most_recent_recording_action = QAction(
LOAD_MOST_RECENT_RECORDING_ACTION_NAME, parent=freemocap_main_window
@@ -44,58 +40,29 @@ class Actions:
freemocap_main_window.handle_load_most_recent_recording
)
- self.load_existing_recording_action = QAction(
- LOAD_RECORDING_ACTION_NAME, parent=freemocap_main_window
- )
+ self.load_existing_recording_action = QAction(LOAD_RECORDING_ACTION_NAME, parent=freemocap_main_window)
self.load_existing_recording_action.setShortcut("Ctrl+O")
- self.load_existing_recording_action.triggered.connect(
- freemocap_main_window.open_load_existing_recording_dialog
- )
+ self.load_existing_recording_action.triggered.connect(freemocap_main_window.open_load_existing_recording_dialog)
- self.import_videos_action = QAction(
- IMPORT_VIDEOS_ACTION_NAME, parent=freemocap_main_window
- )
+ self.import_videos_action = QAction(IMPORT_VIDEOS_ACTION_NAME, parent=freemocap_main_window)
self.import_videos_action.setShortcut("Ctrl+I")
- self.import_videos_action.triggered.connect(
- freemocap_main_window.open_import_videos_dialog
- )
-
- self.download_sample_data_action = QAction(
- DOWNLOAD_SAMPLE_DATA_ACTION_NAME, parent=freemocap_main_window
- )
- self.download_sample_data_action.triggered.connect(
- lambda: freemocap_main_window.download_data(
- download_url=FIGSHARE_SAMPLE_ZIP_FILE_URL
- )
- )
+ self.import_videos_action.triggered.connect(freemocap_main_window.open_import_videos_dialog)
- self.download_test_data_action = QAction(
- DOWNLOAD_TEST_DATA_ACTION_NAME, parent=freemocap_main_window
- )
- self.download_test_data_action.triggered.connect(
- lambda: freemocap_main_window.download_data(
- download_url=FIGSHARE_TEST_ZIP_FILE_URL
+ for key in DATASETS:
+ setattr(
+ self,
+ f"download_{key}_data_action",
+ make_download_data_action(dataset_key=key, freemocap_main_window=freemocap_main_window),
)
- )
- self.set_data_folder_action = QAction(
- SET_DATA_FOLDER_ACTION_NAME, parent=freemocap_main_window
- )
+ self.set_data_folder_action = QAction(SET_DATA_FOLDER_ACTION_NAME, parent=freemocap_main_window)
self.set_data_folder_action.setShortcut("Ctrl+S")
- self.set_data_folder_action.triggered.connect(
- freemocap_main_window.open_settings_dialog
- )
+ self.set_data_folder_action.triggered.connect(freemocap_main_window.open_settings_dialog)
- self.reset_to_defaults_action = QAction(
- RESET_TO_DEFAULTS_ACTION_NAME, parent=freemocap_main_window
- )
- self.reset_to_defaults_action.triggered.connect(
- freemocap_main_window.reset_to_default_gui_settings
- )
+ self.reset_to_defaults_action = QAction(RESET_TO_DEFAULTS_ACTION_NAME, parent=freemocap_main_window)
+ self.reset_to_defaults_action.triggered.connect(freemocap_main_window.reset_to_default_gui_settings)
- self.reboot_gui_action = QAction(
- REBOOT_GUI_ACTION_NAME, parent=freemocap_main_window
- )
+ self.reboot_gui_action = QAction(REBOOT_GUI_ACTION_NAME, parent=freemocap_main_window)
self.reboot_gui_action.setShortcut("Ctrl+R")
self.reboot_gui_action.triggered.connect(freemocap_main_window.reboot_gui)
@@ -112,28 +79,16 @@ class Actions:
self.exit_action.triggered.connect(freemocap_main_window.close)
# Help
- self.open_docs_action = QAction(
- OPEN_DOCS_ACTION_NAME, parent=freemocap_main_window
- )
- self.open_docs_action.triggered.connect(
- lambda: QDesktopServices.openUrl(QUrl(DOCUMENTATION_WELCOME_URL))
- )
+ self.open_docs_action = QAction(OPEN_DOCS_ACTION_NAME, parent=freemocap_main_window)
+ self.open_docs_action.triggered.connect(lambda: QDesktopServices.openUrl(QUrl(DOCUMENTATION_WELCOME_URL)))
- self.freemocap_foundation_action = QAction(
- FREEMOCAP_FOUNDATION_ACTION_NAME, parent=freemocap_main_window
- )
+ self.freemocap_foundation_action = QAction(FREEMOCAP_FOUNDATION_ACTION_NAME, parent=freemocap_main_window)
self.freemocap_foundation_action.triggered.connect(
- lambda: QDesktopServices.openUrl(
- QUrl("https://freemocap.org/about-us.html")
- )
+ lambda: QDesktopServices.openUrl(QUrl("https://freemocap.org/about-us.html"))
)
- self.show_release_notes_action = QAction(
- "Release Notes", parent=freemocap_main_window
- )
- self.show_release_notes_action.triggered.connect(
- freemocap_main_window.open_release_notes_popup
- )
+ self.show_release_notes_action = QAction("Release Notes", parent=freemocap_main_window)
+ self.show_release_notes_action.triggered.connect(freemocap_main_window.open_release_notes_popup)
# # Navigation
# show_camera_control_panel_action = QAction("&1 - Show Camera Control Panel", parent=main_window)
@@ -150,9 +105,7 @@ class Actions:
# Support
self.donate_action = QAction(DONATE_ACTION_NAME, parent=freemocap_main_window)
self.donate_action.triggered.connect(
- lambda: QDesktopServices.openUrl(
- QUrl("https://freemocap.org/about-us.html#donate")
- )
+ lambda: QDesktopServices.openUrl(QUrl("https://freemocap.org/about-us.html#donate"))
)
# self.send_usage_statistics_action = QAction("Send &User Statistics", parent=freemocap_main_window)
# self.user_survey_action = QAction("&User Survey", parent=freemocap_main_window)
diff --git a/freemocap/gui/qt/actions_and_menus/menu_bar.py b/freemocap/gui/qt/actions_and_menus/menu_bar.py
index ef85682b..8ec159a7 100644
--- a/freemocap/gui/qt/actions_and_menus/menu_bar.py
+++ b/freemocap/gui/qt/actions_and_menus/menu_bar.py
@@ -1,6 +1,7 @@
from PySide6.QtWidgets import QMainWindow, QMenuBar
from freemocap.gui.qt.actions_and_menus.actions import Actions
+from freemocap.utilities.download_sample_data import DATASETS
class MenuBar(QMenuBar):
@@ -33,8 +34,11 @@ class MenuBar(QMenuBar):
# Data Menu
data_menu = self.addMenu("&Data")
- data_menu.addAction(actions.download_sample_data_action)
- data_menu.addAction(actions.download_test_data_action)
+ for key in DATASETS:
+ action_attr = f"download_{key}_data_action"
+ if hasattr(actions, action_attr):
+ action = getattr(actions, action_attr)
+ data_menu.addAction(action)
#
# # navigation menu
diff --git a/freemocap/gui/qt/actions_and_menus/sample_data_actions.py b/freemocap/gui/qt/actions_and_menus/sample_data_actions.py
new file mode 100644
index 00000000..8b7f28aa
--- /dev/null
+++ b/freemocap/gui/qt/actions_and_menus/sample_data_actions.py
@@ -0,0 +1,30 @@
+from PySide6.QtGui import QAction
+from freemocap.utilities.download_sample_data import DATASETS
+
+
+class DatasetDownloadAction(QAction):
+ """
+ Action with built-in trigger to download a specific dataset.
+ """
+
+ def __init__(self, menu_label: str, dataset_name: str, freemocap_main_window):
+ super().__init__(menu_label, freemocap_main_window)
+ self.triggered.connect(lambda: freemocap_main_window.download_data(dataset_name))
+
+
+def make_download_data_action(
+ dataset_key: str,
+ freemocap_main_window,
+) -> DatasetDownloadAction:
+ """
+ Makes a DatasetDownloadAction for the specified dataset key.
+ Raises ValueError if the dataset key is not recognized.
+ """
+ if dataset_key not in DATASETS:
+ raise ValueError(f"Unknown dataset '{dataset_key}'. Options: {list(DATASETS)}")
+
+ dataset = DATASETS[dataset_key]
+
+ return DatasetDownloadAction(
+ menu_label=dataset.menu_label, dataset_name=dataset_key, freemocap_main_window=freemocap_main_window
+ )
diff --git a/freemocap/gui/qt/main_window/freemocap_main_window.py b/freemocap/gui/qt/main_window/freemocap_main_window.py
index 1666a5dd..ce677f20 100644
--- a/freemocap/gui/qt/main_window/freemocap_main_window.py
+++ b/freemocap/gui/qt/main_window/freemocap_main_window.py
@@ -501,9 +501,9 @@ class MainWindow(QMainWindow):
if self._settings_dialog.result():
self.reboot_gui()
- def download_data(self, download_url: str):
+ def download_data(self, dataset_name: str):
logger.info("Downloading sample data")
- self.download_data_thread_worker = DownloadDataThreadWorker(dowload_url=download_url)
+ self.download_data_thread_worker = DownloadDataThreadWorker(dataset_name=dataset_name)
self.download_data_thread_worker.start()
self.download_data_thread_worker.finished.connect(self._handle_download_data_finished)
diff --git a/freemocap/gui/qt/workers/download_sample_data_thread_worker.py b/freemocap/gui/qt/workers/download_sample_data_thread_worker.py
index a0a6ba34..6fd5544f 100644
--- a/freemocap/gui/qt/workers/download_sample_data_thread_worker.py
+++ b/freemocap/gui/qt/workers/download_sample_data_thread_worker.py
@@ -3,7 +3,7 @@ from pathlib import Path
from PySide6.QtCore import Signal, QThread
-from freemocap.utilities.download_sample_data import download_sample_data
+from freemocap.utilities.download_sample_data import download_dataset
logger = logging.getLogger(__name__)
@@ -12,18 +12,18 @@ class DownloadDataThreadWorker(QThread):
finished = Signal(str)
in_progress = Signal(str)
- def __init__(self, dowload_url: str, parent=None):
+ def __init__(self, dataset_name: str, parent=None):
super().__init__(parent=parent)
logger.debug("Initializing download sample data thread worker")
- self.download_url = dowload_url
+ self.dataset_name = dataset_name
def run(self):
- logger.debug("Downloading sample data")
+ logger.debug("Starting sample data download")
try:
- downloaded_data_path = download_sample_data(sample_data_zip_file_url=self.download_url)
+ downloaded_data_path = download_dataset(self.dataset_name)
if Path(downloaded_data_path).exists():
- logger.debug(f"Data successfully downloaded from: {self.download_url}")
+ logger.debug(f"Data successfully downloaded to {downloaded_data_path}")
self.finished.emit(downloaded_data_path)
else:
logger.error(f"Could not find downloaded data at {downloaded_data_path}")
@@ -31,5 +31,5 @@ class DownloadDataThreadWorker(QThread):
except Exception as e: # noqa
logger.exception(e)
- logger.error(f"Error downloading sample data from {self.download_url}")
+ logger.error("Error downloading sample data")
raise e
diff --git a/freemocap/utilities/download_sample_data.py b/freemocap/utilities/download_sample_data.py
index 11175675..2ea8b3f0 100644
--- a/freemocap/utilities/download_sample_data.py
+++ b/freemocap/utilities/download_sample_data.py
@@ -4,50 +4,58 @@ import zipfile
from pathlib import Path
import requests
-
-from freemocap.system.paths_and_filenames.file_and_folder_names import (
- FIGSHARE_SAMPLE_ZIP_FILE_URL,
- FREEMOCAP_SAMPLE_DATA_RECORDING_NAME,
- FREEMOCAP_TEST_DATA_RECORDING_NAME,
- FIGSHARE_TEST_ZIP_FILE_URL,
-)
from freemocap.system.paths_and_filenames.path_getters import get_recording_session_folder_path
+from pydantic import BaseModel
logger = logging.getLogger(__name__)
+TEST_DATA_NAME = "test"
+DOWNLOAD_SAMPLE_DATA_ACTION_NAME = "Download Sample Data (3 cameras, ~1000 frames)"
-def get_sample_data_path(download_if_needed: bool = True) -> str:
- sample_data_path = str(Path(get_recording_session_folder_path()) / FREEMOCAP_TEST_DATA_RECORDING_NAME)
- if not Path(sample_data_path).exists():
- if download_if_needed:
- download_sample_data()
- else:
- raise Exception(f"Could not find sample data at {sample_data_path} (and `download_if_needed` is False)")
+SAMPLE_DATA_NAME = "sample"
+DOWNLOAD_TEST_DATA_ACTION_NAME = "Download Test Data (3 cameras, ~200 frames)"
- return sample_data_path
+class Dataset(BaseModel):
+ url: str
+ menu_label: str
+ tooltip: str = (
+ "Download this dataset to use in Freemocap. The sample data contains 3 cameras and ~1000 frames. The test data contains 3 cameras and ~200 frames."
+ )
+
+
+DATASETS = {
+ SAMPLE_DATA_NAME: Dataset(
+ url="https://github.com/freemocap/skellysamples/releases/download/sample_data_v06_12_25/freemocap_sample_data.zip",
+ menu_label=DOWNLOAD_SAMPLE_DATA_ACTION_NAME,
+ ),
+ TEST_DATA_NAME: Dataset(
+ url="https://github.com/freemocap/skellysamples/releases/download/test_data_v06_09_25/freemocap_test_data.zip",
+ menu_label=DOWNLOAD_TEST_DATA_ACTION_NAME,
+ ),
+}
-def download_sample_data(sample_data_zip_file_url: str = FIGSHARE_TEST_ZIP_FILE_URL) -> str:
- try:
- logger.info(f"Downloading sample data from {sample_data_zip_file_url}...")
+def download_and_extract_zip(zip_file_url) -> str:
+ try:
+ logger.info(f"Downloading data from {zip_file_url}...")
recording_session_folder_path = Path(get_recording_session_folder_path())
recording_session_folder_path.mkdir(parents=True, exist_ok=True)
-
- r = requests.get(sample_data_zip_file_url, stream=True, timeout=(5, 60))
- r.raise_for_status() # Check if request was successful
+ r = requests.get(zip_file_url, stream=True, timeout=(5, 60))
+ r.raise_for_status()
z = zipfile.ZipFile(io.BytesIO(r.content))
z.extractall(recording_session_folder_path)
- if sample_data_zip_file_url == FIGSHARE_TEST_ZIP_FILE_URL:
- figshare_sample_data_path = recording_session_folder_path / FREEMOCAP_TEST_DATA_RECORDING_NAME
- elif sample_data_zip_file_url == FIGSHARE_SAMPLE_ZIP_FILE_URL:
- figshare_sample_data_path = recording_session_folder_path / FREEMOCAP_SAMPLE_DATA_RECORDING_NAME
- else:
- figshare_sample_data_path = recording_session_folder_path / "unknown_sample_data"
- logger.info(f"Sample data extracted to {str(figshare_sample_data_path)}")
- return str(figshare_sample_data_path)
+ recording_name = {
+ Path(p).parts[0] for p in z.namelist() if not p.endswith("/")
+ } # gets name of recording (top-level folder in zip file)
+ if len(recording_name) != 1:
+ raise ValueError(f"{zip_file_url!r} contained {len(recording_name)} top-level entries: {recording_name}")
+
+ data_path = recording_session_folder_path / recording_name.pop()
+ logger.info("Data extracted successfully")
+ return str(data_path)
except requests.exceptions.RequestException as e:
logger.error(f"Request failed: {e}")
@@ -57,6 +65,46 @@ def download_sample_data(sample_data_zip_file_url: str = FIGSHARE_TEST_ZIP_FILE_
raise e
+def download_dataset(key: str) -> str:
+ """
+ Downloads the specified dataset zip file and extracts it to the recording session folder.
+ Returns the path to the extracted data.
+ """
+ if key not in DATASETS:
+ raise ValueError(f"Unknown dataset '{key}'. Options: {list(DATASETS)}")
+
+ return download_and_extract_zip(DATASETS[key].url)
+
+
+def download_test_data() -> str:
+ """
+ Downloads the test data zip file and extracts it to the recording session folder.
+ Returns the path to the extracted data.
+ """
+ return download_dataset(TEST_DATA_NAME)
+
+
+def download_sample_data() -> str:
+ """
+ Downloads the sample data zip file and extracts it to the recording session folder.
+ Returns the path to the extracted data.
+ """
+ return download_dataset(SAMPLE_DATA_NAME)
+
+
+def get_sample_data_path() -> Path:
+ """
+ Returns the path to the sample data folder.
+ If the folder does not exist, it downloads the sample data.
+ """
+ sample_data_path = Path(get_recording_session_folder_path()) / "freemocap_sample_data"
+ if not sample_data_path.exists():
+ logger.info(f"Sample data not found at {sample_data_path}. Downloading...")
+ download_sample_data()
+
+ return sample_data_path
+
+
if __name__ == "__main__":
sample_data_path = download_sample_data()
print(f"Sample data downloaded successfully to path: {str(sample_data_path)}")