boris-behav-obs 8.9.16__py3-none-any.whl → 9.7.6__py3-none-any.whl

boris/config.py

@@ -1,7 +1,7 @@
 """
 BORIS
 Behavioral Observation Research Interactive Software
-Copyright 2012-2023 Olivier Friard
+Copyright 2012-2025 Olivier Friard
 
 This file is part of BORIS.
 
@@ -22,12 +22,27 @@ This file is part of BORIS.
 
 programName: str = "BORIS"
 
+# socket for MPV IPC mode
+MPV_SOCKET = "/tmp/mpvsocket"
+
+
+ETHOGRAM_REPOSITORY_URL = "https://www.boris.unito.it/static/ethograms"
+
 project_format_version: str = "7.0"
 
+SECONDS_PER_DAY: int = 86_400
+
+# cutoff value for displaying HH:MM:SS.zzz or YYYY-mm-DD HH:MM:SS:ZZZ
+HOUR_CUTOFF: int = 7 * 24
+DATE_CUTOFF: int = HOUR_CUTOFF * 60 * 60  # 1 week
+
+# cutoff for displaying time in HH:MM:SS.zzz format
+SMART_TIME_CUTOFF_DEFAULT: int = 300
+
 # minimal project version for handling observations from images
 IMAGES_OBS_PROJECT_MIN_VERSION: tuple = (8, 6)
 
-IMAGE_EXTENSIONS: tuple = ("*.jpg", "*.png", "*.jpeg")
+IMAGE_EXTENSIONS: tuple = ("*.jpg", "*.png", "*.jpeg", "*.tiff", "*.tif", "*.webp", "*.bmp")
 
 CHECK_NEW_VERSION_DELAY: int = 15 * 24 * 60 * 60
 
@@ -37,9 +52,14 @@ MAX_UNDO_QUEUE: int = 25
 
 NA: str = "NA"
 
-CTRL_KEY = "Ctrl"
+REALTIME_PLOT_CURSOR_COLOR: str = "red"
+
+DARKER_DIFFERENCE = 5
 
-SPECTRO_TIMER = 500
+CTRL_KEY: str = "Ctrl"
+ALT_KEY: str = "Alt"
+
+SPECTRO_TIMER: int = 500
 
 function_keys = {
     16777264: "F1",
@@ -68,10 +88,12 @@ EVENTS = "events"
 TIME_OFFSET = "time offset"
 
 CODING_MAP = "coding_map"
+CODING_MAP_sp = "coding map"  # space between words (no underscore)
 BEHAVIORS_CODING_MAP = "behaviors_coding_map"
 SUBJECTS = "subjects_conf"
 ETHOGRAM = "behaviors_conf"
 BEHAVIORAL_CATEGORIES = "behavioral_categories"
+BEHAVIORAL_CATEGORIES_CONF = "behavioral_categories_config"
 CONVERTERS = "converters"
 
 OFFSET = "offset"
@@ -110,20 +132,34 @@ POINT_EVENT_PLOT_COLOR = "black"
 
 CHAR_FORBIDDEN_IN_MODIFIERS = "(|),`~"
 
+FAST_FORWARD_DEFAULT_VALUE: float = 10.0
+
 ADAPT_FAST_JUMP = "adapt_fast_jump"
 ADAPT_FAST_JUMP_DEFAULT = False
 
+TIME = "time"
+BEHAVIOR_CODE = "code"
+SUBJECT = "subject"
+MODIFIER = "modifier"
+COMMENT = "comment"
+BEHAVIOR_KEY = "key"
+SUBJECT_KEY = "key"
+BEHAVIOR_CATEGORY = "category"
+
 
-subjectsFields = ["key", SUBJECT_NAME, DESCRIPTION]
+subjectsFields = [SUBJECT_KEY, SUBJECT_NAME, DESCRIPTION]
 
 UNPAIRED = "UNPAIRED"
 DISPLAY_SUBTITLES = "display_subtitles"
+CHECK_PROJECT_INTEGRITY = "check_project_integrity"
 
 
 YES = "Yes"
 NO = "No"
 CANCEL = "Cancel"
+IGNORE = "Ignore"
 APPEND = "Append"
+CLOSE = "Close"
 REPLACE = "Replace"
 REMOVE = "Remove"
 SAVE = "Save"
@@ -138,6 +174,7 @@ NO_FOCAL_SUBJECT = "No focal subject"
 
 TYPE = "type"
 FILE = "file"
+COLOR = "color"
 DIRECTORIES_LIST = "directories_list"
 
 SAVE_DATASET = 32
@@ -167,49 +204,37 @@ DATA_PLOT_FIELDS = {
 }
 DATA_PLOT_STYLES = ["b-", "r-", "g-", "bo", "ro", "go"]
 
-TIME = "time"
-BEHAVIOR_CODE = "code"
-SUBJECT = "subject"
-MODIFIER = "modifier"
-COMMENT = "comment"
-BEHAVIOR_KEY = "key"
-BEHAVIOR_CATEGORY = "category"
 
 FILE_PATH = "file_path"
 
 IMAGE_INDEX = "image index"
 IMAGE_PATH = "image path"
+FRAME_INDEX = "frame index"
 
 ZOOM_LEVEL = "zoom level"
+PAN_X = "pan-x"
+PAN_Y = "pan-y"
+ROTATION_ANGLE = "rotation angle"
 DISPLAY_MEDIA_SUBTITLES = "display subtitles"
 OVERLAY = "video overlay"
 
 
 USE_EXIF_DATE = "use_exif_date"
+SUBSTRACT_FIRST_EXIF_DATE = "substract_first_exif_date"
 TIME_LAPSE = "time_lapse_delay"
 
 
 # fields for event configuration
-"""
-fields = {
-    "type": 0,
-    "key": 1,
-    "code": 2,
-    "description": 3,
-    "modifiers": 4,
-    "excluded": 5,
-    "coding map": 6,
-}
-"""
 
 ETHOGRAM_TABLE_COLUMNS: dict = {
     0: "key",
     1: "code",
     2: "type",
     3: "description",
-    4: "category",
-    5: "modifiers",
-    6: "excluded",
+    4: "color",
+    5: "category",
+    6: "modifiers",
+    7: "excluded",
 }
 
 # fields in ethogram table from project window
@@ -218,23 +243,12 @@ behavioursFields: dict = {
     "key": 1,
     "code": 2,
     "description": 3,
-    "category": 4,
-    "modifiers": 5,
-    "excluded": 6,
-    "coding map": 7,
+    "color": 4,
+    "category": 5,
+    "modifiers": 6,
+    "excluded": 7,
+    "coding map": 8,
 }
-"""
-ETHOGRAM_FIELDS = [
-    "type",
-    "key",
-    "code",
-    "description",
-    "category",
-    "modifiers",
-    "excluded",
-    "coding map",
-]
-"""
 ETHOGRAM_EDITABLE_FIELDS: tuple = ("key", "code", "description")
 
 PROJECT_BEHAVIORS_KEY_FIELD_IDX = 1
@@ -244,21 +258,32 @@ MEDIA_FILE_PATH_IDX = 2
 HAS_AUDIO_IDX = 6
 
 STATE_EVENT = "State event"
+STATE_EVENT_WITH_CODING_MAP = "State event with coding map"
+
+STATE_EVENT_TYPES = [STATE_EVENT, STATE_EVENT_WITH_CODING_MAP]
+
 POINT_EVENT = "Point event"
+POINT_EVENT_WITH_CODING_MAP = "Point event with coding map"
+
+POINT_EVENT_TYPES = [POINT_EVENT, POINT_EVENT_WITH_CODING_MAP]
 
 BEHAVIOR_TYPES = [
-    "Point event",
-    "State event",
-    "Point event with coding map",
-    "State event with coding map",
+    POINT_EVENT,
+    STATE_EVENT,
+    POINT_EVENT_WITH_CODING_MAP,
+    STATE_EVENT_WITH_CODING_MAP,
 ]
 
 DEFAULT_BEHAVIOR_TYPE = "Point event"
 
-# fields for events table
-MEDIA_TW_EVENTS_FIELDS = ("time", "subject", "code", "type", "modifier", "comment")
+MEDIA_TW_EVENTS_FIELDS_DEFAULT = ("time", FRAME_INDEX, "subject", "code", "type", "modifier", "comment")
+
+
+# fields for events tablewidget
+MEDIA_TW_EVENTS_FIELDS = ("time", FRAME_INDEX, "subject", "code", "type", "modifier", "comment")
+# MEDIA_TW_EVENTS_FIELDS = ("time", "subject", "code", "type", "modifier", "comment")
 LIVE_TW_EVENTS_FIELDS = ("time", "subject", "code", "type", "modifier", "comment")
-IMAGES_TW_EVENTS_FIELDS = ("time", "subject", "code", "type", "modifier", "comment", "image index", "image path")
+IMAGES_TW_EVENTS_FIELDS = ("time", "subject", "code", "type", "modifier", "comment", IMAGE_INDEX, IMAGE_PATH)
 
 TW_EVENTS_FIELDS = {
     MEDIA: MEDIA_TW_EVENTS_FIELDS,
@@ -269,7 +294,7 @@ TW_EVENTS_FIELDS = {
     VIEWER_IMAGES: IMAGES_TW_EVENTS_FIELDS,
 }
 
-# create dictionaries
+# create dictionary index
 TW_OBS_FIELD = {}
 for observation_type in TW_EVENTS_FIELDS:
     TW_OBS_FIELD[observation_type] = {}
@@ -278,9 +303,9 @@ for observation_type in TW_EVENTS_FIELDS:
 
 
 # fields for project events list
-MEDIA_PJ_EVENTS_FIELDS = ("time", "subject", "code", "modifier", "comment")
-LIVE_PJ_EVENTS_FIELDS = ("time", "subject", "code", "modifier", "comment")
-IMAGES_PJ_EVENTS_FIELDS = ("time", "subject", "code", "modifier", "comment", "image index", "image path")
+MEDIA_PJ_EVENTS_FIELDS = (TIME, "subject", "code", "modifier", "comment", FRAME_INDEX)
+LIVE_PJ_EVENTS_FIELDS = (TIME, "subject", "code", "modifier", "comment")
+IMAGES_PJ_EVENTS_FIELDS = (TIME, "subject", "code", "modifier", "comment", IMAGE_INDEX, IMAGE_PATH)
 
 PJ_EVENTS_FIELDS = {
     MEDIA: MEDIA_PJ_EVENTS_FIELDS,
@@ -291,9 +316,6 @@ PJ_EVENTS_FIELDS = {
     VIEWER_IMAGES: IMAGES_PJ_EVENTS_FIELDS,
 }
 
-# fields for independent variable definition
-tw_indVarFields = ["label", "description", "type", "default value", "possible values"]
-
 
 PJ_OBS_FIELDS = {}
 for observation_type in PJ_EVENTS_FIELDS:
@@ -301,14 +323,19 @@ for observation_type in PJ_EVENTS_FIELDS:
     for idx, field in enumerate(PJ_EVENTS_FIELDS[observation_type]):
         PJ_OBS_FIELDS[observation_type][field] = idx
 
+
+# fields for independent variable definition
+tw_indVarFields = ["label", "description", "type", "default value", "possible values"]
+
+
 EVENT_TIME_FIELD_IDX = 0
 EVENT_SUBJECT_FIELD_IDX = 1
 EVENT_BEHAVIOR_FIELD_IDX = 2
 EVENT_MODIFIER_FIELD_IDX = 3
 EVENT_COMMENT_FIELD_IDX = 4
-EVENT_STATUS_FIELD_IDX = 5
+EVENT_STATUS_FIELD_IDX = -1
 # EVENT_IMAGEIDX_FIELD_IDX = 6
-EVENT_IMAGEPATH_FIELD_IDX = 7
+# EVENT_IMAGEPATH_FIELD_IDX = 7
 
 
 BEHAV_CODING_MAP_FIELDS = ["name", "Behavior codes"]
@@ -331,6 +358,14 @@ START_FROM_CURRENT_EPOCH_TIME = "start_from_current_epoch_time"
 
 SCAN_SAMPLING_TIME = "scan_sampling_time"
 
+POINT_OBJECT = "Point"
+SEGMENT_OBJECT = "Segment"
+ANGLE_OBJECT = "Angle"
+ORIENTED_ANGLE_OBJECT = "Oriented angle"
+POLYGON_OBJECT = "Polygon"
+POLYLINE_OBJECT = "Polyline"
+
+
 NEW = "new"
 LIST = "list"
 EDIT = "edit"
@@ -350,6 +385,7 @@ SELECTED_BEHAVIORS = "selected behaviors"
 SELECTED_SUBJECTS = "selected subjects"
 INCLUDE_MODIFIERS = "include modifiers"
 EXCLUDE_BEHAVIORS = "exclude behaviors"
+EXCLUDE_NON_CODED_MODIFIERS = "exclude_non_coded_modifiers"
 EXCLUDED_BEHAVIORS = "excluded behaviors"
 TIME_INTERVAL = "time"
 START_TIME = "start time"
@@ -367,6 +403,7 @@ TIMESTAMP_idx = 3
 
 TIME_FULL_OBS = "full obs"
 TIME_EVENTS = "limit to events"
+TIME_OBS_INTERVAL = "interval of observation"
 TIME_ARBITRARY_INTERVAL = "time interval"
 
 AVAILABLE_INDEP_VAR_TYPES = [NUMERIC, TEXT, SET_OF_VALUES, TIMESTAMP]
@@ -376,16 +413,31 @@ OBSERVATIONS = "observations"
 
 CLOSE_BEHAVIORS_BETWEEN_VIDEOS = "close_behaviors_between_videos"
 
-MPV_HWDEC_OPTIONS = ("auto", "auto-safe", "no")
-MPV_HWDEC_DEFAULT_VALUE = "auto"
+# MPV hardware decode
 MPV_HWDEC = "mpv_hwdec"
+MPV_HWDEC_NO = "no"
+MPV_HWDEC_AUTO = "auto"
+MPV_HWDEC_AUTOSAFE = "auto-safe"
+MPV_HWDEC_OPTIONS = (MPV_HWDEC_AUTO, MPV_HWDEC_AUTOSAFE, MPV_HWDEC_NO)
+MPV_HWDEC_DEFAULT_VALUE = MPV_HWDEC_AUTO
 
+# frame step size (disabled)
+# FRAME_STEP_SIZE: str = "frame_step_size"
+# FRAME_STEP_SIZE_DEFAULT_VALUE: int = 1
+
+ANALYSIS_PLUGINS = "analysis_plugins"
+EXCLUDED_PLUGINS = "excluded_plugins"
+PERSONAL_PLUGINS_DIR = "personal_plugins_dir"
 
 PROJECT_FILE_INDENTATION = "project file indentation"
 PROJECT_FILE_INDENTATION_COMBO_OPTIONS = ("None", "Newline", "Tab", "2 spaces", "4 spaces")
 PROJECT_FILE_INDENTATION_OPTIONS = (None, 0, "\t", 2, 4)
 PROJECT_FILE_INDENTATION_DEFAULT_VALUE = None
 
+TOOLBAR_ICON_SIZE = "toolbar icon size"
+DEFAULT_TOOLBAR_ICON_SIZE_VALUE = 24
+
+
 VIDEO_VIEWER = 0
 PICTURE_VIEWER = 1
 
@@ -402,6 +454,7 @@ LENGTH = "length"
 FPS = "fps"
 HAS_AUDIO = "hasAudio"
 HAS_VIDEO = "hasVideo"
+MEDIA_CREATION_TIME = "media_creation_time"
 
 STATE = "STATE"
 POINT = "POINT"
@@ -409,17 +462,25 @@ POINT = "POINT"
 START = "START"
 STOP = "STOP"
 
-PLAYER1, PLAYER2 = "1", "2"
+PLAYER1 = "1"
+PLAYER2 = "2"
 ALL_PLAYERS = [str(x + 1) for x in range(N_PLAYER)]
 
 VISUALIZE_SPECTROGRAM = "visualize_spectrogram"
 VISUALIZE_WAVEFORM = "visualize_waveform"
+MEDIA_CREATION_DATE_AS_OFFSET = "media_creation_date_as_offset"
+
+MEDIA_SCAN_SAMPLING_DURATION = "media_scan_sampling_duration"
+IMAGE_DISPLAY_DURATION = "image_display_duration"
 
 # plot type
 WAVEFORM_PLOT = "waveform"
 SPECTROGRAM_PLOT = "spectrogram"
 EVENTS_PLOT = "plot_events"
 
+PLAYING = "playing"
+PAUSED = "paused"
+STOPPED = "stopped"
 
 POINT_EVENT_ST_DURATION = 0.5
 
@@ -428,11 +489,10 @@ FRAME_TAB = 1
 
 SLIDER_MAXIMUM = 1000
 
-FRAME_BITMAP_FORMAT_LIST = ["JPG", "PNG"]
-FRAME_DEFAULT_BITMAP_FORMAT = "JPG"
-
 FRAME_DEFAULT_CACHE_SIZE = 1
 
+EXCLUDED = "excluded"
+
 # modifiers
 MODIFIERS = "modifiers"
 SINGLE_SELECTION = 0
@@ -476,6 +536,16 @@ NO_COLOR_CODING_PAD = "#777777"
 SPECTROGRAM_COLOR_MAPS = ["viridis", "inferno", "plasma", "magma", "gray", "YlOrRd"]
 SPECTROGRAM_DEFAULT_COLOR_MAP = "viridis"
 SPECTROGRAM_DEFAULT_TIME_INTERVAL = 10
+SPECTROGRAM_WINDOW_TYPE = "SPECTROGRAM_WINDOW_TYPE"
+SPECTROGRAM_DEFAULT_WINDOW_TYPE = "hanning"
+SPECTROGRAM_NFFT = "SPECTROGRAM_NFFT"
+SPECTROGRAM_DEFAULT_NFFT = "1024"
+SPECTROGRAM_NOVERLAP = "SPECTROGRAM_NOVERLAP"
+SPECTROGRAM_DEFAULT_NOVERLAP = 900
+SPECTROGRAM_VMIN = "SPECTROGRAM_VMIN"
+SPECTROGRAM_DEFAULT_VMIN = -100
+SPECTROGRAM_VMAX = "SPECTROGRAM_VMAX"
+SPECTROGRAM_DEFAULT_VMAX = -20
 
 # see matplotlib.colors.cnames.keys()
 # https://xkcd.com/color/rgb/
@@ -650,6 +720,7 @@ EMPTY_PROJECT = {
     ETHOGRAM: {},
     OBSERVATIONS: {},
     BEHAVIORAL_CATEGORIES: [],
+    BEHAVIORAL_CATEGORIES_CONF: {},
     INDEPENDENT_VARIABLES: {},
     CODING_MAP: {},
     BEHAVIORS_CODING_MAP: [],
@@ -664,8 +735,21 @@ INIT_PARAM = {
     # TIME_BUDGET_FORMAT: DEFAULT_TIME_BUDGET_FORMAT,
     MPV_HWDEC: MPV_HWDEC_DEFAULT_VALUE,
     PROJECT_FILE_INDENTATION: PROJECT_FILE_INDENTATION_DEFAULT_VALUE,
+    f"{MEDIA} tw fields": MEDIA_TW_EVENTS_FIELDS_DEFAULT,
+    # FRAME_STEP_SIZE: FRAME_STEP_SIZE_DEFAULT_VALUE,
 }
 
+SDIS_EXT = "sds"
+TBS_EXT = "tbs"
+TSV_EXT = "tsv"
+CSV_EXT = "csv"
+RDS_EXT = "rds"
+PANDAS_DF_EXT = "pkl"
+HTML_EXT = "html"
+SQL_EXT = "sql"
+ODS_EXT = "ods"
+XLS_EXT = "xls"
+XLSX_EXT = "xlsx"
 
 # Output format
 TSV = "Tab Separated Values (*.tsv)"
@@ -684,18 +768,18 @@ TBS = "Timed Behavioral Sequences (*.tbs)"
 TEXT_FILE = "Text file"
 
 FILE_NAME_SUFFIX = {
-    TSV: "tsv",
-    CSV: "csv",
-    ODS: "ods",
-    ODS_WB: "ods",
-    XLSX: "xlsx",
-    XLSX_WB: "xlsx",
-    XLS: "xls",
-    HTML: "html",
-    PANDAS_DF: "pkl",
-    RDS: "rds",
-    SQL: "sql",
-    SDIS: "sds",
-    TBS: "tbs",
+    TSV: TSV_EXT,
+    CSV: CSV_EXT,
+    ODS: ODS_EXT,
+    ODS_WB: ODS_EXT,
+    XLSX: XLSX_EXT,
+    XLSX_WB: XLSX_EXT,
+    XLS: XLS_EXT,
+    HTML: HTML_EXT,
+    PANDAS_DF: PANDAS_DF_EXT,
+    RDS: RDS_EXT,
+    SQL: SQL_EXT,
+    SDIS: SDIS_EXT,
+    TBS: TBS_EXT,
     TEXT_FILE: "cli",
 }