Random reward

src/foraging_gui/Foraging.py

@@ -42,7 +42,7 @@
 import foraging_gui.rigcontrol as rigcontrol
 from foraging_gui.Visualization import PlotV,PlotLickDistribution,PlotTimeDistribution
 from foraging_gui.Dialogs import OptogeneticsDialog,WaterCalibrationDialog,CameraDialog,MetadataDialog
-from foraging_gui.Dialogs import LaserCalibrationDialog
+from foraging_gui.Dialogs import LaserCalibrationDialog,OpticalTaggingDialog,RandomRewardDialog
 from foraging_gui.Dialogs import LickStaDialog,TimeDistributionDialog
 from foraging_gui.Dialogs import AutoTrainDialog, MouseSelectorDialog
 from foraging_gui.MyFunctions import GenerateTrials, Worker,TimerWorker, NewScaleSerialY, EphysRecording
@@ -184,6 +184,8 @@ def __init__(self, parent=None,box_number=1,start_bonsai_ide=True):
         self.OpenLaserCalibration=0
         self.OpenCamera=0
         self.OpenMetadata=0
+        self.OpenOpticalTagging=0
+        self.OpenRandomReward=0
         self.NewTrialRewardOrder=0
         self.LickSta=0
         self.LickSta_ToInitializeVisual=1
@@ -205,6 +207,8 @@ def __init__(self, parent=None,box_number=1,start_bonsai_ide=True):
         self._LaserCalibration()# to open the laser calibration panel
         self._WaterCalibration()# to open the water calibration panel
         self._Camera()
+        self._OpticalTagging()
+        self._RandomReward()
         self._InitializeMotorStage()
         self._load_stage()
         self._Metadata()
@@ -319,6 +323,8 @@ def connectSignalsSlots(self):
         self.action_About.triggered.connect(self._about)
         self.action_Camera.triggered.connect(self._Camera)
         self.actionMeta_Data.triggered.connect(self._Metadata)
+        self.actionOptical_Tagging.triggered.connect(self._OpticalTagging)
+        self.actionRandom_Reward.triggered.connect(self._RandomReward)  
         self.action_Optogenetics.triggered.connect(self._Optogenetics)
         self.actionLicks_sta.triggered.connect(self._LickSta)
         self.actionTime_distribution.triggered.connect(self._TimeDistribution)
@@ -2338,6 +2344,26 @@ def _Camera(self):
         else:
             self.Camera_dialog.hide()
 
+    def _OpticalTagging(self):
+        '''Open the optical tagging dialog'''
+        if self.OpenOpticalTagging==0:
+            self.OpticalTagging_dialog = OpticalTaggingDialog(MainWindow=self)
+            self.OpenOpticalTagging=1
+        if self.actionOptical_Tagging.isChecked()==True:
+            self.OpticalTagging_dialog.show()
+        else:
+            self.OpticalTagging_dialog.hide()
+
+    def _RandomReward(self):
+        '''Open the random reward dialog'''
+        if self.OpenRandomReward==0:
+            self.RandomReward_dialog = RandomRewardDialog(MainWindow=self)
+            self.OpenRandomReward=1
+        if self.actionRandom_Reward.isChecked()==True:
+            self.RandomReward_dialog.show()
+        else:
+            self.RandomReward_dialog.hide()
+
     def _Metadata(self):
         '''Open the metadata dialog'''
         if self.OpenMetadata==0:
@@ -2564,7 +2590,7 @@ def _Save(self,ForceSave=0,SaveAs=0,SaveContinue=0,BackupSave=0):
                 QtWidgets.QComboBox,QtWidgets.QDoubleSpinBox,QtWidgets.QSpinBox))}
             widget_dict.update({w.objectName(): w for w in self.TrainingParameters.findChildren(QtWidgets.QDoubleSpinBox)})
             self._Concat(widget_dict,Obj,'None')
