simba-uw-tf-dev 4.6.6__py3-none-any.whl → 4.6.7__py3-none-any.whl

simba/sandbox/test_simba_install.py

@@ -1,41 +1,41 @@
-"""Test SimBA installation in conda environment"""
-import sys
-print(f"Python: {sys.executable}")
-
-try:
-    import simba
-    print("✓ SimBA imported successfully!")
-except Exception as e:
-    print(f"✗ Error importing SimBA: {e}")
-    import traceback
-    traceback.print_exc()
-    sys.exit(1)
-
-try:
-    from simba.data_processors.cuda.geometry import is_inside_rectangle
-    print("✓ CUDA geometry functions imported!")
-except Exception as e:
-    print(f"✗ Error importing CUDA functions: {e}")
-    import traceback
-    traceback.print_exc()
-    sys.exit(1)
-
-try:
-    import cupy as cp
-    import numpy as np
-    print(f"✓ CuPy {cp.__version__} available")
-    
-    # Quick test
-    test_points = np.array([[150, 150], [300, 300], [50, 50]], dtype=np.int32)
-    test_rect = np.array([[100, 100], [400, 400]], dtype=np.int32)
-    result = is_inside_rectangle(x=test_points, y=test_rect)
-    print(f"✓ CUDA function test passed: {result}")
-except Exception as e:
-    print(f"✗ Error testing CUDA: {e}")
-    import traceback
-    traceback.print_exc()
-    sys.exit(1)
-
-print("\n" + "="*50)
-print("All tests passed! SimBA is ready to use.")
-print("="*50)
+"""Test SimBA installation in conda environment"""
+import sys
+print(f"Python: {sys.executable}")
+
+try:
+    import simba
+    print("✓ SimBA imported successfully!")
+except Exception as e:
+    print(f"✗ Error importing SimBA: {e}")
+    import traceback
+    traceback.print_exc()
+    sys.exit(1)
+
+try:
+    from simba.data_processors.cuda.geometry import is_inside_rectangle
+    print("✓ CUDA geometry functions imported!")
+except Exception as e:
+    print(f"✗ Error importing CUDA functions: {e}")
+    import traceback
+    traceback.print_exc()
+    sys.exit(1)
+
+try:
+    import cupy as cp
+    import numpy as np
+    print(f"✓ CuPy {cp.__version__} available")
+    
+    # Quick test
+    test_points = np.array([[150, 150], [300, 300], [50, 50]], dtype=np.int32)
+    test_rect = np.array([[100, 100], [400, 400]], dtype=np.int32)
+    result = is_inside_rectangle(x=test_points, y=test_rect)
+    print(f"✓ CUDA function test passed: {result}")
+except Exception as e:
+    print(f"✗ Error testing CUDA: {e}")
+    import traceback
+    traceback.print_exc()
+    sys.exit(1)
+
+print("\n" + "="*50)
+print("All tests passed! SimBA is ready to use.")
+print("="*50)

simba/sandbox/test_static_directionality.py

@@ -1,26 +1,26 @@
-"""Test directionality_to_static_targets function"""
-import numpy as np
-from simba.data_processors.cuda.geometry import directionality_to_static_targets
-
-print("Testing directionality_to_static_targets...")
-
-left_ear = np.random.randint(0, 500, (10, 2)).astype(np.int32)
-right_ear = np.random.randint(0, 500, (10, 2)).astype(np.int32)
-nose = np.random.randint(0, 500, (10, 2)).astype(np.int32)
-target = np.array([250, 250], dtype=np.int32)
-
-print(f"target shape: {target.shape}, dtype: {target.dtype}")
-
-try:
-    result = directionality_to_static_targets(
-        left_ear=left_ear,
-        right_ear=right_ear,
-        nose=nose,
-        target=target
-    )
-    print(f"✓ SUCCESS! Result shape: {result.shape}")
-    print(f"Result:\n{result}")
-except Exception as e:
-    print(f"✗ Error: {e}")
-    import traceback
-    traceback.print_exc()
+"""Test directionality_to_static_targets function"""
+import numpy as np
+from simba.data_processors.cuda.geometry import directionality_to_static_targets
+
+print("Testing directionality_to_static_targets...")
+
+left_ear = np.random.randint(0, 500, (10, 2)).astype(np.int32)
+right_ear = np.random.randint(0, 500, (10, 2)).astype(np.int32)
+nose = np.random.randint(0, 500, (10, 2)).astype(np.int32)
+target = np.array([250, 250], dtype=np.int32)
+
+print(f"target shape: {target.shape}, dtype: {target.dtype}")
+
+try:
+    result = directionality_to_static_targets(
+        left_ear=left_ear,
+        right_ear=right_ear,
+        nose=nose,
+        target=target
+    )
+    print(f"✓ SUCCESS! Result shape: {result.shape}")
+    print(f"Result:\n{result}")
+except Exception as e:
+    print(f"✗ Error: {e}")
+    import traceback
+    traceback.print_exc()

