SimBA UI pop-ups

simba.ui.pop_ups.about_simba_pop_up module

class simba.ui.pop_ups.about_simba_pop_up.AboutSimBAPopUp(video_path='/home/docs/checkouts/readthedocs.org/user_builds/simba-uw-tf-dev/checkouts/latest/simba/assets/img/landing.mp4', title='ABOUT SIMBA')[source]

Bases: object

on_closing(event=None)[source]

play_video()[source]

simba.ui.pop_ups.append_roi_features_animals_pop_up module

class simba.ui.pop_ups.append_roi_features_animals_pop_up.AppendROIFeaturesByAnimalPopUp(config_path)[source]

Bases: simba.mixins.config_reader.ConfigReader, simba.mixins.pop_up_mixin.PopUpMixin

create_settings_frm()[source]

run()[source]

simba.ui.pop_ups.append_roi_features_bodypart_pop_up module

class simba.ui.pop_ups.append_roi_features_bodypart_pop_up.AppendROIFeaturesByBodyPartPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

run()[source]

simba.ui.pop_ups.archive_files_pop_up module

class simba.ui.pop_ups.archive_files_pop_up.ArchiveProcessedFilesPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

run()[source]

simba.ui.pop_ups.batch_preprocess_pop_up module

class simba.ui.pop_ups.batch_preprocess_pop_up.BatchPreProcessPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

Example

>>> BatchPreProcessPopUp()

run()[source]

simba.ui.pop_ups.clf_add_remove_print_pop_up module

class simba.ui.pop_ups.clf_add_remove_print_pop_up.AddClfPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

run()[source]

class simba.ui.pop_ups.clf_add_remove_print_pop_up.PoseResetterPopUp[source]: Bases: object

class simba.ui.pop_ups.clf_add_remove_print_pop_up.PrintModelInfoPopUp[source]: Bases: simba.mixins.pop_up_mixin.PopUpMixin

class simba.ui.pop_ups.clf_add_remove_print_pop_up.RemoveAClassifierPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

run()[source]

simba.ui.pop_ups.clf_by_roi_pop_up module

class simba.ui.pop_ups.clf_by_roi_pop_up.ClfByROIPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

Example

>>> _ = ClfByROIPopUp(config_path=r"C:      roubleshooting\open_field_below\project_folder\project_config.ini")

run()[source]

simba.ui.pop_ups.clf_by_timebins_pop_up module

class simba.ui.pop_ups.clf_by_timebins_pop_up.TimeBinsClfPopUp(config_path)[source]: Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

simba.ui.pop_ups.clf_descriptive_statistics_pop_up module

class simba.ui.pop_ups.clf_descriptive_statistics_pop_up.ClfDescriptiveStatsPopUp(config_path)[source]: Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

simba.ui.pop_ups.clf_plot_pop_up module

class simba.ui.pop_ups.clf_plot_pop_up.SklearnVisualizationPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

Example

>>> _ = SklearnVisualizationPopUp(config_path=r"C:  roubleshooting\RAT_NOR\project_folder\project_config.ini")

get_bp_probability_threshold()[source]

simba.ui.pop_ups.clf_probability_plot_pop_up module

class simba.ui.pop_ups.clf_probability_plot_pop_up.VisualizeClassificationProbabilityPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

Example

>>> _ = VisualizeClassificationProbabilityPopUp(config_path=r'C:    roubleshooting\RAT_NOR\project_folder\project_config.ini')

simba.ui.pop_ups.clf_validation_plot_pop_up module

class simba.ui.pop_ups.clf_validation_plot_pop_up.ClassifierValidationPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

Example

>>> _ = ClassifierValidationPopUp(config_path=r'C:  roubleshooting\RAT_NOR\project_folder\project_config.ini')

run(multiple)[source]

simba.ui.pop_ups.create_user_defined_pose_configuration_pop_up module

class simba.ui.pop_ups.create_user_defined_pose_configuration_pop_up.CreateUserDefinedPoseConfigurationPopUp(master=None, project_config_class=None)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

create_bodypart_table()[source]

save_pose_config()[source]

validate_unique_entries(body_part_names, animal_ids)[source]

simba.ui.pop_ups.csv_2_parquet_pop_up module

class simba.ui.pop_ups.csv_2_parquet_pop_up.Csv2ParquetPopUp[source]: Bases: simba.mixins.pop_up_mixin.PopUpMixin

class simba.ui.pop_ups.csv_2_parquet_pop_up.Parquet2CsvPopUp[source]: Bases: simba.mixins.pop_up_mixin.PopUpMixin

simba.ui.pop_ups.data_plot_pop_up module

class simba.ui.pop_ups.data_plot_pop_up.DataPlotterPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

Example

>>> _ = DataPlotterPopUp(config_path=r'C:   roubleshooting\RAT_NOR\project_folder\project_config.ini')

simba.ui.pop_ups.directing_other_animals_plot_pop_up module

class simba.ui.pop_ups.directing_other_animals_plot_pop_up.DirectingOtherAnimalsVisualizerPopUp(config_path)[source]: Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

simba.ui.pop_ups.distance_plot_pop_up module

class simba.ui.pop_ups.distance_plot_pop_up.DistancePlotterPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

Example

>>> _ = DistancePlotterPopUp(config_path=r'C:       roubleshooting\RAT_NOR\project_folder\project_config.ini')

simba.ui.pop_ups.fsttc_pop_up module

class simba.ui.pop_ups.fsttc_pop_up.FSTTCPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

