-BpodLib: Renamed path to calibration folder from 'liquidcalibration' to 'calibration'

JSNeuroDev · JSNeuroDev · commit 269269f323d7 · 2025-10-17T10:24:27.000-04:00
diff --git a/Functions/+BpodLib/+BpodObject/+setup/updatePathAndSettings.m b/Functions/+BpodLib/+BpodObject/+setup/updatePathAndSettings.m
@@ -101,7 +101,7 @@ function updatePathAndSettings(BpodSystem, varargin)
 end
 
 %% -- Calibration Files
-calFolder = BpodLib.path.getPath('liquidcalibration', BpodSystem, 'LocalDir', LocalDir);
+calFolder = BpodLib.path.getPath('calibration', BpodSystem, 'LocalDir', LocalDir);
 
 if ~isfile(fullfile(Path.SettingsDir, 'LiquidCalibration.json')) && ~BpodLib.path.compatibility.isLegacySettings(Path.LocalDir)
     fileNames = {'LiquidCalibration.json', 'SoundCalibration.mat', 'Readme.txt'};
diff --git a/Functions/+BpodLib/+calibration/+liquid/+io/load.m b/Functions/+BpodLib/+calibration/+liquid/+io/load.m
@@ -55,7 +55,7 @@
 
 LocalDir = BpodLib.path.getPath('local', BpodSystem, 'LocalDir', p.Results.LocalDir);
 
-calibrationFolderpath = BpodLib.path.getPath('liquidcalibration', BpodSystem, 'LocalDir', LocalDir);
+calibrationFolderpath = BpodLib.path.getPath('calibration', BpodSystem, 'LocalDir', LocalDir);
 legacyPath = fullfile(LocalDir, 'Calibration Files/LiquidCalibration.mat');
 expectedFilepath = fullfile(calibrationFolderpath, filename);
 
@@ -67,7 +67,7 @@
     if isLegacy
         warning('BpodLib:LiquidCalibrationLoad:LegacyAndJSON', 'Returning LiquidCalibration.json but LiquidCalibration.mat exists, LiquidCalibration.mat should not exist in folder Calibration Files/')
     end
-    singleSetupPath = fullfile(BpodLib.path.getPath('liquidcalibration', BpodSystem, 'LocalDir', LocalDir, 'setup', 'single'), 'LiquidCalibration.json');
+    singleSetupPath = fullfile(BpodLib.path.getPath('calibration', BpodSystem, 'LocalDir', LocalDir, 'setup', 'single'), 'LiquidCalibration.json');
     if isMulti && isfile(singleSetupPath)
         warning('BpodLib:LiquidCalibrationLoad:MultiAndSingle', 'Bpod detected this is a computer that may have multiple state machines plugged in but found a single-setup liquid calibration file.')
     end
diff --git a/Functions/+BpodLib/+calibration/+liquid/+io/save.m b/Functions/+BpodLib/+calibration/+liquid/+io/save.m
@@ -55,7 +55,7 @@ function save(saveData, varargin)
 % Determine the save location of the calibration file
 if isempty(p.Results.filepath)
     assert(~isempty(p.Results.type), "Either 'filepath' or 'type' must be specified")
-    calibrationFolderpath = BpodLib.path.getPath('liquidcalibration', BpodSystem);
+    calibrationFolderpath = BpodLib.path.getPath('calibration', BpodSystem);
     switch lower(p.Results.type)
         case 'statemachine'
             filename = 'LiquidCalibration.json';
diff --git a/Functions/+BpodLib/+calibration/+liquid/+portarray/launchCalibrator.m b/Functions/+BpodLib/+calibration/+liquid/+portarray/launchCalibrator.m
@@ -26,7 +26,7 @@ function launchCalibrator(BpodSystem)
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 %}
 