simba/sandbox/test_static_directionality_2d.py

@@ -1,26 +1,26 @@
-"""Test directionality_to_static_targets with correct 1D target"""
-import numpy as np
-from simba.data_processors.cuda.geometry import directionality_to_static_targets
-
-print("Testing directionality_to_static_targets with 1D target (correct)...")
-
-left_ear = np.random.randint(0, 500, (100, 2)).astype(np.int32)
-right_ear = np.random.randint(0, 500, (100, 2)).astype(np.int32)
-nose = np.random.randint(0, 500, (100, 2)).astype(np.int32)
-target = np.array([250, 250], dtype=np.int32)  # 1D array for static target
-
-print(f"target shape: {target.shape}, dtype: {target.dtype}")
-
-try:
-    result = directionality_to_static_targets(
-        left_ear=left_ear,
-        right_ear=right_ear,
-        nose=nose,
-        target=target
-    )
-    print(f"✓ SUCCESS! Result shape: {result.shape}")
-    print(f"First 5 results:\n{result[:5]}")
-except Exception as e:
-    print(f"✗ Error: {e}")
-    import traceback
-    traceback.print_exc()
+"""Test directionality_to_static_targets with correct 1D target"""
+import numpy as np
+from simba.data_processors.cuda.geometry import directionality_to_static_targets
+
+print("Testing directionality_to_static_targets with 1D target (correct)...")
+
+left_ear = np.random.randint(0, 500, (100, 2)).astype(np.int32)
+right_ear = np.random.randint(0, 500, (100, 2)).astype(np.int32)
+nose = np.random.randint(0, 500, (100, 2)).astype(np.int32)
+target = np.array([250, 250], dtype=np.int32)  # 1D array for static target
+
+print(f"target shape: {target.shape}, dtype: {target.dtype}")
+
+try:
+    result = directionality_to_static_targets(
+        left_ear=left_ear,
+        right_ear=right_ear,
+        nose=nose,
+        target=target
+    )
+    print(f"✓ SUCCESS! Result shape: {result.shape}")
+    print(f"First 5 results:\n{result[:5]}")
+except Exception as e:
+    print(f"✗ Error: {e}")
+    import traceback
+    traceback.print_exc()

simba/sandbox/verify_env.py

@@ -1,42 +1,42 @@
-"""Verify CUDA environment is properly configured"""
-from numba import cuda
-import cupy as cp
-import numba
-
-print("="*60)
-print("CUDA Environment Verification")
-print("="*60)
-print(f"Numba version: {numba.__version__}")
-print(f"CuPy version: {cp.__version__}")
-print(f"CUDA available: {cuda.is_available()}")
-if cuda.is_available():
-    print(f"CUDA devices: {len(cuda.gpus)}")
-    for i, gpu in enumerate(cuda.gpus):
-        print(f"  GPU {i}: {gpu}")
-
-# Test the function
-print("\n" + "="*60)
-print("Testing directionality_to_nonstatic_target...")
-try:
-    from simba.data_processors.cuda.geometry import directionality_to_nonstatic_target
-    import numpy as np
-    
-    left_ear = np.random.randint(0, 500, (10, 2)).astype(np.int32)
-    right_ear = np.random.randint(0, 500, (10, 2)).astype(np.int32)
-    nose = np.random.randint(0, 500, (10, 2)).astype(np.int32)
-    target = np.random.randint(0, 500, (10, 2)).astype(np.int32)
-    
-    result = directionality_to_nonstatic_target(
-        left_ear=left_ear,
-        right_ear=right_ear,
-        nose=nose,
-        target=target
-    )
-    print(f"✓ Function works! Result shape: {result.shape}")
-except Exception as e:
-    print(f"✗ Error: {e}")
-    import traceback
-    traceback.print_exc()
-
-print("\n" + "="*60)
-print("Environment is ready!")
+"""Verify CUDA environment is properly configured"""
+from numba import cuda
+import cupy as cp
+import numba
+
+print("="*60)
+print("CUDA Environment Verification")
+print("="*60)
+print(f"Numba version: {numba.__version__}")
+print(f"CuPy version: {cp.__version__}")
+print(f"CUDA available: {cuda.is_available()}")
+if cuda.is_available():
+    print(f"CUDA devices: {len(cuda.gpus)}")
+    for i, gpu in enumerate(cuda.gpus):
+        print(f"  GPU {i}: {gpu}")
+
+# Test the function
+print("\n" + "="*60)
+print("Testing directionality_to_nonstatic_target...")
+try:
+    from simba.data_processors.cuda.geometry import directionality_to_nonstatic_target
+    import numpy as np
+    
+    left_ear = np.random.randint(0, 500, (10, 2)).astype(np.int32)
+    right_ear = np.random.randint(0, 500, (10, 2)).astype(np.int32)
+    nose = np.random.randint(0, 500, (10, 2)).astype(np.int32)
+    target = np.random.randint(0, 500, (10, 2)).astype(np.int32)
+    
+    result = directionality_to_nonstatic_target(
+        left_ear=left_ear,
+        right_ear=right_ear,
+        nose=nose,
+        target=target
+    )
+    print(f"✓ Function works! Result shape: {result.shape}")
+except Exception as e:
+    print(f"✗ Error: {e}")
+    import traceback
+    traceback.print_exc()
+
+print("\n" + "="*60)
+print("Environment is ready!")

