sports2d 0.7.2__py3-none-any.whl → 0.8.0__py3-none-any.whl

Sports2D/Demo/Config_demo.toml

@@ -11,15 +11,18 @@
 # Sports2D.process('Config_demo.toml')
 
 
-[project]
+[base]
 video_input = 'demo.mp4'   # 'webcam' or '<video_path.ext>', or ['video1_path.mp4', 'video2_path.avi>', ...]
                            # On Windows, replace '\' with '/'
                            # Beware that images won't be saved if paths contain non ASCII characters.
-px_to_m_from_person_id = 2    # Person to use for pixels to meters conversion (not used if a calibration file is provided)
-px_to_m_person_height = 1.65  # Height of the reference person in meters (for pixels -> meters conversion). 
-visible_side = ['front', 'none', 'auto']  # Choose visible side among ['right', 'left', 'front', 'back', 'auto', 'none']. String or list of strings.
+
+nb_persons_to_detect = 'all'   # int or 'all' # Limiting or not the number of persons to be analyzed
+person_ordering_method = 'highest_likelihood' # 'on_click', 'highest_likelihood', 'greatest_displacement', 'least_displacement', 'first_detected', or 'last_detected'
+first_person_height = 1.65  # Height of the reference person in meters (for pixels -> meters conversion: not used if a calibration file is provided)
+visible_side = ['auto', 'front', 'none']  # Choose visible side among ['right', 'left', 'front', 'back', 'auto', 'none']. String or list of strings.
                   # if 'auto', will be either 'left', 'right', or 'front' depending on the direction of the motion
                   # if 'none', coordinates will be left in 2D rather than 3D
+
 load_trc_px = ''  # If you do not want to recalculate pose, load it from a trc file (in px, not in m)
 compare = false   # Not implemented yet
 
@@ -32,10 +35,6 @@ video_dir = ''    # If empty, video dir is current dir
 webcam_id = 0 # your webcam id (0 is default)
 input_size = [1280, 720] # [W, H]. Lower resolution will be faster but less precise.
 
-
-[process]
-multiperson = true   # Saving the motions of all the persons detected and tracked in the video. 
-                     # If false, the person saved will be the one with the highest sum of keypoint scores over the video
 show_realtime_results = true
 save_vid = true
 save_img = true
@@ -89,7 +88,7 @@ det_frequency = 4       # Run person detection only every N frames, and inbetwee
                         # Equal to or greater than 1, can be as high as you want in simple uncrowded cases. Much faster, but might be less accurate. 
 device = 'auto' # 'auto', 'CPU', 'CUDA', 'MPS', 'ROCM'
 backend = 'auto' # 'auto', 'openvino', 'onnxruntime', 'opencv'
