simba-uw-tf-dev 4.5.8__py3-none-any.whl → 4.7.1__py3-none-any.whl

simba/ui/tkinter_functions.py

@@ -156,6 +156,7 @@ class SimBAScaleBar(Frame):
     def __init__(self,
                  parent: Union[Frame, Canvas, LabelFrame, Toplevel, Tk],
                  label: Optional[str] = None,
+                 label_width: Optional[int] = None,
                  orient: Literal['horizontal', 'vertical'] = HORIZONTAL,
                  length: int = 200,
                  value: Optional[int] = 95,
@@ -194,7 +195,7 @@ class SimBAScaleBar(Frame):
                            showvalue=showvalue)
 
         if label is not None:
-            self.lbl = SimBALabel(parent=self, txt=label, font=lbl_font, txt_clr=label_clr)
+            self.lbl = SimBALabel(parent=self, txt=label, font=lbl_font, txt_clr=label_clr, width=label_width)
             self.lbl.grid(row=0, column=1, sticky=SW)
 
         self.scale.grid(row=0, column=2, sticky=NW)
@@ -207,6 +208,11 @@ class SimBAScaleBar(Frame):
     def get_value(self) -> Union[int, float]:
         return self.scale.get()
 
+    def get(self) -> Union[int, float]:
+        ## Alternative for ``get_value`` for legacy reasons.
+        return self.scale.get()
+
+
 
 
 class Entry_Box(Frame):
@@ -223,6 +229,7 @@ class Entry_Box(Frame):
                  value: Optional[Any] = None,
                  label_font: tuple = Formats.FONT_REGULAR.value,
                  entry_font: tuple = Formats.FONT_REGULAR.value,
+                 tooltip_key: Optional[str] = None,
                  justify: Literal["left", "center", "right"] = 'left',
                  cmd: Optional[Callable] = None,
                  **kw):
@@ -243,6 +250,8 @@ class Entry_Box(Frame):
         self.filePath = StringVar()
         self.lblName = Label(self, text=fileDescription, width=labelwidth, anchor=W, font=label_font, bg=label_bg_clr)
         self.lblName.grid(row=0, column=1)
+        if tooltip_key in TOOLTIPS.keys():
+            CreateToolTip(widget=self.lblName, text=TOOLTIPS[tooltip_key])
         if not entry_box_width:
             self.entPath = Entry(self, textvariable=self.filePath, state=self.status,  validate="key", validatecommand=self.validation_methods.get(validation, None), font=entry_font, justify=justify, bg=entry_box_clr)
         else:

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

@@ -5,6 +5,7 @@ import configparser
 import gc
 import io
 import os
+import platform
 import subprocess
 from copy import deepcopy
 from datetime import datetime
@@ -38,15 +39,18 @@ from simba.utils.checks import (check_file_exist_and_readable, check_float,
                                 check_if_valid_rgb_tuple, check_instance,
                                 check_int, check_str, check_that_column_exist,
                                 check_that_hhmmss_start_is_before_end,
-                                check_valid_array, check_valid_cpu_pool,
-                                check_valid_dataframe, check_valid_lst)
-from simba.utils.enums import ConfigKey, Dtypes, Formats, Keys, Options
+                                check_valid_array, check_valid_boolean,
+                                check_valid_cpu_pool, check_valid_dataframe,
+                                check_valid_lst)
+from simba.utils.enums import (OS, ConfigKey, Defaults, Dtypes, Formats, Keys,
+                               Options)
 from simba.utils.errors import (BodypartColumnNotFoundError, CountError,
                                 InvalidFileTypeError, InvalidInputError,
                                 NoFilesFoundError, NoROIDataError,
                                 SimBAModuleNotFoundError)
 from simba.utils.printing import stdout_success, stdout_warning