simba/third_party_label_appenders/transform/coco_keypoints_to_yolo.py

@@ -54,15 +54,15 @@ class COCOKeypoints2Yolo:
     :return: None
 
     :example:
-    >>> runner = COCOKeypoints2Yolo(coco_path=r"D:\cvat_annotations\frames\coco_keypoints_1\s1\annotations\s1.json", img_dir=r"D:\cvat_annotations\frames\simon", save_dir=r"D:\cvat_annotations\frames\yolo_keypoints", clahe=True)
+    >>> runner = COCOKeypoints2Yolo(coco_path=r"D:/cvat_annotations/frames/coco_keypoints_1/s1/annotations/s1.json", img_dir=r"D:/cvat_annotations/frames/simon", save_dir=r"D:/cvat_annotations/frames/yolo_keypoints", clahe=True)
     >>> runner.run()
 
     :example II:
-    >>> runner = COCOKeypoints2Yolo(coco_path=r"D:\cvat_annotations\frames\coco_keypoints_1\merged.json", img_dir=r"D:\cvat_annotations\frames", save_dir=r"D:\cvat_annotations\frames\yolo", clahe=False)
+    >>> runner = COCOKeypoints2Yolo(coco_path=r"D:/cvat_annotations/frames/coco_keypoints_1/merged.json", img_dir=r"D:/cvat_annotations/frames", save_dir=r"D:/cvat_annotations/frames/yolo", clahe=False)
     >>> runner.run()
 
     :example III:
-    >>> runner = COCOKeypoints2Yolo(coco_path=r"E:\netholabs_videos\mosaics\subset\to_annotate\2d_mosaic_batch_1.json", img_dir=r"E:\netholabs_videos\mosaics\subset\to_annotate", save_dir=r"E:\netholabs_videos\mosaics\yolo_mdl", clahe=False)
+    >>> runner = COCOKeypoints2Yolo(coco_path=r"E:/netholabs_videos/mosaics/subset/to_annotate/2d_mosaic_batch_1.json", img_dir=r"E:/netholabs_videos/mosaics/subset/to_annotate", save_dir=r"E:/netholabs_videos/mosaics/yolo_mdl", clahe=False)
     >>> runner.run()
 
      :references:

simba/third_party_label_appenders/transform/coco_keypoints_to_yolo_bbox.py

@@ -58,11 +58,11 @@ class COCOKeypoints2YoloBbox:
     :return: None
 
     :example:
-    >>> runner = COCOKeypoints2Yolo(coco_path=r"D:\cvat_annotations\frames\coco_keypoints_1\s1\annotations\s1.json", img_dir=r"D:\cvat_annotations\frames\simon", save_dir=r"D:\cvat_annotations\frames\yolo_keypoints", clahe=True)
+    >>> runner = COCOKeypoints2YoloBbox(coco_path=r"D:/cvat_annotations/frames/coco_keypoints_1/s1/annotations/s1.json", img_dir=r"D:/cvat_annotations/frames/simon", save_dir=r"D:/cvat_annotations/frames/yolo_keypoints", clahe=True)
     >>> runner.run()
 
     :example II:
