How to Update
Updating with Pip
In the `conda` environment where you launch `freemocap`, enter the following command:
pip install freemocap==1.4.*
Confirm update by checking the version number in the bottom right corner of the FreeMoCap GUI Welcome Screen
Installing with Dedicated Installer
Releases for this version are in the assets files at the bottom of this page. Please read the general notes and specific instructions for your platform before installing. If you already have FreeMoCap downloaded through the installer, there are notes on how to update the version in the [v1.2.0 Release Notes](https://github.com/freemocap/freemocap/releases/tag/v1.2.0).
Release Notes
This minor release adds the ability to get 3d data from a single camera. Because this data is less reliable, 2d data is still the default. To turn on 3d data for single camera recordings, uncheck the Flatten Single Camera Data (Recommended) button in the motion capture parameters. It also fixes a bug in the processing pipeline check that was interfering with some single camera recordings.
FreeMoCap 1.4.0 marks a significant backend overhaul across almost all of our sub-repositories. As we're working towards our long-term goal of providing users the flexibility to integrate and use different pose estimation trackers, this update focuses on making the backend more tracker-agnostic and simplifying the process for writing new pose estimation trackers within our `SkellyTracker` repository.
General Changes
- FreeMoCap (`v1.4.0`): 3D data can now be collected from a single camera. The backend has been fully generalized to remove the hard dependency on MediaPipe for data and file management. Now, tracker-specific information is provided by SkellyTracker, making it easier to integrate different trackers.
- - **Note**: As a part of this, we did update some of our file naming conventions - see notes below for more
- SkellyTracker `(v2024.08.1018)`: Some big updates to simplify writing new trackers for FreeMoCap. Check out the `mediapipe_model_info.py` in SkellyTracker if you're interesting in seeing how its written.
- SkellyForge `(v2024.8.1008)`: Small update to remove MediaPipe dependency
- FreeMoCap Blender addon (`v2024.09.1024`): Updated paths to align with the new file naming conventions. The addon now also checks for compatibility with old file names.
**IMPORTANT: New file naming convention**
We've standardized our file naming convention with this update - which means if you have any scripts that depend on specific file names, they **may not work with recordings made with v1.4**.
We now follow a standard convention of tagging any file names with the prefix `[tracker_name]_' - which affects these following file names moving forward:
**Raw Data**: All raw data file names previously lacked underscores and have been changed to do so.
**Output Data**: The file name for the numpy array with all the processed name has been changed.
**Center of Mass**: All center of mass file names are now prefixed with `mediapipe_`.
See the table below for the full name changes.
Update Script
We have also added an update script to standardize an entire `freemocap_data` folder to the new naming convention. You can run the script by running `python -m freemocap.utilities.update_1_4_path_names` in your terminal. To specify a non-default `freemocap_data` folder, you can run `python -m freemocap.utilities.update_1_4_path_names {PATH_TO_OTHER_FOLDER}`. Depending on your Python installation you may need to run `python3 -m ...`.
| Old File Name | New File Name |
|------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|
| mediapipe2dData_numCams_numFrames_numTrackedPoints_pixelXY.npy | mediapipe_2dData_numCams_numFrames_numTrackedPoints_pixelXY.npy |
| mediapipe3dData_numCams_numFrames_numTrackedPoints_reprojectionError.npy | mediapipe_3dData_numCams_numFrames_numTrackedPoints_reprojectionError.npy |
| mediapipe3dData_numFrames_numTrackedPoints_reprojectionError.npy | mediapipe_3dData_numFrames_numTrackedPoints_reprojectionError.npy |
| mediapipe3dData_numFrames_numTrackedPoints_spatialXYZ.npy | mediapipe_3dData_numFrames_numTrackedPoints_spatialXYZ.npy |
| mediaPipeSkel_3d_body_hands_face.npy | mediapipe_skeleton_3d.npy |
| total_body_center_of_mass_xyz.npy | mediapipe_total_body_center_of_mass_xyz.npy |
| segmentCOM_frame_joint_xyz.npy | mediapipe_segmentCOM_frame_joint_xyz.npy |
___
What's Changed
- Remove residual confidence threshold cutoff by philipqueen in https://github.com/freemocap/freemocap/pull/623
- Patch pipeline check for single video recordings by philipqueen in https://github.com/freemocap/freemocap/pull/624
- 3d from Single Camera by philipqueen in https://github.com/freemocap/freemocap/pull/618
- Generalize mediapipe code to other trackers by philipqueen in https://github.com/freemocap/freemocap/pull/536
**Full Changelog**: https://github.com/freemocap/freemocap/compare/v1.3.1...v1.4.0
___
Attached Files:
- `freemocap_test_data_processed_with_freemocap_v1.4.0.zip` - A zipped copy of the `freemocap_test_data` recording processed with `freemocap_v1.4.0`
Installers
NOTE - For detailed instructions on the use of these installers, see the [v1.2.0 Release Notes](https://github.com/freemocap/freemocap/releases/tag/v1.2.0)
- `freemocap_linux_app.zip` - Dedicated installer for Linux systems.
- `freemocap_windows_exe.zip` - Dedicated installer/executable for Windows systems. Does not work on Windows 11.
- `freemocap_mac_app.zip` - Dedicated installer/application for Mac systems. Works on both Intel and Arm systems.