-from simba.utils.read_write import (find_video_of_file, get_fn_ext,
+from simba.utils.read_write import (find_core_cnt, find_video_of_file,
+                                    get_current_time, get_fn_ext,
                                     get_video_meta_data, read_config_entry,
                                     read_config_file, read_df,
                                     read_project_path_and_file_type,
@@ -1781,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)
@@ -1813,33 +1817,105 @@ def fft_lowpass_filter(data: np.ndarray, cut_off: float = 0.1) -> np.ndarray:
     return results.astype(data.dtype)
 
 
-def terminate_cpu_pool(pool: Optional[multiprocessing.pool.Pool],
-                       force: bool = False) -> None:
+def terminate_cpu_pool(pool: multiprocessing.pool.Pool,
+                       force: bool = False,
+                       verbose: bool = True,
+                       source: Optional[str] = None) -> None:
     """
-    Safely terminates a multiprocessing.Pool instance.
+    Safely terminates a multiprocessing.Pool instance with optional graceful shutdown.
 
-    :param Optional[multiprocessing.pool.Pool] pool: The pool to terminate. If None, function returns without action.
-    :param bool force: If True, skips join() and immediately terminates. Default: False.
-    :raises InvalidInputError: If pool is not a valid Pool instance.
+    .. note::
+       If pool is None or invalid, function returns without action. Exceptions during termination are silently caught.
+
+    :param multiprocessing.pool.Pool pool: The multiprocessing pool to terminate. If None, function returns without action.
+    :param bool force: If True, skips graceful shutdown (close/join) and immediately terminates. Default: False.
+    :param bool verbose: If True, prints termination message with timestamp. Default: True.
+    :param Optional[str] source: Optional identifier string for logging purposes (e.g., 'VideoProcessor'). Default: None.
 
     :example:
     >>> import multiprocessing
     >>> pool = multiprocessing.Pool(4)
-    >>> terminate_cpu_pool(pool)
+    >>> terminate_cpu_pool(pool=pool, force=False, verbose=True, source='FeatureExtractor')
     """
     if pool is None:
         return
-    check_valid_cpu_pool(value=pool, source=terminate_cpu_pool.__name__, raise_error=True)
+    if not check_valid_cpu_pool(value=pool, source=terminate_cpu_pool.__name__, raise_error=False):
+        return
     try:
+        core_cnt = pool._processes if hasattr(pool, '_processes') else None
         if not force:
             pool.close()
             pool.join()
         pool.terminate()
+        if verbose: print(f'[{get_current_time()}] {"" if source is None else f"{core_cnt} core"} SimBA CPU pool {"" if source is None else source} terminated.')
     except (ValueError, AssertionError, AttributeError):
         pass
     gc.collect()
 
 
+
+def get_cpu_pool(core_cnt: int = -1,
+                 maxtasksperchild: int = Defaults.MAXIMUM_MAX_TASK_PER_CHILD.value,
+                 context: Literal['fork', 'spawn', 'forkserver'] = None,
+                 verbose: bool = True,
+                 source: Optional[str] = None) -> multiprocessing.Pool:
+    """
+    Creates and returns a multiprocessing.Pool instance with platform-appropriate defaults and validation.
+
+    :param int core_cnt: Number of worker processes. -1 uses all available cores. Default: -1.
+    :param int maxtasksperchild: Maximum number of tasks a worker process can complete before being replaced. Default: From Defaults.MAXIMUM_MAX_TASK_PER_CHILD.
+    :param Optional[Literal['fork', 'spawn', 'forkserver']] context: Multiprocessing start method. None uses platform default. Default: None.
+    :param bool verbose: If True, prints pool creation message with timestamp. Default: True.
+    :param Optional[str] source: Optional identifier string for logging purposes (e.g., 'VideoProcessor'). Default: None.
+    :return: Configured multiprocessing.Pool instance.
+    :rtype: multiprocessing.Pool
+
+    :example:
+    >>> pool = get_cpu_pool(core_cnt=4, source='FeatureExtractor')
+    >>> pool = get_cpu_pool(core_cnt=-1, context='spawn', verbose=True)
+    >>> pool = get_cpu_pool(core_cnt=8, maxtasksperchild=100, source='VideoProcessor')
+    """
+
+    check_int(name=f'{get_cpu_pool.__name__} core_cnt', min_value=-1, unaccepted_vals=[0], value=core_cnt, raise_error=True)
+    check_int(name=f'{get_cpu_pool.__name__} maxtasksperchild', min_value=1, value=maxtasksperchild, raise_error=True)
+    check_valid_boolean(value=verbose, source=f'{get_cpu_pool.__name__} verbose', raise_error=True)
+    if source is not None: check_str(name=f'{get_cpu_pool.__name__} source', value=source, raise_error=True, allow_blank=True)
+    current_process = multiprocessing.current_process()
+    if current_process.name != 'MainProcess': core_cnt = 1
+    core_cnt = find_core_cnt()[0] if core_cnt == -1 or core_cnt > find_core_cnt()[0] else core_cnt
+    if verbose: print(f'[{get_current_time()}] {core_cnt} core SimBA CPU pool {"" if source is None else source} started.')
+    if context is not None:
+        check_str(name=f'{get_cpu_pool.__name__} context', value=context, options=('fork', 'spawn', 'forkserver'), raise_error=True)
+    else:
+        existing_method = multiprocessing.get_start_method(allow_none=True)
+        if existing_method is not None:
+            context = existing_method
+        else:
+            system = platform.system()
+            if system == OS.WINDOWS.value: context = OS.SPAWN.value
+            elif system == OS.MAC.value: context = OS.SPAWN.value
+            else: context = OS.FORK.value
+
+    if context is not None:
+        try:
+            ctx = multiprocessing.get_context(context)
+        except ValueError:
+            system = platform.system()
+            if system == OS.WINDOWS.value: fallback_context = OS.SPAWN.value
+            elif system == OS.MAC.value: fallback_context = OS.SPAWN.value
+            else: fallback_context = OS.FORK.value
+            try:
+                ctx = multiprocessing.get_context(fallback_context)
+            except ValueError:
+                pool = multiprocessing.Pool(processes=core_cnt, maxtasksperchild=maxtasksperchild)
+                return pool
+        pool = ctx.Pool(processes=core_cnt, maxtasksperchild=maxtasksperchild)
+    else:
+        pool = multiprocessing.Pool(processes=core_cnt, maxtasksperchild=maxtasksperchild)
+    return pool
+
+
+#get_cpu_pool()
 # run_user_defined_feature_extraction_class(config_path='/Users/simon/Desktop/envs/troubleshooting/circular_features_zebrafish/project_folder/project_config.ini', file_path='/Users/simon/Desktop/fish_feature_extractor_2023_version_5.py')
 
 

simba/utils/enums.py

@@ -127,6 +127,7 @@ class OS(Enum):
     LINUX = "Linux"
     MAC = "Darwin"
     SPAWN = 'spawn'
+    FORK = 'fork'
     PYTHON_VER = str(f"{sys.version_info.major}.{sys.version_info.minor}")
     try:
         SIMBA_VERSION = pkg_resources.get_distribution("simba-uw-tf-dev").version