-tracking_mode = 'sports2d' # 'sports2d' or 'deepsort'. 'deepsort' is slower but more robust in difficult configurations
+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}"""
                   # 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`
@@ -107,7 +106,7 @@ to_meters = true
 make_c3d = true
 save_calib = true # Coming soon!
 
-# If conversion from px_to_m_person_height
+# If conversion from first_person_height
 floor_angle = 'auto'    # 'auto' or a value in degrees, eg 2.3. If 'auto', estimated from the line formed by the toes when they are on the ground (where speed = 0)
 xy_origin = ['auto']    # ['auto'] or [px_x,px_y]. N.B.: px_y points downwards. If ['auto'], direction estimated from the start to the end of the line formed by the toes when they are on the ground
 
@@ -151,10 +150,10 @@ filter_type = 'butterworth'   # butterworth, gaussian, LOESS, median
 
 
 [kinematics]
-do_ik = true # Do scaling and inverse kinematics?
-use_augmentation = true  # true or false (lowercase) # Set to true if you want to use the model with augmented markers
+do_ik = false # Do scaling and inverse kinematics?
+use_augmentation = false  # true or false (lowercase) # Set to true if you want to use the model with augmented markers
 use_contacts_muscles = true # true or false (lowercase) # If true, contact spheres and muscles are added to the model
-participant_mass = [67.0, 55.0] # kg # defaults to 70 if not provided. No influence on kinematics (motion), only on kinetics (forces)
+participant_mass = [55.0, 67.0] # kg # defaults to 70 if not provided. No influence on kinematics (motion), only on kinetics (forces)
 right_left_symmetry = true # true or false (lowercase) # Set to false only if you have good reasons to think the participant is not symmetrical (e.g. prosthetic limb)
 
 # Choosing best frames to scale the model

Sports2D/Sports2D.py

@@ -29,7 +29,7 @@
         sports2d --video_input webcam
     - Run with custom parameters (all non specified are set to default): 
         sports2d --show_plots False --time_range 0 2.1 --result_dir path_to_result_dir
-        sports2d --multiperson false --mode lightweight --det_frequency 50
+        sports2d --person_detection_method highest_likelihood --mode lightweight --det_frequency 50
     - Run with a toml configuration file: 
         sports2d --config path_to_config.toml
    
@@ -109,6 +109,7 @@
 
 
 ## INIT
+from importlib.metadata import version
 import argparse
 import toml
 from datetime import datetime
@@ -121,18 +122,17 @@ from Sports2D import Sports2D
 
 
 ## CONSTANTS
-DEFAULT_CONFIG =   {'project': {'video_input': ['demo.mp4'],
-                                'px_to_m_from_person_id': 2,
-                                'px_to_m_person_height': 1.65,
-                                'visible_side': ['front', 'none', 'auto'],
+DEFAULT_CONFIG =   {'base': {'video_input': ['demo.mp4'],
+                                'nb_persons_to_detect': 'all',
+                                'person_ordering_method': 'highest_likelihood',
+                                'first_person_height': 1.65,
+                                'visible_side': ['auto', 'front', 'none'],
                                 'load_trc_px': '',
                                 'compare': False,
                                 'time_range': [],
                                 'video_dir': '',
                                 'webcam_id': 0,
-                                'input_size': [1280, 720]
-                                },
-                    'process': {'multiperson': True,
+                                'input_size': [1280, 720],
                                 'show_realtime_results': True,
                                 'save_vid': True,
                                 'save_img': True,
@@ -148,7 +148,7 @@ DEFAULT_CONFIG =   {'project': {'video_input': ['demo.mp4'],
                                 'device': 'auto',
                                 'backend': 'auto',
                                 'tracking_mode': 'sports2d',
-                                'deepsort_params': """{'max_age':30, 'n_init':3, 'nms_max_overlap':0.8, 'max_cosine_distance':0.3, 'nn_budget':200, 'max_iou_distance':0.8, 'embedder_gpu': True}""",
+                                'deepsort_params': """{'max_age':30, 'n_init':3, 'nms_max_overlap':0.8, 'max_cosine_distance':0.3, 'nn_budget':200, 'max_iou_distance':0.8, 'embedder_gpu': True, 'embedder':'torchreid'}""",
                                 'keypoint_likelihood_threshold': 0.3,
                                 'average_likelihood_threshold': 0.5,
                                 'keypoint_number_threshold': 0.3
@@ -206,7 +206,7 @@ DEFAULT_CONFIG =   {'project': {'video_input': ['demo.mp4'],
                     'kinematics':{'do_ik': False,
                                           'use_augmentation': False,
                                           'use_contacts_muscles': True,
-                                          'participant_mass': [67.0, 55.0], 
+                                          'participant_mass': [55.0, 67.0], 
                                           'right_left_symmetry': True,
                                           'default_height': 1.70,
                                           'remove_individual_scaling_setup': True,
@@ -223,8 +223,10 @@ DEFAULT_CONFIG =   {'project': {'video_input': ['demo.mp4'],
 
 CONFIG_HELP =   {'config': ["C", "path to a toml configuration file"],
                 'video_input': ["i", "webcam, or video_path.mp4, or video1_path.avi video2_path.mp4 ... Beware that images won't be saved if paths contain non ASCII characters"],
-                'px_to_m_person_height': ["H", "height of the person in meters. 1.70 if not specified"],
-                'visible_side': ["", "front, back, left, right, auto, or none. 'front none auto' if not specified. If 'auto', will be either left or right depending on the direction of the motion. If 'none', no IK for this person"],
+                'nb_persons_to_detect': ["n", "number of persons to detect. int or 'all'. 'all' if not specified"],
+                'person_ordering_method': ["", "'on_click', 'highest_likelihood', 'greatest_displacement', 'least_displacement', 'first_detected', or 'last_detected'. 'on_click' if not specified"],
+                'first_person_height': ["H", "height of the reference person in meters. 1.65 if not specified. Not used if a calibration file is provided"],
+                'visible_side': ["", "front, back, left, right, auto, or none. 'auto front none' if not specified. If 'auto', will be either left or right depending on the direction of the motion. If 'none', no IK for this person"],
                 'load_trc_px': ["", "load trc file to avaid running pose estimation again. false if not specified"],
                 'compare': ["", "visually compare motion with trc file. false if not specified"],
                 'webcam_id': ["w", "webcam ID. 0 if not specified"],
@@ -250,7 +252,6 @@ CONFIG_HELP =   {'config': ["C", "path to a toml configuration file"],
                 'device': ["", "Device for pose estimatino can be 'auto', 'openvino', 'onnxruntime', 'opencv'"],
                 'to_meters': ["M", "convert pixels to meters. true if not specified"],
                 'make_c3d': ["", "Convert trc to c3d file. true if not specified"],
-                'px_to_m_from_person_id': ["", "person ID to calibrate on. 0 if not specified"],
                 'floor_angle': ["", "angle of the floor. 'auto' if not specified"],
                 'xy_origin': ["", "origin of the xy plane. 'auto' if not specified"],
                 'calib_file': ["", "path to calibration file. '' if not specified, eg no calibration file"],
@@ -260,8 +261,7 @@ CONFIG_HELP =   {'config': ["C", "path to a toml configuration file"],
                 'use_contacts_muscles': ["", "Use model with contact spheres and muscles. false if not specified"],
                 'participant_mass': ["", "mass of the participant in kg or none. Defaults to 70 if not provided. No influence on kinematics (motion), only on kinetics (forces)"],
                 'close_to_zero_speed_m': ["","Sum for all keypoints: about 50 px/frame or 0.2 m/frame"], 
-                'multiperson': ["", "multiperson involves tracking: will be faster if set to false. true if not specified"],
-                'tracking_mode': ["", "sports2d or rtmlib. sports2d is generally much more accurate and comparable in speed. sports2d if not specified"],
+                'tracking_mode': ["", "'sports2d' or 'deepsort'. 'deepsort' is slower, harder to parametrize but can be more robust if correctly tuned"],
                 'deepsort_params': ["", 'Deepsort tracking parameters: """{dictionary between 3 double quotes}""". \n\
                                     Default: max_age:30, n_init:3, nms_max_overlap:0.8, max_cosine_distance:0.3, nn_budget:200, max_iou_distance:0.8, embedder_gpu: True\n\
                                     More information there: https://github.com/levan92/deep_sort_realtime/blob/master/deep_sort_realtime/deepsort_tracker.py#L51'],
@@ -269,6 +269,10 @@ CONFIG_HELP =   {'config': ["C", "path to a toml configuration file"],
                 'keypoint_likelihood_threshold': ["", "detected keypoints are not retained if likelihood is below this threshold. 0.3 if not specified"],
                 'average_likelihood_threshold': ["", "detected persons are not retained if average keypoint likelihood is below this threshold. 0.5 if not specified"],
                 'keypoint_number_threshold': ["", "detected persons are not retained if number of detected keypoints is below this threshold. 0.3 if not specified, i.e., i.e., 30 percent"],
+                'fastest_frames_to_remove_percent': ["", "Frames with high speed are considered as outliers. Defaults to 0.1"],
+                'close_to_zero_speed_px': ["", "Sum for all keypoints: about 50 px/frame or 0.2 m/frame. Defaults to 50"],
+                'large_hip_knee_angles': ["", "Hip and knee angles below this value are considered as imprecise. Defaults to 45"],
+                'trimmed_extrema_percent': ["", "Proportion of the most extreme segment values to remove before calculating their mean. Defaults to 50"],
                 'fontSize': ["", "font size for angle values. 0.3 if not specified"],
                 'flip_left_right': ["", "true or false. true to get consistent angles with people facing both left and right sides. Set it to false if you want timeseries to be continuous even when the participent switches their stance. true if not specified"],
                 'correct_segment_angles_with_floor_angle': ["", "true or false. If the camera is tilted, corrects segment angles as regards to the floor angle. Set to false is the floor is tilted instead. True if not specified"],
@@ -301,7 +305,7 @@ __author__ = "David Pagnon"
 __copyright__ = "Copyright 2023, Sports2D"
 __credits__ = ["David Pagnon"]
 __license__ = "BSD 3-Clause License"
-__version__ = "0.4.0"
+__version__ = version("sports2d")
 __maintainer__ = "David Pagnon"
 __email__ = "contact@david-pagnon.com"
 __status__ = "Development"
@@ -323,16 +327,16 @@ def base_params(config_dict):
     '''
 
     # video_dir and result_dir
-    video_dir = config_dict.get('project').get('video_dir')
+    video_dir = config_dict.get('base').get('video_dir')
     if video_dir == '': video_dir = Path.cwd()
     else: video_dir = Path(video_dir).resolve()
 
-    result_dir = config_dict.get('process').get('result_dir')
+    result_dir = config_dict.get('base').get('result_dir')
     if result_dir == '': result_dir = Path.cwd()
     else: result_dir = Path(result_dir).resolve()
 
     # video_files, frame_rates, time_ranges
-    video_input = config_dict.get('project').get('video_input')
+    video_input = config_dict.get('base').get('video_input')
     if video_input == "webcam" or video_input == ["webcam"]:
         video_files = ['webcam']  # No video files for webcam
         frame_rates = [None]  # No frame rate for webcam
@@ -358,7 +362,7 @@ def base_params(config_dict):
             video.release()
 
         # time_ranges
-        time_ranges = np.array(config_dict.get('project').get('time_range'))
+        time_ranges = np.array(config_dict.get('base').get('time_range'))
         # No time range provided
         if time_ranges.shape == (0,): 
             time_ranges = [None] * len(video_files)
@@ -393,7 +397,7 @@ def get_leaf_keys(config, prefix=''):
 
 def update_nested_dict(config, key_path, value):
     '''
-    Update a nested dictionary based on a key path string like 'process.multiperson'.
+    Update a nested dictionary based on a key path string like 'base.nb_persons_to_detect'.
     '''
 
     keys = key_path.split('.')
@@ -491,7 +495,7 @@ def main():
         sports2d --video_input webcam
     - Run with custom parameters (all non specified are set to default): 
         sports2d --show_plots False --time_range 0 2.1 --result_dir path_to_result_dir
-        sports2d --multiperson false --mode lightweight --det_frequency 50
+        sports2d --mode lightweight --det_frequency 50
     - Run with a toml configuration file: 
         sports2d --config path_to_config.toml
     '''
@@ -526,7 +530,7 @@ def main():
     else:
         new_config = DEFAULT_CONFIG.copy()
         if not args.video_input: 
-            new_config.get('project').update({'video_dir': Path(__file__).resolve().parent / 'Demo'})
+            new_config.get('base').update({'video_dir': Path(__file__).resolve().parent / 'Demo'})
 
     # Override dictionary with command-line arguments if provided
     leaf_keys = get_leaf_keys(new_config)

Sports2D/Utilities/__init__.py

@@ -2,6 +2,7 @@
 # -*- coding: utf-8 -*-
 
 import sys
+from importlib.metadata import version
 
-__version__ = "0.4.0"
+__version__ = version("sports2d")
 VERSION = __version__