updated settings.ini for easier reading

moved advanced settings to /utils

Author: JensBlack

DeepLabStream.py

@@ -18,7 +18,7 @@
 import click
 
 from utils.configloader import RESOLUTION, FRAMERATE, OUT_DIR, MODEL,  MULTI_CAM, STACK_FRAMES, \
-    ANIMALS_NUMBER, STREAMS, VIDEO, IPWEBCAM
+    ANIMALS_NUMBER, STREAMS, STREAMING_SOURCE
 from utils.poser import load_deeplabcut, get_pose, find_local_peaks_new, calculate_skeletons
 from utils.plotter import plot_bodyparts, plot_metadata_frame
 
@@ -127,18 +127,17 @@ def set_camera_manager():
         :return: the chosen camera manager
         """
 
-        if VIDEO:
+        if STREAMING_SOURCE.lower() == 'video':
             from utils.generic import VideoManager
             manager = VideoManager()
             return manager
 
-        elif IPWEBCAM:
+        elif STREAMING_SOURCE.lower() == 'ipwebcam':
             from utils.generic import WebCamManager
             manager = WebCamManager()
             return manager
 
-
-        else:
+        elif STREAMING_SOURCE.lower() == 'camera':
             manager_list = []
             # loading realsense manager, if installed
             realsense = find_spec("pyrealsense2") is not None
@@ -174,6 +173,9 @@ def check_for_cameras(camera_manager):
                 from utils.generic import GenericManager
                 generic_manager = GenericManager()
                 return generic_manager
+        else:
+            raise ValueError(f'Streaming source {STREAMING_SOURCE} is not a valid option. \n'
+                             f'Please choose from "video", "camera" or "ipwebcam".')
 
     @property
     def cameras(self):

settings.ini

@@ -1,24 +1,29 @@
 [Streaming]
-RESOLUTION = 320, 256
+RESOLUTION = 848, 480
 FRAMERATE = 30
-STREAMS = color, depth, infrared
 OUTPUT_DIRECTORY = /Output
-MULTIPLE_DEVICES = False
+#if you have connected multiple cameras (USB), you will need to select the number OpenCV has given them.
+#Default is "0", which takes the first available camera.
 CAMERA_SOURCE = 0
+#you can use camera, ipwebcam or video to select your input source
+STREAMING_SOURCE = camera
 
 [DeepLabCut]
 DLC_PATH = DLC_PATH
 MODEL = MODEL_NAME
 
 [Experiment]
-EXP_ORIGIN = CUSTOM/BASE
+#Available parameters are "CUSTOM" and "BASE"
+EXP_ORIGIN = BASE
+#Name of the experiment config in /experiments/configs or name of the custom experiment in /experiments/custom/experiments.py
 EXP_NAME = CONFIG_NAME
+#if you want the experiment to be recorded as a raw video set this to "True".
 RECORD_EXP = True
 
 [Video]
+#Full path to video that you want to use as input. Needs "STREAMING_SOURCE" set to "video"!
 VIDEO_SOURCE = PATH_TO_PRERECORDED_VIDEO
-VIDEO = False
 
 [IPWEBCAM]
+#Standard Port is 5555 if you followed the SmoothStream setup
 PORT = 5555
-IPWEBCAM = True

utils/advanced_settings.ini

@@ -0,0 +1,7 @@
+#advanced settings only change them if you know what you do!
+
+[Streaming]
+STREAMS = color, depth, infrared
+MULTIPLE_DEVICES = False
+STACK_FRAMES = False
+ANIMALS_NUMBER = 1

utils/configloader.py

@@ -13,6 +13,7 @@
 # loading DeepLabStream configuration
 # remember when it was called DSC?
 dsc_config = cfg.ConfigParser()
+adv_dsc_config = cfg.ConfigParser()
 
 
 def get_script_path():
@@ -23,6 +24,9 @@ def get_script_path():
 with open(cfg_path) as cfg_file:
     dsc_config.read_file(cfg_file)
 
+adv_cfg_path = os.path.join(os.path.dirname(__file__), 'advanced_settings.ini')
+with open(adv_cfg_path) as adv_cfg_file:
+    adv_dsc_config.read_file(adv_cfg_file)
 # DeepLabCut
 deeplabcut_config = dict(dsc_config.items('DeepLabCut'))
 
@@ -36,22 +40,13 @@ def get_script_path():
 MODEL = dsc_config['Streaming'].get('MODEL')
 FRAMERATE = dsc_config['Streaming'].getint('FRAMERATE')
 OUT_DIR = dsc_config['Streaming'].get('OUTPUT_DIRECTORY')
-STREAM = dsc_config['Streaming'].getboolean('STREAM')
-MULTI_CAM = dsc_config['Streaming'].getboolean('MULTIPLE_DEVICES')
-STACK_FRAMES = dsc_config['Streaming'].getboolean('STACK_FRAMES') if dsc_config['Streaming'].getboolean(
-    'STACK_FRAMES') is not None else False
-ANIMALS_NUMBER = dsc_config['Streaming'].getint('ANIMALS_NUMBER') if dsc_config['Streaming'].getint(
-    'ANIMALS_NUMBER') is not None else 1
-STREAMS = [str(part).strip() for part in dsc_config['Streaming'].get('STREAMS').split(',')]
 CAMERA_SOURCE = dsc_config['Streaming'].get('CAMERA_SOURCE')
-
+STREAMING_SOURCE = dsc_config['Streaming'].get('STREAMING_SOURCE')
 # Video
 VIDEO_SOURCE = dsc_config['Video'].get('VIDEO_SOURCE')
-VIDEO = dsc_config['Video'].getboolean('VIDEO')
 
 #IPWEBCAM
 PORT = dsc_config['IPWEBCAM'].get('PORT')
-IPWEBCAM = dsc_config['IPWEBCAM'].getboolean('IPWEBCAM')
 
 
 # experiment
@@ -60,4 +55,12 @@ def get_script_path():
 RECORD_EXP = dsc_config['Experiment'].getboolean('RECORD_EXP')
 
 START_TIME = time.time()
-EGG = "".join(format(ord(x), 'b') for x in "Hello there!")
+
+
+"""advanced settings"""
+STREAMS = [str(part).strip() for part in adv_dsc_config['Streaming'].get('STREAMS').split(',')]
+MULTI_CAM = adv_dsc_config['Streaming'].getboolean('MULTIPLE_DEVICES')
+STACK_FRAMES = adv_dsc_config['Streaming'].getboolean('STACK_FRAMES') if adv_dsc_config['Streaming'].getboolean(
+    'STACK_FRAMES') is not None else False
+ANIMALS_NUMBER = adv_dsc_config['Streaming'].getint('ANIMALS_NUMBER') if adv_dsc_config['Streaming'].getint(
+    'ANIMALS_NUMBER') is not None else 1