-    >>> runner = COCOKeypoints2Yolo(coco_path=r"D:\cvat_annotations\frames\coco_keypoints_1\merged.json", img_dir=r"D:\cvat_annotations\frames", save_dir=r"D:\cvat_annotations\frames\yolo", clahe=False)
+    >>> runner = COCOKeypoints2YoloBbox(coco_path=r"D:/cvat_annotations/frames/coco_keypoints_1/merged.json", img_dir=r"D:/cvat_annotations/frames", save_dir=r"D:/cvat_annotations/frames/yolo", clahe=False)
     >>> runner.run()
 
      :references:

simba/utils/custom_feature_extractor.py

@@ -30,7 +30,7 @@ class CustomFeatureExtractor(ConfigReader):
     4. Handle cases of multiple classes and missing configuration arguments.
     5. Invokes the feature extraction process if conditions are met.
 
-    .. notes::
+    .. note::
 
         `Tutorial <https://github.com/sgoldenlab/simba/blob/master/docs/extractFeatures.md>`_.
 

simba/utils/data.py

@@ -1785,8 +1785,8 @@ def fft_lowpass_filter(data: np.ndarray, cut_off: float = 0.1) -> np.ndarray:
 
     :example:
     >>> from simba.utils.read_write import read_df
-    >>> IN_PATH = r"C:\troubleshooting\RAT_NOR\project_folder\csv\outlier_corrected_movement_location\2022-06-20_NOB_DOT_4.csv"
-    >>> OUT_PATH = r"C:\troubleshooting\RAT_NOR\project_folder\csv\outlier_corrected_movement_location\2022-06-20_NOB_DOT_4_filtered.csv"
+    >>> IN_PATH = r"C:/troubleshooting/RAT_NOR/project_folder/csv/outlier_corrected_movement_location/2022-06-20_NOB_DOT_4.csv"
+    >>> OUT_PATH = r"C:/troubleshooting/RAT_NOR/project_folder/csv/outlier_corrected_movement_location/2022-06-20_NOB_DOT_4_filtered.csv"
     >>> df = read_df(file_path=IN_PATH)
     >>> data = df.values
     >>> x = fft_lowpass_filter(data=data, cut_off=0.1)

simba/utils/read_write.py