-            dialogs = ['LaserCalibration_dialog', 'Opto_dialog', 'Camera_dialog','Metadata_dialog']
+            dialogs = ['LaserCalibration_dialog', 'Opto_dialog', 'Camera_dialog','Metadata_dialog','OpticalTagging_dialog','RandomReward_dialog']
             for dialog_name in dialogs:
                 if hasattr(self, dialog_name):
                     widget_dict = {w.objectName(): w for w in getattr(self, dialog_name).findChildren(
@@ -2665,6 +2691,9 @@ def _Save(self,ForceSave=0,SaveAs=0,SaveContinue=0,BackupSave=0):
             # save manual water 
             Obj['ManualWaterVolume']=self.ManualWaterVolume
 
+            # save the random water
+            Obj['RandomWaterVolume']=self.RandomReward_dialog.random_reward_par['RandomWaterVolume']
+
             # save camera start/stop time
             Obj['Camera_dialog']['camera_start_time']=self.Camera_dialog.camera_start_time
             Obj['Camera_dialog']['camera_stop_time']=self.Camera_dialog.camera_stop_time
@@ -2681,6 +2710,12 @@ def _Save(self,ForceSave=0,SaveAs=0,SaveContinue=0,BackupSave=0):
         Obj['MetadataFolder']=self.MetadataFolder
         Obj['SaveFile']=self.SaveFile
 
+        # save optical tagging parameters
+        Obj['optical_tagging_par']=self.OpticalTagging_dialog.optical_tagging_par
+
+        # save random reward parameters
+        Obj['random_reward_par']=self.RandomReward_dialog.random_reward_par
+
         # generate the metadata file and update slims
         try:
             # save the metadata collected in the metadata dialogue
@@ -2702,8 +2737,7 @@ def _Save(self,ForceSave=0,SaveAs=0,SaveContinue=0,BackupSave=0):
                 if self.BaseWeight.text() != '' and self.WeightAfter.text() != '' and self.behavior_session_model.subject not in ['0','1','2','3','4','5','6','7','8','9','10']:
                     self._AddWaterLogResult(session)
                 self.bias_indicator.clear()  # prepare for new session
-
-
+
         except Exception as e:
             logging.warning('Meta data is not saved!', extra= {'tags': {self.warning_log_tag}})
             logging.error('Error generating session metadata: '+str(e))
@@ -3046,7 +3080,7 @@ def _Open(self,open_last = False,input_file = ''):
             self.Obj = Obj
 
             widget_dict={}
-            dialogs = ['LaserCalibration_dialog', 'Opto_dialog', 'Camera_dialog','centralwidget','TrainingParameters']
+            dialogs = ['LaserCalibration_dialog', 'Opto_dialog', 'Camera_dialog','centralwidget','TrainingParameters','OpticalTagging_dialog','RandomReward_dialog']
             for dialog_name in dialogs:
                 if hasattr(self, dialog_name):
                     widget_types = (QtWidgets.QPushButton, QtWidgets.QLineEdit, QtWidgets.QTextEdit,
@@ -4060,14 +4094,15 @@ def _Start(self):
             try:
                 # Do not start a new session if the camera is already open, this means the session log has been started or the existing session has not been completed.
                 if (not (self.Camera_dialog.StartRecording.isChecked() and self.Camera_dialog.AutoControl.currentText()=='No')) and (not self.FIP_started):
-                    # Turn off the camera recording
-                    self.Camera_dialog.StartRecording.setChecked(False)
-                    # Turn off the preview if it is on and the autocontrol is on, which can make sure the trigger is off before starting the logging. 
-                    if self.Camera_dialog.AutoControl.currentText()=='Yes' and self.Camera_dialog.StartPreview.isChecked():
-                        self.Camera_dialog.StartPreview.setChecked(False)
-                        # sleep for 1 second to make sure the trigger is off
-                        time.sleep(1)
-                    self.Ot_log_folder=self._restartlogging()
+                    if self.logging_type!=0:
+                        # Turn off the camera recording
+                        self.Camera_dialog.StartRecording.setChecked(False)
+                        # Turn off the preview if it is on and the autocontrol is on, which can make sure the trigger is off before starting the logging. 
+                        if self.Camera_dialog.AutoControl.currentText()=='Yes' and self.Camera_dialog.StartPreview.isChecked():
+                            self.Camera_dialog.StartPreview.setChecked(False)
+                            # sleep for 1 second to make sure the trigger is off
+                            time.sleep(1)
+                        self.Ot_log_folder=self._restartlogging()
             except Exception as e:
                 if 'ConnectionAbortedError' in str(e):
                     logging.info('lost bonsai connection: restartlogging()')
@@ -4501,7 +4536,6 @@ def _GiveLeft(self):
             logger.info('Give left manual water (ul): '+str(np.round(float(self.TP_GiveWaterL_volume),3)),
                            extra={'tags': [self.warning_log_tag]})
 
-
     def _give_reserved_water(self,valve=None):
         '''give reserved water usually after the go cue'''
         if valve=='left':
@@ -4599,7 +4633,11 @@ def _UpdateSuggestedWater(self,ManualWater=0):
                 ManualWaterVolume=np.sum(self.ManualWaterVolume)
             else:
                 ManualWaterVolume=0
-            water_in_session=BS_TotalReward+ManualWaterVolume
+
+            if hasattr(self,'RandomReward_dialog'):
+                RandomWaterVolume=np.sum(self.RandomReward_dialog.random_reward_par['RandomWaterVolume'])
+
+            water_in_session=BS_TotalReward+ManualWaterVolume+RandomWaterVolume
             self.water_in_session=water_in_session
             if self.WeightAfter.text()!='' and self.BaseWeight.text()!='' and self.TargetRatio.text()!='':
                 # calculate the suggested water

src/foraging_gui/ForagingGUI.ui

@@ -691,8 +691,8 @@
                  <rect>
                   <x>0</x>
                   <y>0</y>
-                  <width>627</width>
-                  <height>325</height>
+                  <width>621</width>
+                  <height>334</height>
                  </rect>
                 </property>
                 <layout class="QHBoxLayout" name="horizontalLayout">
@@ -1194,8 +1194,7 @@
                      </widget>
                     </item>
                     <item>
-                     <widget class="QWidget" name="groupBox_6">
-                     </widget>
+                     <widget class="QWidget" name="groupBox_6" native="true"/>
                     </item>
                    </layout>
                   </widget>
@@ -1534,8 +1533,7 @@
                      </widget>
                     </item>
                     <item>
-                     <widget class="QWidget" name="groupBox_6">
-                     </widget>
+                     <widget class="QWidget" name="groupBox_6" native="true"/>
                     </item>
                     <item>
                      <widget class="QWidget" name="widget" native="true">
@@ -1731,7 +1729,7 @@
                          <property name="value">
                           <double>0.030000000000000</double>
                          </property>
-                         <property name="disabled">
+                         <property name="disabled" stdset="0">
                           <bool>true</bool>
                          </property>
                         </widget>
@@ -1759,8 +1757,8 @@
                          <property name="value">
                           <double>0.030000000000000</double>
                          </property>
-                         <property name="disabled">
-                         <bool>true</bool>
+                         <property name="disabled" stdset="0">
+                          <bool>true</bool>
                          </property>
                         </widget>
                        </item>
@@ -1813,7 +1811,7 @@
                          <property name="value">
                           <double>3.000000000000000</double>
                          </property>
-                          <property name="disabled">
+                         <property name="disabled" stdset="0">
                           <bool>true</bool>
                          </property>
                         </widget>
@@ -1841,9 +1839,9 @@
                          <property name="value">
                           <double>3.000000000000000</double>
                          </property>
-                         <property name="disabled">
-                         <bool>true</bool>
-                        </property>
+                         <property name="disabled" stdset="0">
+                          <bool>true</bool>
+                         </property>
                         </widget>
                        </item>
                        <item row="2" column="3">
@@ -2344,7 +2342,7 @@ Double dipping:
                  <rect>
                   <x>0</x>
                   <y>0</y>
-                  <width>1072</width>
+                  <width>1177</width>
                   <height>463</height>
                  </rect>
                 </property>
@@ -4856,6 +4854,8 @@ Current pair:
     <addaction name="action_Calibration"/>
     <addaction name="actionLaser_Calibration"/>
     <addaction name="actionMeta_Data"/>
+    <addaction name="actionOptical_Tagging"/>
+    <addaction name="actionRandom_Reward"/>
     <addaction name="separator"/>
     <addaction name="menuSimulation"/>
     <addaction name="actionDrawing_after_stopping"/>
@@ -4982,6 +4982,7 @@ Current pair:
    </attribute>
    <addaction name="action_Calibration"/>
    <addaction name="actionLaser_Calibration"/>
+   <addaction name="actionOptical_Tagging"/>
    <addaction name="actionMeta_Data"/>
   </widget>
   <widget class="QToolBar" name="toolBar_3">
@@ -5246,6 +5247,26 @@ Current pair:
     <string>Open video folder</string>
    </property>
   </action>
+  <action name="actionOptical_Tagging">
+   <property name="checkable">
+    <bool>true</bool>
+   </property>
+   <property name="icon">
+    <iconset>
+     <normaloff>resources/OpticalTagging.jpg</normaloff>resources/OpticalTagging.jpg</iconset>
+   </property>
+   <property name="text">
+    <string>Optical Tagging</string>
+   </property>
+  </action>
+  <action name="actionRandom_Reward">
+   <property name="checkable">
+    <bool>true</bool>
+   </property>
+   <property name="text">
+    <string>Random Reward</string>
+   </property>
+  </action>
  </widget>
  <tabstops>
   <tabstop>Task</tabstop>
@@ -5285,4 +5306,4 @@ Current pair:
    </hints>
   </connection>
  </connections>
-</ui>
+</ui>

src/foraging_gui/ForagingGUI_Ephys.ui

@@ -1463,9 +1463,9 @@
      <property name="value">
       <double>0.030000000000000</double>
      </property>
-     <property name="disabled">
-     <bool>true</bool>
-    </property>
+     <property name="disabled" stdset="0">
+      <bool>true</bool>
+     </property>
     </widget>
     <widget class="QDoubleSpinBox" name="GiveWaterR">
      <property name="geometry">
@@ -1491,9 +1491,9 @@
      <property name="value">
       <double>0.030000000000000</double>
      </property>
-     <property name="disabled">
-     <bool>true</bool>
-    </property>
+     <property name="disabled" stdset="0">
+      <bool>true</bool>
+     </property>
     </widget>
     <widget class="QLabel" name="label_56">
      <property name="geometry">
@@ -1884,9 +1884,9 @@
      <property name="value">
       <double>3.000000000000000</double>
      </property>
-     <property name="disabled">
-     <bool>true</bool>
-    </property>
+     <property name="disabled" stdset="0">
+      <bool>true</bool>
+     </property>
     </widget>
     <widget class="QDoubleSpinBox" name="GiveWaterR_volume">
      <property name="geometry">
@@ -1912,9 +1912,9 @@
      <property name="value">
       <double>3.000000000000000</double>
      </property>
-     <property name="disabled">
-     <bool>true</bool>
-    </property>
+     <property name="disabled" stdset="0">
+      <bool>true</bool>
+     </property>
     </widget>
     <widget class="QDoubleSpinBox" name="RightValue_volume">
      <property name="geometry">
@@ -2176,7 +2176,7 @@
       <set>Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter</set>
      </property>
     </widget>
-     <widget class="QLineEdit" name="min_time">
+    <widget class="QLineEdit" name="min_time">
      <property name="geometry">
       <rect>
        <x>863</x>
@@ -4620,6 +4620,8 @@
     <addaction name="action_Calibration"/>
     <addaction name="actionLaser_Calibration"/>
     <addaction name="actionMeta_Data"/>
+    <addaction name="actionOptical_Tagging"/>
+    <addaction name="actionRandom_Reward"/>
     <addaction name="separator"/>
     <addaction name="menuSimulation"/>
     <addaction name="actionDrawing_after_stopping"/>
@@ -4745,6 +4747,7 @@
    </attribute>
    <addaction name="action_Calibration"/>
    <addaction name="actionLaser_Calibration"/>
+   <addaction name="actionOptical_Tagging"/>
    <addaction name="actionMeta_Data"/>
   </widget>
   <widget class="QToolBar" name="toolBar_3">
@@ -5009,6 +5012,26 @@
     <string>Open video folder</string>
    </property>
   </action>
+  <action name="actionOptical_Tagging">
+   <property name="checkable">
+    <bool>true</bool>
+   </property>
+   <property name="icon">
+    <iconset>
+     <normaloff>resources/OpticalTagging.jpg</normaloff>resources/OpticalTagging.jpg</iconset>
+   </property>
+   <property name="text">
+    <string>Optical Tagging</string>
+   </property>
+  </action>
+  <action name="actionRandom_Reward">
+   <property name="checkable">
+    <bool>true</bool>
+   </property>
+   <property name="text">
+    <string>Random Reward</string>
+   </property>
+  </action>
  </widget>
  <tabstops>
   <tabstop>NextBlock</tabstop>