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

simba/ui/pop_ups/kleinberg_pop_up.py

@@ -8,12 +8,13 @@ from simba.data_processors.kleinberg_calculator import KleinbergCalculator
 from simba.mixins.config_reader import ConfigReader
 from simba.mixins.pop_up_mixin import PopUpMixin
 from simba.ui.tkinter_functions import (CreateLabelFrameWithIcon, Entry_Box,
-                                        SimbaButton, SimBADropDown)
+                                        SimbaButton, SimBADropDown, SimBALabel)
 from simba.utils.checks import check_float, check_int
 from simba.utils.enums import Formats, Keys, Links
 from simba.utils.errors import NoChoosenClassifierError, NoDataError
-from simba.utils.read_write import str_2_bool
+from simba.utils.read_write import get_current_time, str_2_bool
 
+INSTRUCTIONS_TXT = 'Results in the project_folder/csv/machine_results folder are overwritten.\n If saving the originals, the original un-smoothened data is saved in a subdirectory of \nthe project_folder/csv/machine_results folder'
 
 class KleinbergPopUp(PopUpMixin, ConfigReader):
     def __init__(self,
@@ -24,61 +25,59 @@ class KleinbergPopUp(PopUpMixin, ConfigReader):
             raise NoDataError(msg=f'Cannot perform Kleinberg smoothing: No data files found in {self.machine_results_dir} directory', source=self.__class__.__name__)
         PopUpMixin.__init__(self, title="APPLY KLEINBERG BEHAVIOR CLASSIFICATION SMOOTHING", icon='smooth')
         kleinberg_settings_frm = CreateLabelFrameWithIcon(parent=self.main_frm, header="KLEINBERG SETTINGS", icon_name=Keys.DOCUMENTATION.value, icon_link=Links.KLEINBERG.value)
-        self.k_sigma = Entry_Box(kleinberg_settings_frm, fileDescription="SIGMA", img='sigma', value='2', justify='center', labelwidth=35, entry_box_width=35)
-        self.k_gamma = Entry_Box(kleinberg_settings_frm, fileDescription="GAMMA", img='gamma', value='0.3', justify='center', labelwidth=35, entry_box_width=35)
-        self.k_hierarchy = Entry_Box(kleinberg_settings_frm, fileDescription="HIERARCHY", value=1, img='hierarchy_2', justify='center', labelwidth=35, entry_box_width=35)
-        self.h_search_dropdown = SimBADropDown(parent=kleinberg_settings_frm, dropdown_options=['TRUE', 'FALSE'], label="HIERACHICAL SEARCH", value='FALSE', img='hierarchy', label_width=35, dropdown_width=35)
+        self.k_sigma = Entry_Box(kleinberg_settings_frm, fileDescription="SIGMA", img='sigma', value='2', justify='center', labelwidth=35, entry_box_width=35, tooltip_key='KLEINBERG_SIGMA')
+        self.k_gamma = Entry_Box(kleinberg_settings_frm, fileDescription="GAMMA", img='gamma', value='0.3', justify='center', labelwidth=35, entry_box_width=35, tooltip_key='KLEINBERG_GAMMA')
+        self.k_hierarchy = Entry_Box(kleinberg_settings_frm, fileDescription="HIERARCHY", value=1, img='hierarchy_2', justify='center', labelwidth=35, entry_box_width=35, validation='numeric', tooltip_key='KLEINBERG_HIERARCHY')
+        self.h_search_dropdown = SimBADropDown(parent=kleinberg_settings_frm, dropdown_options=['TRUE', 'FALSE'], label="HIERARCHICAL SEARCH", value='FALSE', img='hierarchy', label_width=35, dropdown_width=35, tooltip_key='KLEINBERG_HIERARCHY_SEARCH')
+        self.save_originals_dropdown = SimBADropDown(parent=kleinberg_settings_frm, dropdown_options=['TRUE', 'FALSE'], label="SAVE ORIGINAL DATA:", value='TRUE', img='save', label_width=35, dropdown_width=35, tooltip_key='KLEINBERG_SAVE_ORIGINALS')
+        self.instructions_lbl = SimBALabel(parent=kleinberg_settings_frm, txt=INSTRUCTIONS_TXT, justify='center', txt_clr='blue', font=Formats.FONT_REGULAR_ITALICS.value)
 
 
-        kleinberg_table_frame = LabelFrame(self.main_frm, text="CHOOSE CLASSIFIER(S) FOR KLEINBERG SMOOTHING", font=Formats.FONT_HEADER.value)
+        kleinberg_table_frame = CreateLabelFrameWithIcon(parent=self.main_frm, header="CHOOSE CLASSIFIER(S) FOR KLEINBERG SMOOTHING", icon_name=Keys.DOCUMENTATION.value, icon_link=Links.KLEINBERG.value)
         clf_var_dict, clf_cb_dict = {}, {}
         for clf_cnt, clf in enumerate(self.clf_names):
             clf_var_dict[clf] = BooleanVar()
             clf_cb_dict[clf] = Checkbutton(kleinberg_table_frame, text=clf, font=Formats.FONT_REGULAR.value, variable=clf_var_dict[clf])
-            clf_cb_dict[clf].grid(row=clf_cnt, sticky=NW)
+            clf_cb_dict[clf].grid(row=clf_cnt, column=0, sticky=NW)
 
         run_kleinberg_btn = SimbaButton(parent=self.main_frm, txt="APPLY KLEINBERG SMOOTHER", img='rocket', txt_clr="blue", font=Formats.FONT_REGULAR.value, cmd=self.run_kleinberg, cmd_kwargs={'behaviors_dict': lambda: clf_var_dict, 'hierarchical_search': lambda: str_2_bool(self.h_search_dropdown.get_value())})
-        kleinberg_settings_frm.grid(row=0, sticky=W, padx=10)
-        self.k_sigma.grid(row=0, sticky=W)
-        self.k_gamma.grid(row=1, sticky=W)
-        self.k_hierarchy.grid(row=2, sticky=W)
-        self.h_search_dropdown.grid(row=3, column=0, sticky=W)
-        kleinberg_table_frame.grid(row=1, pady=10, padx=10)
-        run_kleinberg_btn.grid(row=2)
+        kleinberg_settings_frm.grid(row=0, sticky=W, pady=(15, 0))
+        self.instructions_lbl.grid(row=0, sticky=W)
+        self.k_sigma.grid(row=1, sticky=W)
+        self.k_gamma.grid(row=2, sticky=W)
+        self.k_hierarchy.grid(row=3, sticky=W)
+        self.h_search_dropdown.grid(row=4, column=0, sticky=W)
+        self.save_originals_dropdown.grid(row=5, column=0, sticky=W)
+        kleinberg_table_frame.grid(row=1, column=0, sticky=NW, pady=(15, 0))
+        run_kleinberg_btn.grid(row=2, column=0, sticky=NW, pady=(15, 0))
         self.main_frm.mainloop()
 
     def run_kleinberg(self, behaviors_dict: dict, hierarchical_search: bool):
         targets = []
         for behaviour, behavior_val in behaviors_dict.items():
-            if behavior_val.get():
-                targets.append(behaviour)
+            if behavior_val.get(): targets.append(behaviour)
 
         if len(targets) == 0:
             raise NoChoosenClassifierError(source=self.__class__.__name__)
 
-        check_int(name="Hierarchy", value=self.k_hierarchy.entry_get)
-        check_float(name="Sigma", value=self.k_sigma.entry_get)
-        check_float(name="Gamma", value=self.k_gamma.entry_get)
-
-        try:
-            print(
-                "Applying kleinberg hyperparameter Setting: Sigma: {}, Gamma: {}, Hierarchy: {}".format(
-                    str(self.k_sigma.entry_get),
-                    str(self.k_gamma.entry_get),
-                    str(self.k_hierarchy.entry_get),
-                )
-            )
-        except:
-            print("Please insert accurate values for all hyperparameters.")
-
-        kleinberg_analyzer = KleinbergCalculator(
-            config_path=self.config_path,
-            classifier_names=targets,
-            sigma=self.k_sigma.entry_get,
-            gamma=self.k_gamma.entry_get,
-            hierarchy=self.k_hierarchy.entry_get,
-            hierarchical_search=hierarchical_search,
-        )
+        k_hierarchy = self.k_hierarchy.entry_get
+        k_sigma = self.k_sigma.entry_get
+        k_gamma = self.k_gamma.entry_get
+        save_originals = str_2_bool(self.save_originals_dropdown.get_value())
+
+        check_int(name="Hierarchy", value=k_hierarchy, min_value=1, allow_negative=False, allow_zero=False, raise_error=True)
+        check_float(name="Sigma", value=k_sigma, allow_negative=False, allow_zero=False, raise_error=True)
+        check_float(name="Gamma", value=k_gamma, allow_negative=False, allow_zero=False, raise_error=True)
+
+        print(f"[{get_current_time()}] Applying kleinberg hyperparameter Setting: Sigma: {k_sigma}, Gamma: {k_gamma}, Hierarchy: {k_hierarchy}")
+
+        kleinberg_analyzer = KleinbergCalculator(config_path=self.config_path,
+                                                 classifier_names=targets,
+                                                 sigma=float(k_sigma),
+                                                 gamma=float(k_gamma),
+                                                 hierarchy=int(k_hierarchy),
+                                                 hierarchical_search=hierarchical_search,
+                                                 save_originals=save_originals)
         kleinberg_analyzer.run()
 
 

simba/ui/pop_ups/video_processing_pop_up.py

@@ -24,7 +24,7 @@ from simba.ui.tkinter_functions import (CreateLabelFrameWithIcon,
                                         FileSelect, FolderSelect, SimbaButton,
                                         SimbaCheckbox, SimBADropDown,
                                         SimBALabel, SimBARadioButton,
-                                        SimBAScaleBar)
+                                        SimBAScaleBar, SimBASeperator)
 from simba.utils.checks import (check_ffmpeg_available,
                                 check_file_exist_and_readable,
                                 check_if_dir_exists,
@@ -1505,23 +1505,23 @@ class ClipMultipleVideosByFrameNumbersPopUp(PopUpMixin):
         max_video_name_len = len(max(list(self.video_paths.keys())))
         super().__init__(title="CLIP MULTIPLE VIDEOS BY FRAME NUMBERS", icon='clip')
         self.save_dir = save_dir
+        padx = (0, 25)
         data_frm = CreateLabelFrameWithIcon(parent=self.main_frm, header="VIDEO SETTINGS", icon_name=Keys.DOCUMENTATION.value, icon_link=Links.VIDEO_TOOLS.value)
-        data_frm.grid(row=2, column=0, sticky=NW)
-
-
+        SimBALabel(parent=data_frm, font=Formats.FONT_REGULAR.value, txt="VIDEO NAME", justify='center', img='video').grid(row=0, column=0, padx=padx, sticky=NW)
+        SimBALabel(parent=data_frm, font=Formats.FONT_REGULAR.value, txt="START FRAME", justify='center', img='play').grid(row=0, column=2, padx=padx)
+        SimBALabel(parent=data_frm, font=Formats.FONT_REGULAR.value, txt="END FRAME", justify='center', img='stop').grid(row=0, column=3, padx=padx)
 
-        SimBALabel(parent=data_frm, width=max_video_name_len+20, font=Formats.FONT_REGULAR.value, txt="VIDEO NAME", justify='center').grid(row=0, column=0)
-        SimBALabel(parent=data_frm, width=max_video_name_len+20, font=Formats.FONT_REGULAR.value, txt="START FRAME", justify='center').grid(row=0, column=2)
-        SimBALabel(parent=data_frm, width=max_video_name_len+20, font=Formats.FONT_REGULAR.value, txt="END FRAME", justify='center').grid(row=0, column=3)
+        seperator = SimBASeperator(parent=data_frm, color=None, orient='horizontal', borderwidth=1)
+        seperator.grid(row=1, column=0, columnspan=4, rowspan=1, sticky="ew")
 
         self.entry_boxes = {}
         for cnt, video_name in enumerate(self.video_paths.keys()):
             self.entry_boxes[video_name] = {}
-            SimBALabel(parent=data_frm, width=max_video_name_len + 20, font=Formats.FONT_REGULAR.value, txt=video_name + ' ' + f'({ self.video_meta_data[cnt]})', justify='center').grid(row=cnt + 1, column=0)
-            self.entry_boxes[video_name]["start"] = Entry_Box(data_frm, "", 0, validation="numeric")
-            self.entry_boxes[video_name]["end"] = Entry_Box(data_frm, "", 0, validation="numeric")
-            self.entry_boxes[video_name]["start"].grid(row=cnt + 1, column=2, sticky=NW)
-            self.entry_boxes[video_name]["end"].grid(row=cnt + 1, column=3, sticky=NW)
+            SimBALabel(parent=data_frm, font=Formats.FONT_REGULAR.value, txt=video_name + f' (frames: { self.video_meta_data[cnt]})', justify='left').grid(row=cnt + 2, column=0, padx=padx, sticky=NW)
+            self.entry_boxes[video_name]["start"] = Entry_Box(data_frm, fileDescription="", labelwidth=0, validation="numeric", justify='center')
+            self.entry_boxes[video_name]["end"] = Entry_Box(data_frm, fileDescription="", labelwidth=0, validation="numeric", justify='center')
+            self.entry_boxes[video_name]["start"].grid(row=cnt + 2, column=2, sticky=NW, padx=padx)
+            self.entry_boxes[video_name]["end"].grid(row=cnt + 2, column=3, sticky=NW, padx=padx)
 
         gpu_state = NORMAL if check_nvidea_gpu_available(raise_error=False) else DISABLED
         batch_settings_frm = CreateLabelFrameWithIcon(parent=self.main_frm, header="BATCH SETTINGS", icon_name=Keys.DOCUMENTATION.value, icon_link=Links.VIDEO_TOOLS.value)
@@ -1531,6 +1531,7 @@ class ClipMultipleVideosByFrameNumbersPopUp(PopUpMixin):
         batch_end_btn = SimbaButton(parent=batch_settings_frm, txt='SET', img='tick', cmd=self._batch_set_val, cmd_kwargs={'text': lambda: batch_end_entry.entry_get.strip(), 'box_type': lambda: 'end'})
         self.gpu_dropdown = SimBADropDown(parent=batch_settings_frm, dropdown_options=['TRUE', 'FALSE'], label='USE GPU:', label_width=25, dropdown_width=12, tooltip_key='USE_GPU', img='gpu_3', state=gpu_state, value='FALSE')
         self.quality_dropdown = SimBADropDown(parent=batch_settings_frm, dropdown_options=list(range(10, 110, 10)), label='OUT VIDEO QUALITY:', label_width=25, dropdown_width=12, tooltip_key='OUTPUT_VIDEO_QUALITY', img='pct_2', value=60)
+        data_frm.grid(row=2, column=0, sticky=NW)
         batch_settings_frm.grid(row=1, column=0, sticky=NW)
         batch_start_entry.grid(row=0, column=0, sticky=NW)
         batch_start_btn.grid(row=0, column=1, sticky=NW)
@@ -1590,6 +1591,9 @@ class ClipMultipleVideosByFrameNumbersPopUp(PopUpMixin):
 
 
 #ClipMultipleVideosByFrameNumbersPopUp(data_dir=r'E:\netholabs_videos\terry\mp4s\4_02_001_exp_2025_12_02_15_22_00\videos\Camera2', save_dir=r'E:\netholabs_videos\terry\mp4s\4_02_001_exp_2025_12_02_15_22_00\videos\Camera2\test')
+#ClipMultipleVideosByFrameNumbersPopUp(data_dir=r"E:\maplight_videos\test_0126", save_dir=r"E:\maplight_videos\clip_test")
+
+
 
 class InitiateClipMultipleVideosByFrameNumbersPopUp(PopUpMixin):
     def __init__(self):
@@ -1636,6 +1640,8 @@ class InitiateClipMultipleVideosByFrameNumbersPopUp(PopUpMixin):
         )
 
 
