add option for skipping gain correction

Author: bimac

iblrig_custom_tasks/samuel_tonotopicMapping/task.py

@@ -8,9 +8,8 @@
 from iblrig.base_choice_world import NTRIALS_INIT
 from iblrig.base_tasks import BaseSession, BpodMixin
 from iblrig.misc import get_task_arguments
-from pybpodapi.state_machine import StateMachine
-
 from iblrig.pydantic_definitions import TrialDataModel
+from pybpodapi.state_machine import StateMachine
 
 log = logging.getLogger('iblrig')
 
@@ -21,7 +20,6 @@ class TonotopicMappingTrialData(TrialDataModel):
     frequency_sequence: list[int]
 
 
-
 class Session(BpodMixin, BaseSession):
     protocol_name = 'samuel_tonotopicMapping'
     TrialDataModel = TonotopicMappingTrialData
@@ -56,11 +54,14 @@ def __init__(self, *args, **kwargs):
             self.attenuation_lut.to_csv(attenuation_file, index=False)
 
         # get attenuation values from LUT (linear interpolation for missing values)
-        self.attenuation = np.interp(
-            self.frequencies,
-            self.attenuation_lut['frequency_hz'],
-            self.attenuation_lut['attenuation_db'],
-        )
+        if self.task_params['skip_attenuation']:
+            self.attenuation = pd.DataFrame({'frequency_hz': self.frequencies, 'attenuation_db': np.zeros(self.n_frequencies)})
+        else:
+            self.attenuation = np.interp(
+                self.frequencies,
+                self.attenuation_lut['frequency_hz'],
+                self.attenuation_lut['attenuation_db'],
+            )
 
         # calculate repetitions per state machine run (255 states max)
         self.repetitions = []

iblrig_custom_tasks/samuel_tonotopicMapping/task_parameters.yaml

@@ -8,3 +8,4 @@
 'amplitude': 0.05  # initial amplitude of all stimuli prior to dB attenuation
 'fs': 192000  # sampling rate (Hz) - Harp supports 96000 Hz and 192000 Hz
 'shuffle': true  # whether to shuffle the order of frequencies or not
+'skip_attenuation': false  # whether to skip gain correction (potentially useful for calibration)