-savePath = fullfile(BpodLib.path.getPath('liquidcalibration', BpodSystem),... 
+savePath = fullfile(BpodLib.path.getPath('calibration', BpodSystem),... 
                                          'LiquidCalibration-PortArrays.json');
 if isempty(BpodSystem.CalibrationTables.PortArrays)
     error('BpodLib:portarraylaunchCalibrator:NoData',... 
diff --git a/Functions/+BpodLib/+calibration/+liquid/launchLiquidCalibrationUI.m b/Functions/+BpodLib/+calibration/+liquid/launchLiquidCalibrationUI.m
@@ -22,7 +22,7 @@ function launchLiquidCalibrationUI(varargin)
     end
 end
 
-savepath = fullfile(BpodLib.path.getPath('liquidcalibration', BpodSystem), 'LiquidCalibration.json');
+savepath = fullfile(BpodLib.path.getPath('calibration', BpodSystem), 'LiquidCalibration.json');
 BpodLib.calibration.liquid.LiquidCalibratorUI(BpodSystem.CalibrationTables.LiquidCal,... 
     'BpodSystem', BpodSystem, 'savepath', savepath, 'source', 'statemachine', 'target', 'FSM_Onboard');
 
diff --git a/Functions/+BpodLib/+path/getPath.m b/Functions/+BpodLib/+path/getPath.m
@@ -4,7 +4,7 @@
 %
 % Examples
 % --------
-% path = getPath('liquidcalibration', BpodSystem, 'setuptype', 'single')
+% path = getPath('calibration', BpodSystem, 'setuptype', 'single')
 % path = getPath('config', 'LocalDir', LocalDirPath, 'setuptype', 'multi', 'com', 'COM3')
 %
 % Arguments
@@ -13,7 +13,7 @@
 %     The target path to retrieve, can be one of the following:
 %         - 'config': Path to the config folder
 %         - 'local': Path to the local directory
-%         - 'liquidcalibration': Path to the liquid calibration files
+%         - 'calibration': Path to the calibration files
 %         - 'root': Path to the Bpod root directory
 %         - 'settings': Path to the settings folder
 % BpodSystem : BpodObject or struct
@@ -113,7 +113,7 @@
         else
             path = BpodSystem.Path.LocalDir;
         end
-    case 'liquidcalibration'
+    case 'calibration'
         if BpodLib.path.compatibility.isLegacySettings(BpodLib.path.getPath('local', varargin{:}))
             path = fullfile(BpodLib.path.getPath('local', p.Results.BpodSystem), 'Calibration Files');
             return
diff --git a/Functions/+BpodLib/+path/verifyPathing.m b/Functions/+BpodLib/+path/verifyPathing.m
@@ -49,7 +49,7 @@
 verified = true;
 results = cell(1, 1);
 
-liquidcalibrationPath = BpodLib.path.getPath('liquidcalibration', BpodSystem);
+liquidcalibrationPath = BpodLib.path.getPath('calibration', BpodSystem);
 if ~isfolder(liquidcalibrationPath)
     verified = false;
     results{1} = liquidcalibrationPath;
diff --git a/Functions/Calibration/Sound/SoundCalibrationManager.m b/Functions/Calibration/Sound/SoundCalibrationManager.m
@@ -264,7 +264,7 @@ function calibrate_Callback(hObject, eventdata, handles)
     BpodSystem.PluginObjects.SoundServer = PsychToolboxAudio;
 end
 
-[FileName, PathName] = uiputfile(fullfile(BpodLib.path.getPath('liquidcalibration', BpodSystem), 'SoundCalibration.mat'), 'Save Sound Calibration File');
+[FileName, PathName] = uiputfile(fullfile(BpodLib.path.getPath('calibration', BpodSystem), 'SoundCalibration.mat'), 'Save Sound Calibration File');
 
 handles.filename = fullfile(PathName,FileName);
 
diff --git a/Functions/Calibration/Sound/TestSoundManager.m b/Functions/Calibration/Sound/TestSoundManager.m
@@ -207,7 +207,7 @@ function file_Callback(hObject, eventdata, handles)
 % hObject    handle to file (see GCBO)
 % eventdata  reserved - to be defined in a future version of MATLAB
 % handles    structure with handles and user data (see GUIDATA)
-[FileName, PathName] = uigetfile(BpodLib.path.getPath('liquidcalibration', BpodSystem));
+[FileName, PathName] = uigetfile(BpodLib.path.getPath('calibration', BpodSystem));
 if FileName ~= 0
     handles.calfile = fullfile(PathName,FileName);
     set(handles.filename_edit, 'String', handles.calfile);
diff --git a/Tests/BpodLib/BpodObject/setup/test_SettingsAndFiles.m b/Tests/BpodLib/BpodObject/setup/test_SettingsAndFiles.m
@@ -46,7 +46,7 @@ function test_freshMultiSetup(testCase)
     testCase.verifyTrue(isfolder(settingsPath), 'Multi setup folder was not created.')
     
     % Check if the calibration files were created
-    calibrationFolderpath = BpodLib.path.getPath('liquidcalibration', BpodSystem, 'setuptype', 'multi');
+    calibrationFolderpath = BpodLib.path.getPath('calibration', BpodSystem, 'setuptype', 'multi');
     testCase.verifyTrue(isfolder(calibrationFolderpath), 'Calibration folder was not created.')
 
     % Check that the settings files have been updated correctly
@@ -77,8 +77,8 @@ function test_newMultiSetup(testCase)
     testCase.verifyTrue(numel(filelist) == 0, 'Settings folder should be empty of files after creating a new multi setup.');
 
     % Test iquidcalibration paths are set correctly
-    testCase.verifyTrue(strcmp(BpodLib.path.getPath('liquidcalibration', BpodSystem), fullfile(testCase.TestData.LocalDir, 'Config/Machine-COM13')), 'Liquid calibration path should be set to the new multi setup location.');
-    testCase.verifyTrue(strcmp(BpodLib.path.getPath('liquidcalibration', NewBpodSystem), fullfile(testCase.TestData.LocalDir, 'Config/Machine-COM5')), 'Liquid calibration path should be set to the new multi setup location.');
+    testCase.verifyTrue(strcmp(BpodLib.path.getPath('calibration', BpodSystem), fullfile(testCase.TestData.LocalDir, 'Config/Machine-COM13')), 'Liquid calibration path should be set to the new multi setup location.');
+    testCase.verifyTrue(strcmp(BpodLib.path.getPath('calibration', NewBpodSystem), fullfile(testCase.TestData.LocalDir, 'Config/Machine-COM5')), 'Liquid calibration path should be set to the new multi setup location.');
 
     % Test settings files are moved
     testCase.verifyTrue(isfile(fullfile(BpodLib.path.getPath('settings',NewBpodSystem), 'SyncConfig.mat')), 'Settings files should have been created.')
diff --git a/Tests/BpodLib/path/test_getPath.m b/Tests/BpodLib/path/test_getPath.m
@@ -27,19 +27,19 @@ function test_liquidcalibration(testCase)
     mockBpod = testCase.TestData.mockBpod;
 
     % Test single setup path
-    testCase.verifyEqual(BpodLib.path.getPath('liquidcalibration', mockBpod, 'setuptype', 'single'), fullfile(testCase.TestData.mockBpod.Path.LocalDir, 'Config'))
-    testCase.verifyEqual(BpodLib.path.getPath('liquidcalibration', 'LocalDir', mockBpod.Path.LocalDir, 'setuptype', 'single'), fullfile(testCase.TestData.mockBpod.Path.LocalDir, 'Config'))
+    testCase.verifyEqual(BpodLib.path.getPath('calibration', mockBpod, 'setuptype', 'single'), fullfile(testCase.TestData.mockBpod.Path.LocalDir, 'Config'))
+    testCase.verifyEqual(BpodLib.path.getPath('calibration', 'LocalDir', mockBpod.Path.LocalDir, 'setuptype', 'single'), fullfile(testCase.TestData.mockBpod.Path.LocalDir, 'Config'))
     
     % Test multi setup path
-    testCase.verifyEqual(BpodLib.path.getPath('liquidcalibration', mockBpod, 'setuptype', 'multi'), fullfile(testCase.TestData.mockBpod.Path.LocalDir, 'Config/Machine-COM13'))
-    testCase.verifyEqual(BpodLib.path.getPath('liquidcalibration', 'LocalDir', mockBpod.Path.LocalDir, 'com', 'COM13', 'setuptype', 'multi'), fullfile(testCase.TestData.mockBpod.Path.LocalDir, 'Config/Machine-COM13'))
+    testCase.verifyEqual(BpodLib.path.getPath('calibration', mockBpod, 'setuptype', 'multi'), fullfile(testCase.TestData.mockBpod.Path.LocalDir, 'Config/Machine-COM13'))
+    testCase.verifyEqual(BpodLib.path.getPath('calibration', 'LocalDir', mockBpod.Path.LocalDir, 'com', 'COM13', 'setuptype', 'multi'), fullfile(testCase.TestData.mockBpod.Path.LocalDir, 'Config/Machine-COM13'))
 end
 
 function test_newCOM(testCase)
     % Test the expected definition of liquid calibration file location
     mockBpod = testCase.TestData.mockBpod;
     
-    localfolder = BpodLib.path.getPath('liquidcalibration', mockBpod);
+    localfolder = BpodLib.path.getPath('calibration', mockBpod);
     mkdir(fullfile(localfolder, 'Machine-COM3'))
     mkdir(fullfile(localfolder, 'Machine-COM5'))
     
@@ -48,7 +48,7 @@ function test_newCOM(testCase)
 
 function test_arguments_vs_auto(testCase)
     % Test that the function returns expected outputs with different combinations of arguments
-    Targets = {'config', 'local', 'liquidcalibration', 'root', 'settings'};
+    Targets = {'config', 'local', 'calibration', 'root', 'settings'};
 
     for target = Targets
         regularPath = BpodLib.path.getPath(target{1}, testCase.TestData.mockBpod);