+
+
 class ClipMultipleVideosByTimestamps(PopUpMixin):
     """
     :example:
@@ -1648,13 +1654,12 @@ class ClipMultipleVideosByTimestamps(PopUpMixin):
         check_if_dir_exists(in_dir=save_dir, source=self.__class__.__name__, create_if_not_exist=True)
         self.video_paths = find_all_videos_in_directory(directory=data_dir, as_dict=True, raise_error=True)
         self.video_meta_data = [get_video_meta_data(video_path=x) for x in list(self.video_paths.values())]
-        max_video_name_len = len(max(list(self.video_paths.keys()))) + 25
         super().__init__(title="CLIP MULTIPLE VIDEOS BY TIME-STAMPS", icon='clip')
         self.save_dir = save_dir
         batch_settings_frm = CreateLabelFrameWithIcon(parent=self.main_frm, header="BATCH SETTINGS", icon_name=Keys.DOCUMENTATION.value, icon_link=Links.VIDEO_TOOLS.value)
-        batch_start_entry = Entry_Box(parent=batch_settings_frm, fileDescription='START TIME (HH:MM:SS):', labelwidth=25, entry_box_width=12, img='play')
+        batch_start_entry = Entry_Box(parent=batch_settings_frm, fileDescription='START TIME (HH:MM:SS):', labelwidth=25, entry_box_width=12, img='play', justify='center')
         batch_start_btn = SimbaButton(parent=batch_settings_frm, txt='SET', img='tick', cmd=self._batch_set_val, cmd_kwargs={'text': lambda: batch_start_entry.entry_get.strip(), 'box_type': lambda: 'start'})
-        batch_end_entry = Entry_Box(parent=batch_settings_frm, fileDescription='END TIME (HH:MM:SS):', labelwidth=25, entry_box_width=12, img='stop')
+        batch_end_entry = Entry_Box(parent=batch_settings_frm, fileDescription='END TIME (HH:MM:SS):', labelwidth=25, entry_box_width=12, img='stop', justify='center')
         batch_end_btn = SimbaButton(parent=batch_settings_frm, txt='SET', img='tick', cmd=self._batch_set_val, cmd_kwargs={'text': lambda: batch_end_entry.entry_get.strip(), 'box_type': lambda: 'end'})
         batch_settings_frm.grid(row=0, column=0, sticky=NW)
         batch_start_entry.grid(row=0, column=0, sticky=NW)
@@ -1667,25 +1672,28 @@ class ClipMultipleVideosByTimestamps(PopUpMixin):
         self.gpu_dropdown.grid(row=2, column=0, sticky=NW)
         self.quality_dropdown.grid(row=3, column=0, sticky=NW)
         self.save_dir = save_dir
+        padx = (0, 30)
         data_frm = CreateLabelFrameWithIcon(parent=self.main_frm, header="VIDEO SETTINGS", icon_name='video', icon_link=Links.VIDEO_TOOLS.value)
-        data_frm.grid(row=1, column=0, sticky=NW)
-        Label(data_frm, text="VIDEO NAME", width=max_video_name_len).grid(row=0, column=0, sticky=NW)
-        Label(data_frm, text="VIDEO LENGTH", width=12).grid(row=0, column=1)
-        Label(data_frm, text="START TIME (HH:MM:SS)", width=18).grid(row=0, column=2)
-        Label(data_frm, text="END TIME (HH:MM:SS)", width=18).grid(row=0, column=3)
+
+        SimBALabel(data_frm, txt="VIDEO NAME", justify='center', font=Formats.FONT_REGULAR_BOLD.value, img='video').grid(row=0, column=0, sticky=NW, padx=padx)
+        SimBALabel(data_frm, txt="VIDEO LENGTH", justify='center', font=Formats.FONT_REGULAR_BOLD.value, img='timer_2').grid(row=0, column=1, sticky=NW, padx=padx)
+        SimBALabel(data_frm, txt="START TIME (HH:MM:SS)", justify='center', font=Formats.FONT_REGULAR_BOLD.value, img='play').grid(row=0, column=2, sticky=NW, padx=padx)
+        SimBALabel(data_frm, txt="END TIME (HH:MM:SS)", justify='center', font=Formats.FONT_REGULAR_BOLD.value, img='stop').grid(row=0, column=3, sticky=NW, padx=padx)
+        seperator = SimBASeperator(parent=data_frm, color=None, orient='horizontal', borderwidth=1)
+        seperator.grid(row=1, column=0, columnspan=4, rowspan=1, sticky="ew")
 
         self.entry_boxes = {}
         for cnt, video_name in enumerate(self.video_paths.keys()):
             self.entry_boxes[video_name] = {}
-            SimBALabel(parent=data_frm, txt=video_name, width=max_video_name_len, justify='center').grid(row=cnt + 1, column=0, sticky=NW)
+            SimBALabel(parent=data_frm, txt=video_name, justify='center').grid(row=cnt + 2, column=0, sticky=NW, padx=padx)
             video_length = self.video_meta_data[cnt]["video_length_s"]
             video_length_hhmmss = seconds_to_timestamp(seconds=video_length)
-            Label(data_frm, text=video_length_hhmmss, width=max_video_name_len).grid(row=cnt + 1, column=1, sticky=NW)
-            self.entry_boxes[video_name]["start"] = Entry_Box(data_frm, "", 5)
-            self.entry_boxes[video_name]["end"] = Entry_Box(data_frm, "", 5)
-            self.entry_boxes[video_name]["start"].grid(row=cnt + 1, column=2, sticky=NW)
-            self.entry_boxes[video_name]["end"].grid(row=cnt + 1, column=3, sticky=NW)
-
+            SimBALabel(data_frm, txt=video_length_hhmmss, justify='center').grid(row=cnt + 2, column=1, sticky=NW, padx=padx)
+            self.entry_boxes[video_name]["start"] = Entry_Box(data_frm,  fileDescription="", labelwidth=0, justify='center')
+            self.entry_boxes[video_name]["end"] = Entry_Box(data_frm, fileDescription="", labelwidth=0, justify='center')
+            self.entry_boxes[video_name]["start"].grid(row=cnt + 2, column=2, sticky=NW, padx=padx)
+            self.entry_boxes[video_name]["end"].grid(row=cnt + 2, column=3, sticky=NW, padx=padx)
+        data_frm.grid(row=1, column=0, sticky=NW)
         self.create_run_frm(run_function=self.run, btn_txt_clr="blue")
         self.main_frm.mainloop()
 
@@ -1708,11 +1716,11 @@ class ClipMultipleVideosByTimestamps(PopUpMixin):
             check_that_hhmmss_start_is_before_end(start_time=start, end_time=end, name=video_name)
             check_if_hhmmss_timestamp_is_valid_part_of_video(timestamp=start, video_path=self.video_paths[video_name])
             check_if_hhmmss_timestamp_is_valid_part_of_video(timestamp=end, video_path=self.video_paths[video_name])
-            clip_video_in_range(file_path=self.video_paths[video_name], start_time=start, end_time=end, out_dir=self.save_dir, overwrite=True, include_clip_time_in_filename=False, gpu=gpu, quality=quality_pct)
+            clip_video_in_range(file_path=self.video_paths[video_name], start_time=start, end_time=end, out_dir=self.save_dir, overwrite=True, include_clip_time_in_filename=False, gpu=gpu, quality=quality_pct, codec='libx264', verbose=True)
         timer.stop_timer()
         stdout_success(msg=f"{len(self.entry_boxes)} videos clipped by time-stamps and saved in {self.save_dir}", elapsed_time=timer.elapsed_time_str,)
 
-#ClipMultipleVideosByTimestamps(data_dir=r"C:\troubleshooting\mitra\project_folder\videos", save_dir=r"C:\troubleshooting\mitra\project_folder\videos\temp_3")
+#ClipMultipleVideosByTimestamps(data_dir=r"E:\maplight_videos\test_0126", save_dir=r"E:\maplight_videos\clip_test")
 
 
 class InitiateClipMultipleVideosByTimestampsPopUp(PopUpMixin):

simba/ui/tkinter_functions.py

@@ -229,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):
@@ -249,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