run()[source]

simba.ui.pop_ups.gantt_pop_up module

class simba.ui.pop_ups.gantt_pop_up.GanttPlotPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

Example

>>>  _ = GanttPlotPopUp(config_path=r"C:    roubleshooting\RAT_NOR\project_folder\project_config.ini")

simba.ui.pop_ups.heatmap_clf_pop_up module

class simba.ui.pop_ups.heatmap_clf_pop_up.HeatmapClfPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

Example

>>> _ = HeatmapClfPopUp(config_path=r"C:    roubleshooting\RAT_NOR\project_folder\project_config.ini")

simba.ui.pop_ups.heatmap_location_pop_up module

class simba.ui.pop_ups.heatmap_location_pop_up.HeatmapLocationPopup(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

Example

>>> _ = HeatmapLocationPopup(config_path=r"C:       roubleshooting\RAT_NOR\project_folder\project_config.ini")
>>> _ = HeatmapLocationPopup(config_path=r"C:       roubleshooting\mitra\project_folder\project_config.ini")

simba.ui.pop_ups.kleinberg_pop_up module

class simba.ui.pop_ups.kleinberg_pop_up.KleinbergPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

run_kleinberg(behaviors_dict, hierarchical_search)[source]

simba.ui.pop_ups.make_path_plot_pop_up module

class simba.ui.pop_ups.make_path_plot_pop_up.MakePathPlotPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

Tkinter pop-up window for creating simple path plots from pose estimation data.

This pop-up provides a simplified interface to visualize animal movement paths from pose estimation data files (H5 or CSV format). It creates a path plot showing where a selected body-part traveled over time, displayed as a line connecting sequential positions.

The path plot can be created as either: - A video showing the path growing frame-by-frame - A single image showing the complete cumulative path

This tool works independently of SimBA projects and can be used with any pose estimation data file. For more advanced path plots with multiple animals, ROI overlays, classification markers, and other features, use the full “CREATE PATH PLOTS” tool available in the SimBA project interface.

Example

>>> popup = MakePathPlotPopUp()
>>> # User selects video, data file, body-part, and styling options
>>> # Then clicks RUN to generate the path plot

run()[source]

simba.ui.pop_ups.movement_analysis_pop_up module

class simba.ui.pop_ups.movement_analysis_pop_up.MovementAnalysisPopUp(config_path)[source]

Bases: simba.mixins.config_reader.ConfigReader, simba.mixins.pop_up_mixin.PopUpMixin

ANALYZE MOVEMENT / VELOCITY: AGGREGATES UI. SETTINGS can add VIDEO FRAME COUNT and VIDEO LENGTH (HH:MM:SS) rows to Movement_log_*.csv (see Scenario 2 and ROI_tutorial — Distances / velocity).

create_settings_frm(animal_cnt)[source]

run()[source]

simba.ui.pop_ups.movement_analysis_time_bins_pop_up module

class simba.ui.pop_ups.movement_analysis_time_bins_pop_up.MovementAnalysisTimeBinsPopUp(config_path)[source]

Bases: simba.mixins.config_reader.ConfigReader, simba.mixins.pop_up_mixin.PopUpMixin

Tkinter pop-up for defining parameters when computing movements in time-bins.

Example

>>> _ =  MovementAnalysisTimeBinsPopUp(config_path='/Users/simon/Desktop/envs/simba/troubleshooting/two_black_animals_14bp/project_folder/project_config.ini')
>>> _ =  MovementAnalysisTimeBinsPopUp(config_path=r"C:     roubleshooting  wo_black_animals_14bp\project_folder\project_config.ini")

create_bp_frm(animal_cnt)[source]

simba.ui.pop_ups.outlier_settings_pop_up module

class simba.ui.pop_ups.outlier_settings_pop_up.OutlierSettingsPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

Pop-up for setting the movement and location outlier correction criteria of a SimBA project.

Per animal, two body-parts are chosen for the movement criterion and two for the location criterion, together with the criteria multipliers and the aggregation method (mean or median). Pressing CONFIRM writes the settings to the [Outlier settings] section of the project config, where the outlier correctors read them.

simba.ui.pop_ups.path_plot_pop_up module

class simba.ui.pop_ups.path_plot_pop_up.PathPlotPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

enable_clf_location_settings()[source]

populate_body_parts_menu(choice)[source]

populate_clf_location_data()[source]

simba.ui.pop_ups.pose_bp_drop_pop_up module

class simba.ui.pop_ups.pose_bp_drop_pop_up.DropTrackingDataPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

confirm()[source]

run()[source]

simba.ui.pop_ups.pose_reorganizer_pop_up module

class simba.ui.pop_ups.pose_reorganizer_pop_up.PoseReorganizerPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

confirm()[source]

run_reorganization()[source]

simba.ui.pop_ups.pup_retrieval_pop_up module

class simba.ui.pop_ups.pup_retrieval_pop_up.PupRetrievalPopUp(config_path)[source]

Bases: object

run()[source]

simba.ui.pop_ups.quick_path_plot_pop_up module

class simba.ui.pop_ups.quick_path_plot_pop_up.QuickLineplotPopup(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

run()[source]

simba.ui.pop_ups.roi_analysis_pop_up module

class simba.ui.pop_ups.roi_analysis_pop_up.ROIAnalysisPopUp(config_path)[source]

Bases: simba.mixins.config_reader.ConfigReader, simba.mixins.pop_up_mixin.PopUpMixin

Example

>>> _ = ROIAnalysisPopUp(config_path='/Users/simon/Desktop/envs/simba/troubleshooting/two_black_animals_14bp/project_folder/project_config.ini')

create_settings_frm()[source]

run()[source]

simba.ui.pop_ups.roi_analysis_time_bins_pop_up module

class simba.ui.pop_ups.roi_analysis_time_bins_pop_up.ROIAnalysisTimeBinsPopUp(config_path)[source]

Bases: simba.mixins.config_reader.ConfigReader, simba.mixins.pop_up_mixin.PopUpMixin

Example

>>> _ = ROIAnalysisTimeBinsPopUp(config_path='/Users/simon/Desktop/envs/simba/troubleshooting/two_black_animals_14bp/project_folder/project_config.ini')

run()[source]

simba.ui.pop_ups.roi_features_plot_pop_up module

class simba.ui.pop_ups.roi_features_plot_pop_up.VisualizeROIFeaturesPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader, simba.mixins.feature_extraction_mixin.FeatureExtractionMixin

Example

>>> _ = VisualizeROIFeaturesPopUp(config_path='/Users/simon/Desktop/envs/simba/troubleshooting/mouse_open_field/project_folder/project_config.ini')

run(multiple)[source]

simba.ui.pop_ups.roi_tracking_plot_pop_up module

class simba.ui.pop_ups.roi_tracking_plot_pop_up.VisualizeROITrackingPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

Pop-up UI for visualizing ROI tracking overlays on videos.

The interface lets users configure how tracked body-parts, animal names, bounding boxes, and behavior timers are rendered before creating ROI visualization videos using either single-core or multi-core plotting backends.

Parameters: config_path (Union[str, os.PathLike]) – Path to the SimBA project configuration file.
Example

>>> VisualizeROITrackingPopUp(config_path=r"C:      roubleshooting  wo_black_animals_14bp\project_folder\project_config.ini")

run(multiple)[source]

simba.ui.pop_ups.severity_analysis_pop_up module

class simba.ui.pop_ups.severity_analysis_pop_up.AnalyzeSeverityPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

enable_visualization_options()[source]

run()[source]

show_settings(setting)[source]

simba.ui.pop_ups.smoothing_popup module

class simba.ui.pop_ups.smoothing_popup.SmoothingPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

Example

>>> SmoothingPopUp(config_path='/Users/simon/Desktop/envs/simba/troubleshooting/two_black_animals_14bp/project_folder/project_config.ini')

run(multiple)[source]

simba.ui.pop_ups.interpolate_pop_up module

class simba.ui.pop_ups.interpolate_pop_up.InterpolatePopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

Example

>>> InterpolatePopUp(config_path='/Users/simon/Desktop/envs/simba/troubleshooting/two_black_animals_14bp/project_folder/project_config.ini')

run(multiple)[source]

simba.ui.pop_ups.subset_feature_extractor_pop_up module

class simba.ui.pop_ups.subset_feature_extractor_pop_up.FeatureSubsetExtractorPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

Example

>>> FeatureSubsetExtractorPopUp(config_path=r"C:    roubleshooting\mitra\project_folder\project_config.ini")

run()[source]

simba.ui.pop_ups.third_party_annotator_appender_pop_up module

class simba.ui.pop_ups.third_party_annotator_appender_pop_up.ThirdPartyAnnotatorAppenderPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

run()[source]

simba.ui.pop_ups.validation_plot_pop_up module

class simba.ui.pop_ups.validation_plot_pop_up.ValidationVideoPopUp(config_path, feature_path, model_path, discrimination_threshold, shortest_bout)[source]: Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

simba.ui.pop_ups.video_processing_pop_up module

class simba.ui.pop_ups.video_processing_pop_up.BackgroundRemoverDirectoryPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

class simba.ui.pop_ups.video_processing_pop_up.BackgroundRemoverSingleVideoPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

class simba.ui.pop_ups.video_processing_pop_up.BoxBlurPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

class simba.ui.pop_ups.video_processing_pop_up.BrightnessContrastPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

apply()[source]

run_directory()[source]

run_video()[source]

class simba.ui.pop_ups.video_processing_pop_up.CLAHEPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run_directory()[source]

run_single_video()[source]

class simba.ui.pop_ups.video_processing_pop_up.CalculatePixelsPerMMInVideoPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

class simba.ui.pop_ups.video_processing_pop_up.ChangeFpsMultipleVideosPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

class simba.ui.pop_ups.video_processing_pop_up.ChangeFpsSingleVideoPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

class simba.ui.pop_ups.video_processing_pop_up.ChangeImageFormatPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run_img_conversion()[source]

class simba.ui.pop_ups.video_processing_pop_up.ClipMultipleVideosByFrameNumbersPopUp(data_dir, save_dir)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

class simba.ui.pop_ups.video_processing_pop_up.ClipMultipleVideosByTimestamps(data_dir, save_dir)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

example

>>> ClipMultipleVideosByTimestamps(data_dir=r"C:    roubleshooting\RAT_NOR\project_folder

ideos est”, save_dir=r”C: roubleshootingRAT_NORproject_folder ideos estout”)

>>> ClipMultipleVideosByTimestamps(data_dir=r"C:    roubleshooting\mitra\project_folder

ideos”, save_dir=r”C: roubleshootingmitraproject_folder ideos emp_3”)

run()[source]

class simba.ui.pop_ups.video_processing_pop_up.ClipSingleVideoByFrameNumbers[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

class simba.ui.pop_ups.video_processing_pop_up.ClipVideoPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

initiate_clipper()[source]

class simba.ui.pop_ups.video_processing_pop_up.ConcatenatingVideosPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

class simba.ui.pop_ups.video_processing_pop_up.ConcatenatorPopUp(config_path=None)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

populate_table(video_cnt)[source]

run()[source]

class simba.ui.pop_ups.video_processing_pop_up.Convert2AVIPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

Example

>>> Convert2AVIPopUp()

run(multiple)[source]

class simba.ui.pop_ups.video_processing_pop_up.Convert2BlackWhitePopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run(multiple)[source]

class simba.ui.pop_ups.video_processing_pop_up.Convert2MOVPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

Example

>>> Convert2MOVPopUp()

run(multiple)[source]

class simba.ui.pop_ups.video_processing_pop_up.Convert2MP4PopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

Example

>>> Convert2MP4PopUp()

run(multiple)[source]

update_quality_dropdown(k)[source]

class simba.ui.pop_ups.video_processing_pop_up.Convert2PNGPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run_dir()[source]

run_img()[source]

class simba.ui.pop_ups.video_processing_pop_up.Convert2TIFFPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

class simba.ui.pop_ups.video_processing_pop_up.Convert2WEBMPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

Example

>>> Convert2WEBMPopUp()

run(multiple)[source]

class simba.ui.pop_ups.video_processing_pop_up.Convert2WEBPPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run_dir()[source]

run_img()[source]

class simba.ui.pop_ups.video_processing_pop_up.Convert2bmpPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run_dir()[source]

run_img()[source]

class simba.ui.pop_ups.video_processing_pop_up.Convert2jpegPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run_dir()[source]

run_img()[source]

class simba.ui.pop_ups.video_processing_pop_up.ConvertROIDefinitionsPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

class simba.ui.pop_ups.video_processing_pop_up.ConvertVideoPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

convert_single()[source]

class simba.ui.pop_ups.video_processing_pop_up.CreateAverageFramePopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run(multiple)[source]

class simba.ui.pop_ups.video_processing_pop_up.CreateGIFPopUP[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

class simba.ui.pop_ups.video_processing_pop_up.CropVideoCirclesPopUp[source]: Bases: simba.mixins.pop_up_mixin.PopUpMixin

class simba.ui.pop_ups.video_processing_pop_up.CropVideoPolygonsPopUp[source]: Bases: simba.mixins.pop_up_mixin.PopUpMixin

class simba.ui.pop_ups.video_processing_pop_up.CropVideoPopUp[source]: Bases: simba.mixins.pop_up_mixin.PopUpMixin

class simba.ui.pop_ups.video_processing_pop_up.CrossfadeVideosPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

class simba.ui.pop_ups.video_processing_pop_up.DownsampleMultipleVideosPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

downsample_custom()[source]

downsample_default()[source]

class simba.ui.pop_ups.video_processing_pop_up.DownsampleSingleVideoPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

downsample_custom()[source]

downsample_default()[source]

class simba.ui.pop_ups.video_processing_pop_up.DownsampleVideoPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

custom_downsample()[source]

default_downsample()[source]

class simba.ui.pop_ups.video_processing_pop_up.ExtractAllFramesPopUp[source]: Bases: simba.mixins.pop_up_mixin.PopUpMixin

class simba.ui.pop_ups.video_processing_pop_up.ExtractAnnotationFramesPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

Example

>>> ExtractAnnotationFramesPopUp(config_path='/Users/simon/Desktop/envs/simba/troubleshooting/two_black_animals_14bp/project_folder/project_config.ini')

run()[source]

class simba.ui.pop_ups.video_processing_pop_up.ExtractSEQFramesPopUp[source]: Bases: simba.mixins.pop_up_mixin.PopUpMixin

class simba.ui.pop_ups.video_processing_pop_up.ExtractSpecificFramesPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

start_frm_extraction()[source]

class simba.ui.pop_ups.video_processing_pop_up.FlipVideosPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run(multiple)[source]

class simba.ui.pop_ups.video_processing_pop_up.GreyscaleSingleVideoPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run_dir()[source]

run_video()[source]

class simba.ui.pop_ups.video_processing_pop_up.ImportFrameDirectoryPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

run()[source]

class simba.ui.pop_ups.video_processing_pop_up.InitiateClipMultipleVideosByFrameNumbersPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

class simba.ui.pop_ups.video_processing_pop_up.InitiateClipMultipleVideosByTimestampsPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

class simba.ui.pop_ups.video_processing_pop_up.InteractiveClahePopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

apply()[source]

run_directory()[source]

run_video()[source]

class simba.ui.pop_ups.video_processing_pop_up.ManualTemporalJoinPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

select(x)[source]

class simba.ui.pop_ups.video_processing_pop_up.MergeFrames2VideoPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

class simba.ui.pop_ups.video_processing_pop_up.MultiCropPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

class simba.ui.pop_ups.video_processing_pop_up.MultiShortenPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

batch_change(value)[source]

run_clipping()[source]

show_start_stop()[source]

class simba.ui.pop_ups.video_processing_pop_up.ReverseVideoPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run(multiple)[source]

class simba.ui.pop_ups.video_processing_pop_up.RotateVideoSetDegreesPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run(multiple)[source]

class simba.ui.pop_ups.video_processing_pop_up.SuperImposeFrameCountPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

apply()[source]

run_multiple_videos()[source]

run_single_video()[source]

class simba.ui.pop_ups.video_processing_pop_up.SuperimposeProgressBarPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run(multiple)[source]

class simba.ui.pop_ups.video_processing_pop_up.SuperimposeTextPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run(multiple)[source]

class simba.ui.pop_ups.video_processing_pop_up.SuperimposeTimerPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run(multiple)[source]

class simba.ui.pop_ups.video_processing_pop_up.SuperimposeVideoNamesPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run(multiple)[source]

class simba.ui.pop_ups.video_processing_pop_up.SuperimposeVideoPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

class simba.ui.pop_ups.video_processing_pop_up.SuperimposeWatermarkPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run(multiple)[source]

class simba.ui.pop_ups.video_processing_pop_up.UpsampleVideosPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run(multiple)[source]

class simba.ui.pop_ups.video_processing_pop_up.VideoRotatorPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run(input_path, output_path)[source]

class simba.ui.pop_ups.video_processing_pop_up.VideoTemporalJoinPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

simba.ui.pop_ups.visualize_pose_in_dir_pop_up module

class simba.ui.pop_ups.visualize_pose_in_dir_pop_up.VisualizePoseInFolderPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

Example

>>> VisualizePoseInFolderPopUp()

run(directory)[source]

simba.ui.pop_ups.animal_directing_other_animals_pop_up module

class simba.ui.pop_ups.animal_directing_other_animals_pop_up.AnimalDirectingAnimalPopUp(config_path)[source]

Bases: simba.mixins.config_reader.ConfigReader, simba.mixins.pop_up_mixin.PopUpMixin

Example

>>> test = AnimalDirectingAnimalPopUp(config_path=r"C:      roubleshooting  wo_black_animals_14bp\project_folder\project_config.ini")

run()[source]

simba.ui.pop_ups.animal_directing_roi_pop_up module

class simba.ui.pop_ups.animal_directing_roi_pop_up.AnimalDirectingROIPopUp(config_path)[source]

Bases: simba.mixins.config_reader.ConfigReader, simba.mixins.pop_up_mixin.PopUpMixin

Pop-up window for analyzing directionality between animals and ROIs.

Parameters: config_path (Union[str, os.PathLike]) – Path to SimBA project config file in Configparser format.
Example

>>> test = AnimalDirectingROIPopUp(config_path=r"C:\troubleshooting\two_black_animals_14bp\project_folder\project_config.ini")

run()[source]

simba.ui.pop_ups.annotated_bouts_videos_pop_up module

class simba.ui.pop_ups.annotated_bouts_videos_pop_up.AnnotatedBoutsVideoPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

Example

>>> _ = AnnotatedBoutsVideoPopUp(config_path=r"C:\troubleshooting\project_folder\project_config.ini")

run()[source]

simba.ui.pop_ups.blob_visualizer_pop_up module

class simba.ui.pop_ups.blob_visualizer_pop_up.BlobVisualizerPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

simba.ui.pop_ups.boolean_conditional_slicer_pup_up module

class simba.ui.pop_ups.boolean_conditional_slicer_pup_up.BooleanConditionalSlicerPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

Example

>>> roi_featurizer = BooleanConditionalSlicerPopUp(config_path=r"C: roubleshooting\RAT_NOR\project_folder\project_config.ini")

create_rules_frames(rules_cnt)[source]

run()[source]

simba.ui.pop_ups.change_speed_popup module

class simba.ui.pop_ups.change_speed_popup.ChangeSpeedPopup[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run(multiple)[source]

simba.ui.pop_ups.check_videos_seekable_pop_up module

class simba.ui.pop_ups.check_videos_seekable_pop_up.CheckVideoSeekablePopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

GUI pop-up window for checking if a video, or a directory of videos, are seekable.

Example

_ = CheckVideoSeekablePopUp()

run(directory)[source]

simba.ui.pop_ups.clf_annotation_counts_pop_up module

class simba.ui.pop_ups.clf_annotation_counts_pop_up.ClfAnnotationCountPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

Example

>>> ClfAnnotationCountPopUp(config_path='/Users/simon/Desktop/envs/simba/troubleshooting/two_black_animals_14bp/project_folder/project_config.ini')

run()[source]

simba.ui.pop_ups.coco_keypoints_to_yolo_popup module

class simba.ui.pop_ups.coco_keypoints_to_yolo_popup.COCOKeypoints2YOLOkeypointsPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

simba.ui.pop_ups.cue_light_clf_analyzer_popup module

class simba.ui.pop_ups.cue_light_clf_analyzer_popup.CueLightClfAnalyzerPopUp(config_path, cue_light_names, data_dir=None)[source]

Bases: simba.mixins.config_reader.ConfigReader, simba.mixins.pop_up_mixin.PopUpMixin

Example

>>> CueLightClfAnalyzerPopUp(config_path=r"C:       roubleshooting\cue_light        1\project_folder\project_config.ini", cue_light_names=['cl'])

run()[source]

simba.ui.pop_ups.cue_light_data_analyzer_popup module

class simba.ui.pop_ups.cue_light_data_analyzer_popup.CueLightDataAnalyzerPopUp(config_path, cue_light_names, data_dir=None)[source]

Bases: simba.mixins.config_reader.ConfigReader, simba.mixins.pop_up_mixin.PopUpMixin

Example

>>> CueLightDataAnalyzerPopUp(config_path=r"C:      roubleshooting\cue_light        1\project_folder\project_config.ini", cue_light_names=['cl'])

run()[source]

simba.ui.pop_ups.cue_light_main_popup module

class simba.ui.pop_ups.cue_light_main_popup.CueLightMainPopUp(config_path)[source]

Bases: simba.mixins.config_reader.ConfigReader, simba.mixins.pop_up_mixin.PopUpMixin

Launch cue light analysis GUI in SimBA.

Parameters: config_path (str) – path to SimBA project config file in Configparser format

Note

Cue light tutorials.

Examples

>>> test = CueLightMainPopUp(config_path=r"C:       roubleshooting\cue_light        1\project_folder\project_config.ini")

simba.ui.pop_ups.cue_light_movement_analyzer_popup module

class simba.ui.pop_ups.cue_light_movement_analyzer_popup.CueLightMovementAnalyzerPopUp(config_path, cue_light_names, data_dir=None)[source]

Bases: simba.mixins.config_reader.ConfigReader, simba.mixins.pop_up_mixin.PopUpMixin

Example

>>> CueLightMovementAnalyzerPopUp(config_path=r"C:  roubleshooting\cue_light        1\project_folder\project_config.ini", cue_light_names=['cl'])

run()[source]

simba.ui.pop_ups.cue_light_visualizer_popup module

class simba.ui.pop_ups.cue_light_visualizer_popup.CueLightVisulizerPopUp(config_path, cue_light_names, data_dir=None)[source]

Bases: simba.mixins.config_reader.ConfigReader, simba.mixins.pop_up_mixin.PopUpMixin

Example

>>> CueLightVisulizerPopUp(config_path=r"C: roubleshooting\cue_light        1\project_folder\project_config.ini", cue_light_names=['cl'])

run()[source]

simba.ui.pop_ups.delete_all_rois_pop_up module

simba.ui.pop_ups.delete_all_rois_pop_up.delete_all_rois_pop_up(config_path, roi_table_frm=None)[source]

Launches a pop-up asking if to delete all SimBA roi definitions. If click yes, then the /project_folder/logs/measures/ROI_definitions.h5 of the SimBA project is deleted.

Parameters

config_path (Union[str, os.PathLike]) – Path to SimBA project config file (e.g. project_config.ini).
roi_table_frm (Optional[Any]) – Optional frame or widget with a refresh_window() method. If provided and the user confirms deletion, it is called to refresh the ROI table UI. Default: None.

Returns

None

Example

>>> delete_all_rois_pop_up(config_path=r"C: roubleshooting\ROI_movement_test\project_folder\project_config.ini")
>>> delete_all_rois_pop_up(config_path=config_path, roi_table_frm=roi_table_frm)

simba.ui.pop_ups.directing_animal_to_bodypart_plot_pop_up module

class simba.ui.pop_ups.directing_animal_to_bodypart_plot_pop_up.DirectingAnimalToBodyPartVisualizerPopUp(config_path)[source]: Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

simba.ui.pop_ups.direction_animal_to_bodypart_settings_pop_up module

class simba.ui.pop_ups.direction_animal_to_bodypart_settings_pop_up.DirectionAnimalToBodyPartSettingsPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

run()[source]

simba.ui.pop_ups.distance_analysis_pop_up module

class simba.ui.pop_ups.distance_analysis_pop_up.DistanceAnalysisPopUp(config_path)[source]

Bases: simba.mixins.config_reader.ConfigReader, simba.mixins.pop_up_mixin.PopUpMixin

create_settings_frm(bp_pair_cnt)[source]

run()[source]

simba.ui.pop_ups.distance_timebins_popup module

class simba.ui.pop_ups.distance_timebins_popup.TimBinDistanceAnalysisPopUp(config_path)[source]

Bases: simba.mixins.config_reader.ConfigReader, simba.mixins.pop_up_mixin.PopUpMixin

create_settings_frm(bp_pair_cnt)[source]

run()[source]

simba.ui.pop_ups.dlc_annotations_to_labelme_popup module

class simba.ui.pop_ups.dlc_annotations_to_labelme_popup.DLCAnnotations2LabelMePopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

Example

>>> DLCAnnotations2LabelMePopUp()

run()[source]

simba.ui.pop_ups.dlc_h5_inference_to_yolo_popup module

class simba.ui.pop_ups.dlc_h5_inference_to_yolo_popup.DLCH5Inference2YoloPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

GUI for converting DeepLabCut (DLC) annotations to YOLO keypoint format.

Example

>>> DLCH5Inference2YoloPopUp()

run()[source]

simba.ui.pop_ups.dlc_to_labelme_popup module

class simba.ui.pop_ups.dlc_to_labelme_popup.DLC2LabelmePopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

GUI for converting DeepLabCut (DLC) annotations to YOLO keypoint format.

Example

>>> DLC2LabelmePopUp()

run()[source]

simba.ui.pop_ups.dlc_to_yolo_keypoints_popup module

class simba.ui.pop_ups.dlc_to_yolo_keypoints_popup.DLCYoloKeypointsPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

GUI for converting DeepLabCut (DLC) annotations to YOLOv8 keypoint format.

Example

>>> DLCYoloKeypointsPopUp()

run()[source]

simba.ui.pop_ups.duplicate_rois_by_source_target_popup module

class simba.ui.pop_ups.duplicate_rois_by_source_target_popup.DuplicateROIsBySourceTarget(config_path, roi_data_path=None, roi_table_popup=None)[source]

Bases: simba.mixins.config_reader.ConfigReader, simba.mixins.pop_up_mixin.PopUpMixin

get_selection_options_frm()[source]

set_check_idx(video_idx, video_name)[source]

set_status_bar_panel(text, fg='blue')[source]

simba.ui.pop_ups.egocentric_alignment_pop_up module

class simba.ui.pop_ups.egocentric_alignment_pop_up.EgocentricAlignPopUp(config_path)[source]

Bases: simba.mixins.config_reader.ConfigReader, simba.mixins.pop_up_mixin.PopUpMixin

Example

>>> _ = EgocentricAlignPopUp(config_path=r"C:       roubleshooting\mitra\project_folder\project_config.ini")

run()[source]

simba.ui.pop_ups.ez_path_plot_popup module

class simba.ui.pop_ups.ez_path_plot_popup.EzPathPlotPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

Tkinter pop-up for creating simple (EZ) path plots from project pose data.

Parameters: config_path (Union[str, os.PathLike]) – Path to the SimBA project config file (e.g. project_folder/project_config.ini). The project must contain pose data in the outlier-corrected CSV directory.
Example

>>> EzPathPlotPopUp(config_path=r'project_folder/project_config.ini')

run()[source]

simba.ui.pop_ups.helpers module

simba.ui.pop_ups.helpers.restart_roi_video_table(roi_video_table_popup, config_path)[source]

simba.ui.pop_ups.import_roi_csv_popup module

class simba.ui.pop_ups.import_roi_csv_popup.ROIDefinitionsCSVImporterPopUp(config_path, roi_table_frm=None)[source]

Bases: simba.mixins.config_reader.ConfigReader, simba.mixins.pop_up_mixin.PopUpMixin

Example

>>> ROIDefinitionsCSVImporterPopUp(config_path=r"C: roubleshooting\mouse_open_field\project_folder\project_config.ini")

run()[source]

simba.ui.pop_ups.initialize_blob_tracking_pop_up module

class simba.ui.pop_ups.initialize_blob_tracking_pop_up.InitializeBlobTrackerPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

Example

>>> InitializeBlobTrackerPopUp()

run()[source]

simba.ui.pop_ups.labelme_bbox_to_yolo_bbox_popup module

class simba.ui.pop_ups.labelme_bbox_to_yolo_bbox_popup.LabelmeBbox2YoloBboxPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

>>> LabelmeBbox2YoloBboxPopUp()

run()[source]

simba.ui.pop_ups.labelme_dir_to_csv_popup module

class simba.ui.pop_ups.labelme_dir_to_csv_popup.LabelmeDirectory2CSVPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

Example

>>> LabelmeDirectory2CSVPopUp()

run()[source]

simba.ui.pop_ups.labelme_to_df_popup module

class simba.ui.pop_ups.labelme_to_df_popup.Labelme2DataFramePopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

Example

>>> Labelme2DataFramePopUp()

run()[source]

simba.ui.pop_ups.labelme_to_imgs_popup module

class simba.ui.pop_ups.labelme_to_imgs_popup.Labelme2ImgsPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

Example

>>> Labelme2ImgsPopUp()

run()[source]

simba.ui.pop_ups.merge_coco_keypoint_files_pop_up module

class simba.ui.pop_ups.merge_coco_keypoint_files_pop_up.MergeCOCOKeypointFilesPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

simba.ui.pop_ups.min_max_draw_size_popup module

class simba.ui.pop_ups.min_max_draw_size_popup.SetMinMaxDrawWindowSize(config_path)[source]

Bases: simba.mixins.config_reader.ConfigReader, simba.mixins.pop_up_mixin.PopUpMixin

run()[source]

simba.ui.pop_ups.multiple_videos_to_frames_popup module

class simba.ui.pop_ups.multiple_videos_to_frames_popup.MultipleVideos2FramesPopUp[source]: Bases: simba.mixins.pop_up_mixin.PopUpMixin

simba.ui.pop_ups.mutual_exclusivity_pop_up module

class simba.ui.pop_ups.mutual_exclusivity_pop_up.MutualExclusivityPupUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

change_threshold_status(rule_cnt)[source]

change_winner_status(rule_cnt)[source]

create_rules_frames(rules_cnt)[source]

run()[source]

simba.ui.pop_ups.print_video_meta_popup module

class simba.ui.pop_ups.print_video_meta_popup.PrintVideoMetaDataPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

run(directory)[source]

simba.ui.pop_ups.remove_roi_features_pop_up module

class simba.ui.pop_ups.remove_roi_features_pop_up.RemoveROIFeaturesPopUp(config_path, dataset)[source]: Bases: object

simba.ui.pop_ups.roi_aggregate_stats_popup module

class simba.ui.pop_ups.roi_aggregate_stats_popup.ROIAggregateDataAnalyzerPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

Example

>>> analyzer = ROIAggregateDataAnalyzerPopUp(config_path=r"C:       roubleshooting\mitra\project_folder\project_config.ini")

run()[source]

simba.ui.pop_ups.roi_directing_visualizer_pop_up module

class simba.ui.pop_ups.roi_directing_visualizer_pop_up.DirectingROIVisualizerPopUp(config_path)[source]

Bases: simba.mixins.config_reader.ConfigReader, simba.mixins.pop_up_mixin.PopUpMixin

Pop-up window for visualizing when animals are directing towards ROIs.

Parameters: config_path (Union[str, os.PathLike]) – Path to SimBA project config file in Configparser format.
Example

>>> _ = DirectingROIVisualizerPopUp(config_path=r"C:\troubleshooting\two_black_animals_14bp\project_folder\project_config.ini")

run(multiple)[source]

simba.ui.pop_ups.roi_size_standardizer_popup module

class simba.ui.pop_ups.roi_size_standardizer_popup.ROISizeStandardizerPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

run()[source]

simba.ui.pop_ups.roi_video_table_pop_up module

class simba.ui.pop_ups.roi_video_table_pop_up.ROITableRow(config_path, parent, video_path, str_width, row_idx, videos_w_rois, video_table_window)[source]

Bases: object

Helper to create a single row class in the simba.ui.pop_ups.roi_video_table_pop_up.ROIVideoTable() table class.

apply_to_all(config_path, video_path)[source]

draw(config_path, video_path)[source]

reset(config_path, video_path)[source]

class simba.ui.pop_ups.roi_video_table_pop_up.ROIVideoTable(config_path, roi_data_path=None)[source]

Bases: simba.mixins.config_reader.ConfigReader, simba.mixins.pop_up_mixin.PopUpMixin

Crates a tkinter video table listing all videos in project together with buttons associated with ROI drawing, deletaing, and duplicating shapes.

Example

>>> ROIVideoTable(config_path=r"C:  roubleshooting\mouse_open_field\project_folder\project_config.ini")

get_file_menu()[source]

refresh_window()[source]

run()[source]

simba.ui.pop_ups.run_machine_models_popup module

class simba.ui.pop_ups.run_machine_models_popup.RunMachineModelsPopUp(config_path)[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin, simba.mixins.config_reader.ConfigReader

Example

>>> _ = RunMachineModelsPopUp(config_path='/Users/simon/Desktop/envs/simba/troubleshooting/two_black_animals_14bp/project_folder/project_config.ini')

run()[source]

simba.ui.pop_ups.select_video_for_labelling_popup module

class simba.ui.pop_ups.select_video_for_labelling_popup.SelectLabellingVideoPupUp(config_path, continuing=False)[source]

Bases: object

Launch PopUp to select video for labelling

Example

>>> SelectLabellingVideoPupUp(config_path=r"C:      roubleshooting\mitra\project_folder\project_config.ini", continuing=False)

simba.ui.pop_ups.select_video_for_pseudo_labelling_popup module

class simba.ui.pop_ups.select_video_for_pseudo_labelling_popup.SelectPseudoLabellingVideoPupUp(config_path)[source]

Bases: simba.mixins.config_reader.ConfigReader, simba.mixins.pop_up_mixin.PopUpMixin

Launch PopUp to select video for labelling

Example

>>> SelectPseudoLabellingVideoPupUp(config_path=r"C:        roubleshooting\mitra\project_folder\project_config.ini")

simba.ui.pop_ups.simba_rois_to_yolo_pop_up module

class simba.ui.pop_ups.simba_rois_to_yolo_pop_up.SimBAROIs2YOLOPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

Example

>>> SimBAROIs2YOLOPopUp()

run()[source]

simba.ui.pop_ups.simba_to_yolo_keypoints_popup module

class simba.ui.pop_ups.simba_to_yolo_keypoints_popup.SimBA2YoloKeypointsPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

Example

>>> SimBA2YoloKeypointsPopUp()

run()[source]

simba.ui.pop_ups.single_video_to_frames_popup module

class simba.ui.pop_ups.single_video_to_frames_popup.SingleVideo2FramesPopUp[source]: Bases: simba.mixins.pop_up_mixin.PopUpMixin

simba.ui.pop_ups.sleap_annotations_to_yolo_popup module

class simba.ui.pop_ups.sleap_annotations_to_yolo_popup.SLEAPAnnotations2YoloPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

GUI for converting DeepLabCut (DLC) annotations to YOLOv8 keypoint format.

Example

>>> SLEAPAnnotations2YoloPopUp()

run()[source]

simba.ui.pop_ups.sleap_csv_predictions_to_yolo_popup module

class simba.ui.pop_ups.sleap_csv_predictions_to_yolo_popup.SLEAPcsvInference2Yolo[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

GUI for converting DeepLabCut (DLC) annotations to YOLOv8 keypoint format.

Example

>>> SLEAPcsvInference2Yolo()

run()[source]

simba.ui.pop_ups.sleap_h5_inference_to_yolo_popup module

class simba.ui.pop_ups.sleap_h5_inference_to_yolo_popup.SLEAPH5Inference2YoloPopUp[source]

Bases: simba.mixins.pop_up_mixin.PopUpMixin

Example

>>> SLEAPH5Inference2YoloPopUp()

run()[source]

simba.ui.pop_ups.splash_popup module

class simba.ui.pop_ups.splash_popup.SplashMovie(outline_color=(255, 192, 203), fill_color=(255, 255, 255), font_path=PosixPath('assets/fonts/Poppins Regular.ttf'), font_size_height=0.05)[source]

Bases: object

add_welcome_text(pil_image)[source]

show_animation()[source]

simba.ui.pop_ups.spontaneous_alternation_pop_up module

class simba.ui.pop_ups.spontaneous_alternation_pop_up.SpontaneousAlternationPopUp(config_path)[source]

Bases: simba.mixins.config_reader.ConfigReader, simba.mixins.pop_up_mixin.PopUpMixin

Pop-up window for setting spontaneous alternation parameters and running spontaneous alternation analysis and visualizations.

Example

>>> _ = SpontaneousAlternationPopUp(config_path='/Users/simon/Desktop/envs/simba/troubleshooting/spontenous_alternation/project_folder/project_config.ini')