Freemocap

Latest version: v1.4.7

Safety actively analyzes 685525 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 1 of 2

2024.07.1022

Going forward, we will try to keep the `freemocap_blender_addon` latest release up to date with an installable Blender addon (Hopefully autmated via GitHub Action, see: https://github.com/freemocap/freemocap_blender_addon/issues/16)

Whee!

❤️💀✨

___

Auto-generated Release notes (i.e. merged Pull Requests in this release)
* Patch 'export_to_blender' import in batch process by philipqueen in https://github.com/freemocap/freemocap/pull/585
* Update PyApp Installers by philipqueen in https://github.com/freemocap/freemocap/pull/615
* Minor: Fix message at beginning of Blender Export by philipqueen in https://github.com/freemocap/freemocap/pull/599
* Add issue templates for bugs and feature requests by philipqueen in https://github.com/freemocap/freemocap/pull/598
* Add manual instructions to OpenCV conflict dialog by philipqueen in https://github.com/freemocap/freemocap/pull/586
* Allow PySide 6.7 in pyproject by philipqueen in https://github.com/freemocap/freemocap/pull/611
* Pydantic 2 Upgrade by philipqueen in https://github.com/freemocap/freemocap/pull/588
* Support 3.12 by philipqueen in https://github.com/freemocap/freemocap/pull/609
* Patch: Update Skellyviewer when processing finishes by philipqueen in https://github.com/freemocap/freemocap/pull/621


**Full Changelog**: https://github.com/freemocap/freemocap/compare/v1.2.2...v1.3.0

___
Attached Files:

- `freemocap_test_data_processed_with_freemocap_v1.3.0.zip` - A zipped copy of the `freemocap_test_data` recording processed with `freemocap_v1.3.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.

1.4.7

1.4.0

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.

1.3.0

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 below.


New `minor` version bump (i.e. the middle number increased, `SemVar` for fmc-core), the most exciting part of which is the fixes and improvements to the standard Blender output - continuing the process of integrating ajc27's great work into the core FreeMoCap software

Here is a link to relevant release on the `freemocap_blender_addon` repo (v2024.07.1022 - `CalVer` for the sub-skellies)

This release includes a `.zip` you can use to install as Blender addon, and a sample output based on the standard `freemocap_test_data`

1.2.0

**Highlights**
- **`freemocap_data` folder is now configurable:** You can set any folder location to use as your freemocap_data folder, and it will be remembered across sessions
- **Blender executable path is remembered across sessions:** Once you set a Blender executable path, it will now be remembered across sessions. If the automatic finder doesn't work, you will only need to manually find the path once, instead of having to reset it every session.
- **Deprecated legacy Blender export methods:** We have deprecated the "alpha megascript" blender methods, so the "ajc27_freemocap_blender_addon" is now the only option.
- **Enable Rigify automatically:** Now rigify is enabled automatically during the Blender export, removing a confusing barrier for first time users.
- **Improved sample data calibration:** We have updated the calibration file for both the sample and test data, so the output is higher quality.
- **Expose YOLO crop parameters:** Users can now set parameters for the YOLO crop preprocessing step, allowing for finer grained control of preprocessing.


**Full Changelog**
* Add YOLO Crop Parameters to Parameter Tree by philipqueen in https://github.com/freemocap/freemocap/pull/567
* Patch: Fix link in welcome screen by philipqueen in https://github.com/freemocap/freemocap/pull/568
* get rid of blender 4 exclusion by aaroncherian in https://github.com/freemocap/freemocap/pull/566
* Catch blender errors by philipqueen in https://github.com/freemocap/freemocap/pull/569
* removing estimate segment lengths by aaroncherian in https://github.com/freemocap/freemocap/pull/571
* Aaron/remove legacy blender code by aaroncherian in https://github.com/freemocap/freemocap/pull/572
* Updating status checker by philipqueen in https://github.com/freemocap/freemocap/pull/574
* Update sample and test data by philipqueen in https://github.com/freemocap/freemocap/pull/576
* User Settable Freemocap_data Path by philipqueen in https://github.com/freemocap/freemocap/pull/562
* Update Subrepos by philipqueen in https://github.com/freemocap/freemocap/pull/570
* Patch: check for OSerror when accessing drives by philipqueen in https://github.com/freemocap/freemocap/pull/582
* Add Charuco Board SVG to Assets by philipqueen in https://github.com/freemocap/freemocap/pull/583


[**Detailed Changelog**: https://github.com/freemocap/freemocap/compare/v1.1.1...v1.2.0](https://github.com/freemocap/freemocap/compare/v1.1.1...v1.2.0)

**Updating with Pip**
To update the installation with pip, run `pip install freemocap --upgrade`.

**Installing with Dedicated Installer**
- We are trying out [PyApp](https://docs.pyapp.info/en/latest/) as a method to create a non-CLI based installer
- Please note that this is our first time bundling installers, so there will likely be issues when trying to install and run them. You can always download FreeMoCap from PyPI following our [installation instructions](https://freemocap.github.io/documentation/installation.html). Some general and platform-specific notes about the installers are listed below:

‼️General Notes Before Using the Installer Executable:
- This is not an endgame solution, but it should be functional enough for the time being
- The first time you open the [PyApp](executable, it will install the necessary environment to run FreeMoCap.
- This means that **an internet connection is required the first time you open FreeMoCap with the executable**, but from then on, you can run it without internet connection.
- Please note that the installation process will require **roughly 3GB of available space**
- NOTE: This will take roughly 5-10 mins to install with no indication of installation. Please wait patiently :)
- As the installers are still experimental they will likely be flagged by your OS security settings

Platform-Specific Notes:

- **Windows:**
The FreeMoCap installers do not work on Windows 11 yet. We're currently working towards getting the software approved by Windows as virus free.

- **Mac:**
The single installer should work on both Intel and Apple Silicon Macs.
To run the app, you will need to open the zip file and you will see the app, which you can drag to the Applications folder. The first time you open the app, it will tell you it is from an unidentified developer and ask if you would like to move it to the trash. Close out of that window, right click the app, click `Open`, and choose to open the file. Once you have done this once, you can open the app as normal in the future. For more information, see the [official Apple documentation](https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unidentified-developer-mh40616/mac).

Deleting, Updating, and Restoring the Installer

The installer has a handful of management command that can be run in a terminal by using the path to the executable as the start of the command (referred to below as `{EXECUTABLE_PATH}`). On Mac, you need to add `/Contents/MacOS/freemocap_app` to the `freemocap.app` path to get the below commands to work.

To delete the installed version of FreeMoCap, you can run `{EXECUTABLE_PATH} self remove`. This will delete all of the data associated with the executable (but not your `freemocap_data` folder), and then you can manually delete the executable or app.

To update the installed version of FreeMoCap, you can run `{EXECUTABLE_PATH} self update`. This will update to the latest release of FreeMoCap.

If you have installed FreeMoCap through the installer but it will not successfully run, something may have happened during the installation process. You can try running `{EXECUTABLE_PATH} self restore`, which will delete the associated installation files and reinstall them. Ensure you give enough time for the installer to fully download when restoring.

1.1.0

**Processing Pipeline Updates**
- **YOLO Cropping**: We've integrated a new pre-processing feature that utilizes YOLO cropping to significantly reduce false positives during tracking, especially enhancing the performance when using wide-angle cameras. See [YOLO Cropping](https://freemocap.github.io/documentation/yolo-cropping.html) in our docs for more info.

- **Reprojection Error Filtering**: We've added new post-processing step to filter and reprocess points with significant reprojection error. See [Reprojection Error Filtering](https://freemocap.github.io/documentation/reprojection-filtering.html) in our docs for more info.

- **More Multiprocessing Control**: Previously, the multiprocessing feature (i.e. how many videos you're processing simultaneously) automatically started a process for each video in a recording, which was essentially an all-or-nothing approach. This default setting limited users with less powerful hardware from leveraging multiprocessing. We've introduced a customizable option that enables users to specify the exact number of processes they want to use when processing a recording - which should allow more users to take advantage of it. See [Multiprocessing](https://freemocap.github.io/documentation/multiprocessing.html) in our docs for more info.

- **GUI Updates**: We've improved progress updates in the GUI, so it should be more apparent when processes are running. We've also updated our error handling and reporting throughout the program.

**New Installation Methods**
- We are trying out [PyApp](https://docs.pyapp.info/en/latest/) as a method to create a non-CLI based installer
- Please note that this is our first time bundling installers, so there will likely be issues when trying to install and run them. You can always download FreeMoCap from PyPI following our [installation instructions](https://freemocap.github.io/documentation/installation.html). Some general and platform-specific notes about the installers are listed below:

‼️General Notes Before Using the Installer Executable:
- This is and endgame solution, but it should be functional enough for the time being
- The first time you open the [PyApp](executable, it will install the necessary environment to run FreeMoCap.
- This means that **an internet connection is required the first time you open FreeMoCap with the executable**, but from then on, you can run it without internet connection.
- Please note that the installation process will require **roughly 3GB of available space**
- NOTE: This will take roughly 5-10 mins to install with no indication of installation. Please wait patiently :)
- As the installers are still experimental they will likely be flagged by your OS security settings

Platform-Specific Notes:

- **Windows:**
The FreeMoCap installers do not work on Windows 11 yet. We're currently working towards getting the software approved by Windows as virus free, but it will take some time.

- **Mac:**
The single installer should work on both Intel and Apple Silicon Macs.
To run the app, you will need to open the zip file and you will see the app, which you can drag to the Applications folder. The first time you open the app, it will tell you it is from an unidentified developer and ask if you would like to move it to the trash. Close out of that window, right click the app, click `Open`, and choose to open the file. Once you have done this once, you can open the app as normal in the future. For more information, see the [official Apple documentation](https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unidentified-developer-mh40616/mac).

Deleting your FreeMoCap download, if necessary
To delete a version of FreeMoCap downloaded through an installer, you must delete both the executable/app file, and the PyApp file found in the path below. You can either delete the entire `freemocap` folder, or specific versions inside the folder.

| Platform | Path |
| ---- | ---- |
| macOS | `~/Library/Application Support/pyapp` |
| Windows | `%USERPROFILE%\AppData\Local\pyapp` |
| Unix | `$XDG_DATA_HOME/pyapp` (the [XDG_DATA_HOME](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html#variables) environment variable default is `~/.local/share`) |

Page 1 of 2

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.