@@ -97,13 +97,20 @@ def read_df(file_path: Union[str, os.PathLike],
     .. note::
        For improved runtime, defaults to :external:py:meth:`pyarrow.csv.write_cs` if file type is ``csv``.
 
-    :parameter str file_path: Path to data file
-    :parameter str file_type: Type of data. OPTIONS: 'parquet', 'csv', 'pickle'.
-    :parameter Optional[bool]: If the input file has an initial index column. Default: True.
-    :parameter Optional[List[str]] remove_columns: If not None, then remove columns in lits.
-    :parameter Optional[List[str]] usecols: If not None, then keep columns in list.
-    :parameter bool check_multiindex: check file is multi-index headers. Default: False.
-    :parameter int multi_index_headers_to_keep: If reading multi-index file, and we want to keep one of the dropped multi-index levels as the header in the output file, specify the index of the multiindex hader as int.
+    .. csv-table::
+       :header: EXPECTED RUNTIMES
+       :file: ../../docs/tables/read_df.csv
+       :widths: 10, 45, 45
+       :align: center
+       :header-rows: 1
+
+    :param str file_path: Path to data file
+    :param str file_type: Type of data. OPTIONS: 'parquet', 'csv', 'pickle'.
+    :param Optional[bool]: If the input file has an initial index column. Default: True.
+    :param Optional[List[str]] remove_columns: If not None, then remove columns in lits.
+    :param Optional[List[str]] usecols: If not None, then keep columns in list.
+    :param bool check_multiindex: check file is multi-index headers. Default: False.
+    :param int multi_index_headers_to_keep: If reading multi-index file, and we want to keep one of the dropped multi-index levels as the header in the output file, specify the index of the multiindex hader as int.
     :return: Table data in pd.DataFrame format.
     :rtype: pd.DataFrame
 
@@ -207,11 +214,18 @@ def write_df(df: pd.DataFrame,
     .. note::
        For improved runtime, defaults to ``pyarrow.csv`` if file_type == ``csv``.
 
-    :parameter pd.DataFrame df: Pandas dataframe to save to disk.
-    :parameter str file_type: Type of data. OPTIONS: ``parquet``, ``csv``,  ``pickle``.
-    :parameter str save_path: Location where to store the data.
-    :parameter bool check_multiindex: check if input file is multi-index headers. Default: False.
-    :parameter bool verbose: Prints message on completion. Default: False.
+    .. csv-table::
+       :header: EXPECTED RUNTIMES
+       :file: ../../docs/tables/write_df.csv
+       :widths: 10, 45, 45
+       :align: center
+       :header-rows: 1
+
+    :param pd.DataFrame df: Pandas dataframe to save to disk.
+    :param str file_type: Type of data. OPTIONS: ``parquet``, ``csv``,  ``pickle``.
+    :param str save_path: Location where to store the data.
+    :param bool check_multiindex: check if input file is multi-index headers. Default: False.
+    :param bool verbose: Prints message on completion. Default: False.
 
     :example:
     >>> write_df(df=df, file_type='csv', save_path='project_folder/csv/input_csv/Video_1.csv')
@@ -1130,8 +1144,8 @@ def get_file_name_info_in_directory(directory: Union[str, os.PathLike], file_typ
     :return dict: All found files as values and file base names as keys.
 
     :example:
-    >>> get_file_name_info_in_directory(directory='C:\project_folder\csv\machine_results', file_type='csv')
-    >>> {'Video_1': 'C:\project_folder\csv\machine_results\Video_1'}
+    >>> get_file_name_info_in_directory(directory='C:/project_folder/csv/machine_results', file_type='csv')
+    >>> {'Video_1': 'C:/project_folder/csv/machine_results/Video_1'}
     """
 
     results = {}
@@ -2630,7 +2644,7 @@ def bento_file_reader(file_path: Union[str, os.PathLike],
     :rtype: Dict[str, pd.DataFrame]
 
     :example:
-    >>> bento_file_reader(file_path=r"C:\troubleshooting\bento_test\bento_files\20240812_crumpling3.annot")
+    >>> bento_file_reader(file_path=r"C:/troubleshooting/bento_test/bento_files/20240812_crumpling3.annot")
     """
 
     def _orient_columns_melt(df: pd.DataFrame) -> pd.DataFrame:
@@ -2953,7 +2967,7 @@ def labelme_to_dlc(labelme_dir: Union[str, os.PathLike],
     :return: None
 
     :example:
-    >>> labelme_dir = r'D:\ts_annotations'
+    >>> labelme_dir = r'D:/ts_annotations'
     >>> labelme_to_dlc(labelme_dir=labelme_dir)
     """
 
@@ -3597,8 +3611,8 @@ def osf_download(project_id: str, save_dir: Union[str, os.PathLike], storage: st
     :param bool overwrite: If True, overwrite existing files. If False, skip existing files (default: False).
 
     :example:
-    >>> osf_download(project_id="7fgwn", save_dir=r'E:\rgb_white_vs_black_imgs')
-    >>> osf_download(project_id="kym42", save_dir=r'E:\crim13_imgs', overwrite=True)
+    >>> osf_download(project_id="7fgwn", save_dir=r'E:/rgb_white_vs_black_imgs')
+    >>> osf_download(project_id="kym42", save_dir=r'E:/crim13_imgs', overwrite=True)
     """
 
     _ = get_pkg_version(pkg='osfclient', raise_error=True)

simba/utils/yolo.py

@@ -47,6 +47,9 @@ def fit_yolo(weights_path: Union[str, os.PathLike],
        `Download initial weights <https://huggingface.co/Ultralytics>`__.
        `Example model_yaml <https://github.com/sgoldenlab/simba/blob/master/misc/ex_yolo_model.yaml>`__.
 
+    .. seealso::
+       For the recommended wrapper class with parameter validation, see :class:`simba.model.yolo_fit.FitYolo`.
+
     :param initial_weights: Path to the pre-trained YOLO model weights (usually a `.pt` file). Example weights can be found [here](https://huggingface.co/Ultralytics).
     :param model_yaml: YAML file containing paths to the training, validation, and testing datasets and the object class mappings. Example YAML file can be found [here](https://github.com/sgoldenlab/simba/blob/master/misc/ex_yolo_model.yaml).
     :param save_path: Directory path where the trained model, logs, and results will be saved.
@@ -55,7 +58,7 @@ def fit_yolo(weights_path: Union[str, os.PathLike],
     :return: None. The trained model and associated training logs are saved in the specified `project_path`.
 
     :example:
-    >>> fit_yolo(initial_weights=r"C:\troubleshooting\coco_data\weights\yolov8n-obb.pt", data=r"C:\troubleshooting\coco_data\model.yaml", save_path=r"C:\troubleshooting\coco_data\mdl", batch=16)
+    >>> fit_yolo(initial_weights=r"C:/troubleshooting/coco_data/weights/yolov8n-obb.pt", data=r"C:/troubleshooting/coco_data/model.yaml", save_path=r"C:/troubleshooting/coco_data/mdl", batch=16)
     """
 
     if not _is_cuda_available()[0]:
@@ -83,6 +86,9 @@ def load_yolo_model(weights_path: Union[str, os.PathLike],
     """
     Load a YOLO model.
 
+    .. seealso::
+       For recommended wrapper classes that use this function, see :class:`simba.model.yolo_fit.FitYolo`, :class:`simba.model.yolo_inference.YoloInference`, :class:`simba.model.yolo_pose_inference.YOLOPoseInference`, :class:`simba.model.yolo_seg_inference.YOLOSegmentationInference`, and :class:`simba.model.yolo_pose_track_inference.YOLOPoseTrackInference`.
+
     :param Union[str, os.PathLike] weights_path: Path to model weights (.pt, .engine, etc).
     :param bool verbose: Whether to print loading info.
     :param Optional[str] format: Export format, one of VALID_FORMATS or None to skip export.
@@ -169,6 +175,9 @@ def yolo_predict(model: YOLO,
     """
     Produce YOLO predictions.
 
+    .. seealso::
+       For recommended wrapper classes that use this function, see :class:`simba.model.yolo_inference.YoloInference`, :class:`simba.model.yolo_pose_inference.YOLOPoseInference`, and :class:`simba.model.yolo_seg_inference.YOLOSegmentationInference`.
+
     :param Union[str, os.PathLike] model: Loaded ultralytics.YOLO model. Returned by :func:`~simba.bounding_box_tools.yolo.model.load_yolo_model`.
     :param Union[str, os.PathLike, np.ndarray] source: Path to video, video stream, directory, image, or image as loaded array.
     :param bool half: Whether to use half precision (FP16) for inference to speed up processing.

simba/video_processors/blob_tracking_executor.py

@@ -87,9 +87,9 @@ class BlobTrackingExecutor():
     :param bool center: If True, compute center coordinates. Default: True.
 
     :example:
-    >>> tracker = BlobTrackingExecutor(data=r"C:\troubleshooting\mitra\test\.temp\blob_definitions.pickle")
+    >>> tracker = BlobTrackingExecutor(data=r"C:/troubleshooting/mitra/test/.temp/blob_definitions.pickle")
     >>> tracker.run()
-    >>> tracker = BlobTrackingExecutor(data=r"C:\troubleshooting\mitra\test\.temp\blob_definitions.pickle", batch_size=5000)
+    >>> tracker = BlobTrackingExecutor(data=r"C:/troubleshooting/mitra/test/.temp/blob_definitions.pickle", batch_size=5000)
     >>> tracker.run()
     """
 

simba/video_processors/clahe_ui.py

@@ -29,7 +29,7 @@ def interactive_clahe_ui(data: Union[str, os.PathLike]) -> Tuple[float, int]:
     :return Tuple[float, int]: Tuple containing the chosen clip limit and tile size.
 
     :example:
-    >>> video = cv2.imread(r"D:\EPM\sample_2\video_1.mp4")
+    >>> video = cv2.imread(r"D:/EPM/sample_2/video_1.mp4")
     >>> interactive_clahe_ui(data=video)
     """
     global original_img, font_size, x_spacer, y_spacer, txt

simba/video_processors/egocentric_video_rotator.py

@@ -94,9 +94,9 @@ class EgocentricVideoRotator():
     :param Optional[Union[str, os.PathLike]] save_path: The location where to store the rotated video. If None, saves the video as the same dir as the input video with the `_rotated` suffix.
 
     :example:
-    >>> DATA_PATH = "C:\501_MA142_Gi_Saline_0513.csv"
-    >>> VIDEO_PATH = "C:\501_MA142_Gi_Saline_0513.mp4"
-    >>> SAVE_PATH = "C:\501_MA142_Gi_Saline_0513_rotated.mp4"
+    >>> DATA_PATH = "C:/501_MA142_Gi_Saline_0513.csv"
+    >>> VIDEO_PATH = "C:/501_MA142_Gi_Saline_0513.mp4"
+    >>> SAVE_PATH = "C:/501_MA142_Gi_Saline_0513_rotated.mp4"
     >>> ANCHOR_LOC = np.array([250, 250])
 
     >>> df = read_df(file_path=DATA_PATH, file_type='csv')

simba/video_processors/multi_cropper.py

@@ -49,7 +49,7 @@ class MultiCropper(object):
 
 
     :example:
-    >>> cropper = MultiCropper(file_type='mp4', input_folder=r'C:\troubleshooting\mitra\test', output_folder=r'C:\troubleshooting\mitra\test\cropped', crop_cnt=2, gpu=True)
+    >>> cropper = MultiCropper(file_type='mp4', input_folder=r'C:/troubleshooting/mitra/test', output_folder=r'C:/troubleshooting/mitra/test/cropped', crop_cnt=2, gpu=True)
     >>> cropper.run()
     """
 

simba/video_processors/video_processing.py

@@ -676,7 +676,7 @@ def change_single_video_fps(file_path: Union[str, os.PathLike],
 
     :param Union[str, os.PathLike] file_path: Path to video file
     :param Union[int, float] fps: FPS of the new video file.
-    :param bool gpu: If True, use NVIDEA GPU codecs. Default False.
+    :param bool gpu: If True, use NVIDEA GPU codecs. Default False. GPU can provide significant speedup (3-4x faster) for FPS conversion, especially for longer videos.
     :param Optional[str] codec: Video codec to use. If None, automatically selects based on file extension (libvpx-vp9 for .webm, mpeg4 for .avi, libx264 for others). Default None.
     :param Optional[Union[str, os.PathLike]] save_path: Path where to save the converted video. If None, saves in the same directory as input file with ``_fps_{fps}`` suffix. Default None.
     :param Optional[int] quality: Video quality (CRF value). Lower values = higher quality. Range 0-52. Default 23.
@@ -702,7 +702,7 @@ def change_single_video_fps(file_path: Union[str, os.PathLike],
     else:
         check_if_dir_exists(in_dir=os.path.dirname(save_path), raise_error=True)
     quality = 23 if not check_int(name='quality', value=quality, min_value=0, max_value=52, raise_error=False)[0] else int(quality)
-    if verbose: print(f"Converting the FPS to {fps} for video {file_name} ...")
+    if verbose: print(f"Converting the FPS {video_meta_data['fps']} -> {fps} for video {file_name} ...")
     if codec is None:
         if ext.lower() == '.webm':
             codec = 'libvpx-vp9'
@@ -713,10 +713,14 @@ def change_single_video_fps(file_path: Union[str, os.PathLike],
     if os.path.isfile(save_path):
         FileExistWarning(msg=f"Overwriting existing file at {save_path}...", source=change_single_video_fps.__name__,)
     if gpu:
-        cmd = f'ffmpeg -hwaccel auto -c:v h264_cuvid -i "{file_path}" -vf "fps={fps}" -c:v h264_nvenc -rc vbr -cq {quality} -c:a copy "{save_path}" -loglevel error -stats -hide_banner -y'
-    else:
+        cmd = f'ffmpeg -hwaccel auto -i "{file_path}" -vf "fps={fps}" -c:v h264_nvenc -preset p4 -cq {quality} -c:a copy "{save_path}" -loglevel error -stats -hide_banner -y'
+        result = subprocess.run(cmd, shell=True)
+        if result.returncode != 0:
+            if verbose: SimBAGPUError(msg=f'FPS convertion ({video_meta_data["fps"]}->{fps}) GPU for video {file_name} failed, using CPU instead...')
+            gpu = False
+    if not gpu:
         cmd = f'ffmpeg -i "{file_path}" -filter:v fps=fps={fps} -c:v {codec} -crf {quality} -c:a aac "{save_path}" -loglevel error -stats -hide_banner -y'
-    subprocess.call(cmd, shell=True)
+        subprocess.call(cmd, shell=True)
     timer.stop_timer()
     if verbose: stdout_success(msg=f'SIMBA COMPLETE: FPS of video {file_name} changed from {str(video_meta_data["fps"])} to {str(fps)} and saved in directory {save_path}', elapsed_time=timer.elapsed_time_str, source=change_single_video_fps.__name__)
 
@@ -725,7 +729,8 @@ def change_fps_of_multiple_videos(path: Union[str, os.PathLike, List[Union[str,
                                   fps: int,
                                   quality: int = 23,
                                   save_dir: Optional[Union[str, os.PathLike]] = None,
-                                  gpu: Optional[bool] = False) -> None:
+                                  gpu: Optional[bool] = False,
+                                  verbose: bool = True) -> None:
     """
     Change the fps of all video files in a folder. Results are stored in the same directory as in the input files with
     the suffix ``_fps_new_fps``.
@@ -735,6 +740,7 @@ def change_fps_of_multiple_videos(path: Union[str, os.PathLike, List[Union[str,
     :param int quality: Video quality (CRF value). Lower values = higher quality. Range 0-52. Default 23.
     :param Optional[Union[str, os.PathLike]] save_dir: If not None, then the directory where to store converted videos. If None, then stores the new videos in the same directory as the input video with the ``_fps_{fps}.file_extension`` suffix.
     :param Optional[bool] gpu: If True, use NVIDEA GPU codecs. Default False.
+    :param bool verbose: If True, prints conversion progress. Default True.
     :returns: None.
 
     :example:
@@ -764,7 +770,7 @@ def change_fps_of_multiple_videos(path: Union[str, os.PathLike, List[Union[str,
         video_meta_data = get_video_meta_data(video_path=file_path)
         if int(fps) == int(video_meta_data["fps"]):
             SameInputAndOutputWarning(msg=f"The new FPS ({fps}) is the same or lower than the original FPS ({video_meta_data['fps']}) for video {file_name}", source=change_fps_of_multiple_videos.__name__)
-        print(f"Converting FPS from {video_meta_data['fps']} to {fps} for {file_name}...")
+        if verbose: print(f"Converting the FPS {video_meta_data['fps']} -> {fps} for video {file_name} ...")
         if save_dir is None:
             save_path = os.path.join(dir_name, file_name + f"_fps_{fps}{ext}")
         else:
@@ -772,15 +778,26 @@ def change_fps_of_multiple_videos(path: Union[str, os.PathLike, List[Union[str,
         if ext.lower() == '.webm': codec = 'libvpx-vp9'
         elif ext.lower() == '.avi': codec = 'mpeg4'
         else: codec = 'libx264'
+        if os.path.isfile(save_path):
+            FileExistWarning(msg=f"Overwriting existing file at {save_path}...", source=change_single_video_fps.__name__, )
+        if gpu:
+            cmd = f'ffmpeg -hwaccel auto -i "{file_path}" -vf "fps={fps}" -c:v h264_nvenc -preset p4 -cq {quality} -c:a copy "{save_path}" -loglevel error -stats -hide_banner -y'
+            result = subprocess.run(cmd, shell=True)
+            if result.returncode != 0:
+                if verbose: SimBAGPUError(msg=f'FPS convertion ({video_meta_data["fps"]}->{fps}) GPU for video {file_name} failed, using CPU instead...')
+                gpu = False
+        if not gpu:
+            cmd = f'ffmpeg -i "{file_path}" -filter:v fps=fps={fps} -c:v {codec} -crf {quality} -c:a aac "{save_path}" -loglevel error -stats -hide_banner -y'
+            subprocess.call(cmd, shell=True)
         if gpu:
             command = f'ffmpeg -hwaccel auto -c:v h264_cuvid -i "{file_path}" -vf "fps={fps}" -c:v h264_nvenc -rc vbr -cq {quality} -c:a copy "{save_path}" -loglevel error -stats -hide_banner -y'
         else:
             command = f'ffmpeg -i "{file_path}" -filter:v fps=fps={fps} -c:v {codec} -crf {quality} -c:a aac "{save_path}" -loglevel error -stats -hide_banner -y'
         subprocess.call(command, shell=True)
         video_timer.stop_timer()
-        print(f"Video {file_name} complete (saved at {save_path})... (elapsed time: {video_timer.elapsed_time_str}s)")
+        if verbose: print(f"Video {file_name} complete (saved at {save_path})... (elapsed time: {video_timer.elapsed_time_str}s)")
     timer.stop_timer()
-    stdout_success(msg=f"SIMBA COMPLETE: FPS of {len(video_paths)} video(s) changed to {fps}", elapsed_time=timer.elapsed_time_str, source=change_fps_of_multiple_videos.__name__,)
+    if verbose: stdout_success(msg=f"SIMBA COMPLETE: FPS of {len(video_paths)} video(s) changed to {fps}", elapsed_time=timer.elapsed_time_str, source=change_fps_of_multiple_videos.__name__,)
 
 
 def convert_video_powerpoint_compatible_format(file_path: Union[str, os.PathLike], gpu: Optional[bool] = False) -> None:

simba/video_processors/videos_to_frames.py

@@ -87,8 +87,8 @@ def video_to_frames(video_path: Union[str, os.PathLike],
     :return: None. Frames are saved to disk in the specified directory.
 
     :example:
-    >>> video_to_frames(video_path=r"C:\troubleshooting\SDS_pre_post\project_folder\videos\SDI100 x ALR2 post_d7.mp4", 
-    ...                save_dir=r'C:\troubleshooting\SDS_pre_post\project_folder\videos\test', 
+    >>> video_to_frames(video_path=r"C:/troubleshooting/SDS_pre_post/project_folder/videos/SDI100 x ALR2 post_d7.mp4", 
+    ...                save_dir=r'C:/troubleshooting/SDS_pre_post/project_folder/videos/test', 
     ...                black_and_white=False, 
     ...                verbose=True, 
     ...                img_format='webp',