sports2d 0.8.25__tar.gz → 0.8.27__tar.gz

sports2d-0.8.27/.github/workflows/sync_to_hf.yml.bak

@@ -0,0 +1,19 @@
+name: Sync to Hugging Face Space
+on:
+  push:
+    branches: [ main ]
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Push to Hugging Face Space
+        run: |
+          git clone https://${{ secrets.HUGGINGFACE_TOKEN }}@huggingface.co/spaces/DavidPagnon/sports2d
+          cd sports2d
+          git config --global user.name "DavidPagnon"
+          git config --global user.email "contact@david-pagnon.com"
+          cp -r ../Sports2D/* .
+          git add .
+          git commit -m "Sync from GitHub"
+          git push https://${{ secrets.HUGGINGFACE_TOKEN }}@huggingface.co/spaces/DavidPagnon/sports2d

{sports2d-0.8.25/sports2d.egg-info → sports2d-0.8.27}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sports2d
-Version: 0.8.25
+Version: 0.8.27
 Summary: Compute 2D human pose and angles from a video or a webcam.
 Author-email: David Pagnon <contact@david-pagnon.com>
 Maintainer-email: David Pagnon <contact@david-pagnon.com>
@@ -23,7 +23,7 @@ Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: imageio_ffmpeg
-Requires-Dist: Pose2Sim>=0.10.38
+Requires-Dist: Pose2Sim>=0.10.40
 Dynamic: license-file
 
 
@@ -40,6 +40,8 @@ Dynamic: license-file
 [![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
 \
 [![Discord](https://img.shields.io/discord/1183750225471492206?logo=Discord&label=Discord%20community)](https://discord.com/invite/4mXUdSFjmt)
+[![Hugging Face Space](https://img.shields.io/badge/HuggingFace-Sports2D-yellow?logo=huggingface)](https://huggingface.co/spaces/DavidPagnon/sports2d)
+
 
 <!-- [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://bit.ly/Sports2D_Colab)-->
 
@@ -52,7 +54,7 @@ Dynamic: license-file
 </br>
 
 > **`Announcements:`**
-> - Compensate for floor angle, floor height, depth perspective effects, generate a calibration file **New in v0.9!** 
+> - Compensate for floor angle, floor height, depth perspective effects, generate a calibration file **New in v0.8.25!** 
 > - Select only the persons you want to analyze **New in v0.8!** 
 > - MarkerAugmentation and Inverse Kinematics for accurate 3D motion with OpenSim. **New in v0.7!** 
 > - Any detector and pose estimation model can be used. **New in v0.6!**
@@ -80,7 +82,7 @@ https://github.com/user-attachments/assets/2ce62012-f28c-4e23-b3b8-f68931bacb77
 <!-- https://github.com/user-attachments/assets/1c6e2d6b-d0cf-4165-864e-d9f01c0b8a0e -->
 
 `Warning:` Angle estimation is only as good as the pose estimation algorithm, i.e., it is not perfect.\
-`Warning:` Results are acceptable only if the persons move in the 2D plane (sagittal or frontal plane). The persons need to be filmed as parallel as possible to the motion plane.\
+`Warning:` Results are acceptable only if the persons move in the 2D plane (sagittal or frontal). The persons need to be filmed as parallel as possible to the motion plane.\
 If you need 3D research-grade markerless joint kinematics, consider using several cameras with **[Pose2Sim](https://github.com/perfanalytics/pose2sim)**.
 
 <!--`Warning:` Google Colab does not follow the European GDPR requirements regarding data privacy. [Install locally](#installation) if this matters.-->
@@ -90,36 +92,46 @@ If you need 3D research-grade markerless joint kinematics, consider using severa
 
 ## Contents
 1. [Installation and Demonstration](#installation-and-demonstration)
-   1. [Installation](#installation)
+   1. [Test it on Hugging face](#test-it-on-hugging-face)
+   1. [Local installation](#local-installation)
       1. [Quick install](#quick-install)
       2. [Full install](#full-install)
    2. [Demonstration](#demonstration)
       1. [Run the demo](#run-the-demo)
       2. [Visualize in OpenSim](#visualize-in-opensim)
       3. [Visualize in Blender](#visualize-in-blender)
-   3. [Play with the parameters](#play-with-the-parameters)
-      1. [Run on a custom video or on a webcam](#run-on-a-custom-video-or-on-a-webcam)
-      2. [Run for a specific time range](#run-for-a-specific-time-range)
-      3. [Select the persons you are interested in](#select-the-persons-you-are-interested-in)
-      4. [Get coordinates in meters](#get-coordinates-in-meters)
-      5. [Run inverse kinematics](#run-inverse-kinematics)
-      6. [Run on several videos at once](#run-on-several-videos-at-once)
-      7. [Use the configuration file or run within Python](#use-the-configuration-file-or-run-within-python)
-      8. [Get the angles the way you want](#get-the-angles-the-way-you-want)
-      9. [Customize your output](#customize-your-output)
-      10. [Use a custom pose estimation model](#use-a-custom-pose-estimation-model)
-      11. [All the parameters](#all-the-parameters)
-2. [Go further](#go-further)
+2. [Play with the parameters](#play-with-the-parameters)
+   1. [Run on a custom video or on a webcam](#run-on-a-custom-video-or-on-a-webcam)
+   2. [Run for a specific time range](#run-for-a-specific-time-range)
+   3. [Select the persons you are interested in](#select-the-persons-you-are-interested-in)
+   4. [Get coordinates in meters](#get-coordinates-in-meters)
+   5. [Run inverse kinematics](#run-inverse-kinematics)
+   6. [Run on several videos at once](#run-on-several-videos-at-once)
+   7. [Use the configuration file or run within Python](#use-the-configuration-file-or-run-within-python)
+   8. [Get the angles the way you want](#get-the-angles-the-way-you-want)
+   9. [Customize your output](#customize-your-output)
+   10. [Use a custom pose estimation model](#use-a-custom-pose-estimation-model)
+   11. [All the parameters](#all-the-parameters)
+3. [Go further](#go-further)
    1. [Too slow for you?](#too-slow-for-you)
    3. [Run inverse kinematics](#run-inverse-kinematics)
    4. [How it works](#how-it-works)
-3. [How to cite and how to contribute](#how-to-cite-and-how-to-contribute)
+4. [How to cite and how to contribute](#how-to-cite-and-how-to-contribute)
 
 <br>
 
 ## Installation and Demonstration
 
-### Installation
+
+### Test it on Hugging face
+
+Test an online, limited version [on Hugging Face](https://huggingface.co/spaces/DavidPagnon/sports2d): [![Hugging Face Space](https://img.shields.io/badge/HuggingFace-Sports2D-yellow?logo=huggingface)](https://huggingface.co/spaces/DavidPagnon/sports2d)
+
+<img src="Content/huggingface_demo.png" width="760">
+
+
+
+### Local installation
 
 <!--- OPTION 0: **Use Colab** \
   User-friendly (but full) version, also works on a phone or a tablet.\
@@ -424,7 +436,7 @@ sports2d --video_input demo.mp4 other_video.mp4 --time_range 1.2 2.7 0 3.5
   sports2d --calculate_angles false
   ```
 - Flip angles when the person faces the other side.\
-  **N.B.:** *We consider that the person looks to the right if their toe keypoint is to the right of their heel. This is not always true when the person is sprinting, especially in the swing phase. Set it to false if you want timeseries to be continuous even when the participant switches their stance.*
+  **N.B.: Set to false when sprinting.** *We consider that each limb "looks" to the right if the toe keypoint is to the right of the heel one. This is not always true, particularly during the swing phase of sprinting. Set it to false if you want timeseries to be continuous even when the participant switches their stance.*
   ```cmd
   sports2d --flip_left_right true # Default
   ```
@@ -525,6 +537,7 @@ sports2d --help
 'calib_file': ["", "path to calibration file. '' if not specified, eg no calibration file"],
 'save_calib': ["", "save calibration file. true if not specified"],
 'feet_on_floor': ["", "offset marker augmentation results so that feet are at floor level. true if not specified"],
+'distortions': ["", "camera distortion coefficients [k1, k2, p1, p2, k3] or 'from_calib'. [0.0, 0.0, 0.0, 0.0, 0.0] if not specified"],
 'use_simple_model': ["", "IK 10+ times faster, but no muscles or flexible spine, no patella. false if not specified"],
 'close_to_zero_speed_m': ["","Sum for all keypoints: about 50 px/frame or 0.2 m/frame"], 
 'tracking_mode': ["", "'sports2d' or 'deepsort'. 'deepsort' is slower, harder to parametrize but can be more robust if correctly tuned"],

{sports2d-0.8.25 → sports2d-0.8.27}/README.md

@@ -12,6 +12,8 @@
 [![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
 \
 [![Discord](https://img.shields.io/discord/1183750225471492206?logo=Discord&label=Discord%20community)](https://discord.com/invite/4mXUdSFjmt)
+[![Hugging Face Space](https://img.shields.io/badge/HuggingFace-Sports2D-yellow?logo=huggingface)](https://huggingface.co/spaces/DavidPagnon/sports2d)
+
 
 <!-- [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://bit.ly/Sports2D_Colab)-->
 
@@ -24,7 +26,7 @@
 </br>
 
 > **`Announcements:`**
-> - Compensate for floor angle, floor height, depth perspective effects, generate a calibration file **New in v0.9!** 
+> - Compensate for floor angle, floor height, depth perspective effects, generate a calibration file **New in v0.8.25!** 
 > - Select only the persons you want to analyze **New in v0.8!** 
 > - MarkerAugmentation and Inverse Kinematics for accurate 3D motion with OpenSim. **New in v0.7!** 
 > - Any detector and pose estimation model can be used. **New in v0.6!**
@@ -52,7 +54,7 @@ https://github.com/user-attachments/assets/2ce62012-f28c-4e23-b3b8-f68931bacb77
 <!-- https://github.com/user-attachments/assets/1c6e2d6b-d0cf-4165-864e-d9f01c0b8a0e -->
 
 `Warning:` Angle estimation is only as good as the pose estimation algorithm, i.e., it is not perfect.\
-`Warning:` Results are acceptable only if the persons move in the 2D plane (sagittal or frontal plane). The persons need to be filmed as parallel as possible to the motion plane.\
+`Warning:` Results are acceptable only if the persons move in the 2D plane (sagittal or frontal). The persons need to be filmed as parallel as possible to the motion plane.\
 If you need 3D research-grade markerless joint kinematics, consider using several cameras with **[Pose2Sim](https://github.com/perfanalytics/pose2sim)**.
 
 <!--`Warning:` Google Colab does not follow the European GDPR requirements regarding data privacy. [Install locally](#installation) if this matters.-->
@@ -62,36 +64,46 @@ If you need 3D research-grade markerless joint kinematics, consider using severa
 
 ## Contents
 1. [Installation and Demonstration](#installation-and-demonstration)
-   1. [Installation](#installation)
+   1. [Test it on Hugging face](#test-it-on-hugging-face)
+   1. [Local installation](#local-installation)
       1. [Quick install](#quick-install)
       2. [Full install](#full-install)
    2. [Demonstration](#demonstration)
       1. [Run the demo](#run-the-demo)
       2. [Visualize in OpenSim](#visualize-in-opensim)
       3. [Visualize in Blender](#visualize-in-blender)
-   3. [Play with the parameters](#play-with-the-parameters)
-      1. [Run on a custom video or on a webcam](#run-on-a-custom-video-or-on-a-webcam)
-      2. [Run for a specific time range](#run-for-a-specific-time-range)
-      3. [Select the persons you are interested in](#select-the-persons-you-are-interested-in)
-      4. [Get coordinates in meters](#get-coordinates-in-meters)
-      5. [Run inverse kinematics](#run-inverse-kinematics)
-      6. [Run on several videos at once](#run-on-several-videos-at-once)
-      7. [Use the configuration file or run within Python](#use-the-configuration-file-or-run-within-python)
-      8. [Get the angles the way you want](#get-the-angles-the-way-you-want)
-      9. [Customize your output](#customize-your-output)
-      10. [Use a custom pose estimation model](#use-a-custom-pose-estimation-model)
-      11. [All the parameters](#all-the-parameters)
-2. [Go further](#go-further)
+2. [Play with the parameters](#play-with-the-parameters)
+   1. [Run on a custom video or on a webcam](#run-on-a-custom-video-or-on-a-webcam)
+   2. [Run for a specific time range](#run-for-a-specific-time-range)
+   3. [Select the persons you are interested in](#select-the-persons-you-are-interested-in)
+   4. [Get coordinates in meters](#get-coordinates-in-meters)
+   5. [Run inverse kinematics](#run-inverse-kinematics)
+   6. [Run on several videos at once](#run-on-several-videos-at-once)
+   7. [Use the configuration file or run within Python](#use-the-configuration-file-or-run-within-python)
+   8. [Get the angles the way you want](#get-the-angles-the-way-you-want)
+   9. [Customize your output](#customize-your-output)
+   10. [Use a custom pose estimation model](#use-a-custom-pose-estimation-model)
+   11. [All the parameters](#all-the-parameters)
+3. [Go further](#go-further)
    1. [Too slow for you?](#too-slow-for-you)
    3. [Run inverse kinematics](#run-inverse-kinematics)
    4. [How it works](#how-it-works)
-3. [How to cite and how to contribute](#how-to-cite-and-how-to-contribute)
+4. [How to cite and how to contribute](#how-to-cite-and-how-to-contribute)
 
 <br>
 
 ## Installation and Demonstration
 
-### Installation
+
+### Test it on Hugging face
+
+Test an online, limited version [on Hugging Face](https://huggingface.co/spaces/DavidPagnon/sports2d): [![Hugging Face Space](https://img.shields.io/badge/HuggingFace-Sports2D-yellow?logo=huggingface)](https://huggingface.co/spaces/DavidPagnon/sports2d)
+
+<img src="Content/huggingface_demo.png" width="760">
+
+
+
+### Local installation
 
 <!--- OPTION 0: **Use Colab** \
   User-friendly (but full) version, also works on a phone or a tablet.\
@@ -396,7 +408,7 @@ sports2d --video_input demo.mp4 other_video.mp4 --time_range 1.2 2.7 0 3.5
   sports2d --calculate_angles false
   ```
 - Flip angles when the person faces the other side.\
-  **N.B.:** *We consider that the person looks to the right if their toe keypoint is to the right of their heel. This is not always true when the person is sprinting, especially in the swing phase. Set it to false if you want timeseries to be continuous even when the participant switches their stance.*
+  **N.B.: Set to false when sprinting.** *We consider that each limb "looks" to the right if the toe keypoint is to the right of the heel one. This is not always true, particularly during the swing phase of sprinting. Set it to false if you want timeseries to be continuous even when the participant switches their stance.*
   ```cmd
   sports2d --flip_left_right true # Default
   ```
@@ -497,6 +509,7 @@ sports2d --help
 'calib_file': ["", "path to calibration file. '' if not specified, eg no calibration file"],
 'save_calib': ["", "save calibration file. true if not specified"],
 'feet_on_floor': ["", "offset marker augmentation results so that feet are at floor level. true if not specified"],
+'distortions': ["", "camera distortion coefficients [k1, k2, p1, p2, k3] or 'from_calib'. [0.0, 0.0, 0.0, 0.0, 0.0] if not specified"],
 'use_simple_model': ["", "IK 10+ times faster, but no muscles or flexible spine, no patella. false if not specified"],
 'close_to_zero_speed_m': ["","Sum for all keypoints: about 50 px/frame or 0.2 m/frame"], 
 'tracking_mode': ["", "'sports2d' or 'deepsort'. 'deepsort' is slower, harder to parametrize but can be more robust if correctly tuned"],

{sports2d-0.8.25 → sports2d-0.8.27}/Sports2D/Demo/Config_demo.toml

@@ -89,7 +89,7 @@ det_frequency = 4       # Run person detection only every N frames, and inbetwee
 device = 'auto' # 'auto', 'CPU', 'CUDA', 'MPS', 'ROCM'
 backend = 'auto' # 'auto', 'openvino', 'onnxruntime', 'opencv'
 tracking_mode = 'sports2d' # 'sports2d' or 'deepsort'. 'deepsort' is slower, harder to parametrize but can be more robust if correctly tuned
-# deepsort_params = """{'max_age':30, 'n_init':3, 'max_cosine_distance':0.3, 'max_iou_distance':0.8, 'embedder_gpu': True, embedder':'torchreid'}""" # """{dictionary between 3 double quotes}"""
+# deepsort_params = """{'max_age':30, 'n_init':3, 'max_cosine_distance':0.3, 'max_iou_distance':0.8, 'embedder_gpu': True, 'embedder':'torchreid'}""" # """{dictionary between 3 double quotes}"""
                   # More robust in crowded scenes but tricky to parametrize. More information there: https://github.com/levan92/deep_sort_realtime/blob/master/deep_sort_realtime/deepsort_tracker.py#L51
                   # Requires `pip install torch torchvision torchreid gdown tensorboard`
 
@@ -106,13 +106,16 @@ to_meters = true
 make_c3d = true
 save_calib = true
 
+# Compensate for camera horizon 
+floor_angle = 'auto' # float, 'from_kinematics', 'from_calib', or 'auto' # 'auto' is equivalent to 'from_kinematics', ie angle calculated from foot contacts. 'from_calib' calculates it from a toml calibration file. Use float to manually specify it in degrees
+xy_origin = ['auto'] # [px_x,px_y], or ['from kinematics'], ['from_calib'], or ['auto']. # BETWEEN BRACKETS! # ['auto'] is equivalent to ['from_kinematics'], ie origin estimated at first foot contact, direction is direction of motion. ['from_calib'] calculates it from a calibration file. Use [px_x,px_y] to manually specify it in pixels (px_y points downwards)
+
 # Compensate for perspective effects, which make the further limb look smaller. 1-2% coordinate error at 10 m, less if the camera is further away
 perspective_value = 10 # Either camera-to-person distance (m), or focal length (px), or field-of-view (degrees or radians), or '' if perspective_unit=='from_calib'
 perspective_unit = 'distance_m' # 'distance_m', 'f_px', 'fov_deg', 'fov_rad', or 'from_calib'
 
-# Compensate for camera horizon 
-floor_angle = 'auto' # float, 'from_kinematics', 'from_calib', or 'auto' # 'auto' is equivalent to 'from_kinematics', ie angle calculated from foot contacts. 'from_calib' calculates it from a toml calibration file. Use float to manually specify it in degrees
-xy_origin = ['auto'] # [px_x,px_y], or ['from kinematics'], ['from_calib'], or ['auto']. # BETWEEN BRACKETS! # ['auto'] is equivalent to ['from_kinematics'], ie origin estimated at first foot contact, direction is direction of motion. ['from_calib'] calculates it from a calibration file. Use [px_x,px_y] to manually specify it in pixels (px_y points downwards)
+# Optional distortion coefficients
+distortions = [0.0, 0.0, 0.0, 0.0, 0.0] # [k1, k2, p1, p2, k3] or 'from_calib' (not implemented yet)
 
 # Optional calibration file
 calib_file = ''      # Calibration file in the Pose2Sim toml format, or '' if not available
@@ -130,7 +133,7 @@ joint_angles = ['Right ankle', 'Left ankle', 'Right knee', 'Left knee', 'Right h
 segment_angles = ['Right foot', 'Left foot', 'Right shank', 'Left shank', 'Right thigh', 'Left thigh', 'Pelvis', 'Trunk', 'Shoulders', 'Head', 'Right arm', 'Left arm', 'Right forearm', 'Left forearm']
 
 # Processing parameters
-flip_left_right = true  # Same angles whether the participant faces left/right. Set it to false if you want timeseries to be continuous even when the participant switches their stance.
+flip_left_right = false  # Same angles whether the participant faces left/right. Set it to false if you want timeseries to be continuous even when the participant switches their stance.
 correct_segment_angles_with_floor_angle = true # If the camera is tilted, corrects segment angles as regards to the floor angle. Set to false if it is the floor which is actually tilted
 
 
@@ -212,7 +215,7 @@ use_custom_logging = false # if integrated in an API that already has logging
 # 
 # Check your model hierarchy with:  for pre, _, node in RenderTree(model): 
 #                                      print(f'{pre}{node.name} id={node.id}')
-[pose.CUSTOM]
+[[pose.CUSTOM]]
 name = "Hip"
 id = 19
   [[pose.CUSTOM.children]]

{sports2d-0.8.25 → sports2d-0.8.27}/Sports2D/Sports2D.py

@@ -197,6 +197,7 @@ DEFAULT_CONFIG =   {'base': {'video_input': ['demo.mp4'],
                                 'save_calib': True,
                                 'perspective_value': 10.0,
                                 'perspective_unit': 'distance_m',
+                                'distortions': [0.0, 0.0, 0.0, 0.0, 0.0],
                                 'floor_angle': 'auto',
                                 'xy_origin': ['auto'],
                                 'calib_file': '',
@@ -311,6 +312,7 @@ CONFIG_HELP =   {'config': ["C", "path to a toml configuration file"],
                 'calib_file': ["", "path to calibration file. '' if not specified, eg no calibration file"],
                 'save_calib': ["", "save calibration file. true if not specified"],
                 'feet_on_floor': ["", "offset marker augmentation results so that feet are at floor level. true if not specified"],
+                'distortions': ["", "camera distortion coefficients [k1, k2, p1, p2, k3] or 'from_calib'. [0.0, 0.0, 0.0, 0.0, 0.0] if not specified"],
                 'use_simple_model': ["", "IK 10+ times faster, but no muscles or flexible spine, no patella. false if not specified"],
                 'close_to_zero_speed_m': ["","Sum for all keypoints: about 50 px/frame or 0.2 m/frame"], 
                 'tracking_mode': ["", "'sports2d' or 'deepsort'. 'deepsort' is slower, harder to parametrize but can be more robust if correctly tuned"],