feat: Added "Use empirical shift" checkbox to edit TOA and main window

This commit also fixes the application of the empiricalShift in the
tracking algorithm. It is now applied the same way as the offsets,
namely: TOA + -1 * empiricalShift

VERSION

-367
+368

lib/+artoa/+controller/+edit/+timeOfArrival/checkboxUseEmpiricalShift.m

+function [newValue] = checkboxUseEmpiricalShift(~, ~)
+%CHECKBOXUSEEMPIRICALSHIFT Summary of this function goes here
+%   Detailed explanation goes here
+
+global artoaGui artoaWorkspace;
+
+newValue = logical(artoaGui.editTimeOfArrival.checkboxUseEmpiricalShift.Value);
+
+artoaWorkspace.trackParameter.useEmpiricalShift = newValue;
+
+%% Update gui
+% Needs to be done because the checkbox has also been integrated into the TOA window.
+artoa.controller.main.updateControls();
+
+%% Recalculate
+artoa.controller.edit.recalculateToaGpsAndPlot();
+
+end
+

lib/+artoa/+controller/+edit/+timeOfArrival/open.m

@@ -14,6 +14,7 @@ end
 artoaWorkspace.editTimeOfArrival = struct();
 artoaGui.callbacks.timeOfArrival = struct();
 artoaGui.callbacks.timeOfArrival.checkboxUseOffsets = @artoa.controller.edit.timeOfArrival.checkboxUseOffsets;
+artoaGui.callbacks.timeOfArrival.checkboxUseEmpiricalShift = @artoa.controller.edit.timeOfArrival.checkboxUseEmpiricalShift;
 
 %% Calculate GPS TOAs
 artoa.controller.edit.timeOfArrival.calculateGpsToas();

lib/+artoa/+controller/+edit/+timeOfArrival/resetShiftToa.m

@@ -9,8 +9,10 @@ if strcmp(questdlg('Reset all shifted values?', 'Confirmation', 'Yes', 'Cancel',
     return;
 end
 
-%% Subtract empirical shift
-artoaWorkspace.toaData.toa = artoaWorkspace.toaData.toa - artoaWorkspace.toaData.empiricalShift;
+%% Remove empirical shift if applied
+if artoaWorkspace.trackParameter.useEmpiricalShift
+    artoaWorkspace.toaData.toa = artoaWorkspace.toaData.toa - artoaWorkspace.toaData.empiricalShift;
+end
 %% Reset empirical shift array
 artoaWorkspace.toaData.empiricalShift(:) = 0;
 %% Clear selection

lib/+artoa/+controller/+edit/+timeOfArrival/shiftToa.m

@@ -22,22 +22,28 @@ end
 answer = str2double(answer{1});
 
 if isnan(answer)
+    warndlg('The value entered could not be converted to a double.');
     return;
 end
 
+%% Update track parameter state
+artoaWorkspace.trackParameter.useEmpiricalShift = true;
+artoa.controller.edit.timeOfArrival.updateControls();
+artoa.controller.main.updateControls();
+
+%% Apply shift
 % track empirical shift to be able to reset it
 artoaWorkspace.toaData.empiricalShift(artoaWorkspace.editTimeOfArrival.userSelection) = ...
     artoaWorkspace.toaData.empiricalShift(artoaWorkspace.editTimeOfArrival.userSelection) ...
     + answer;
 
-% add shift to toa
-artoaWorkspace.toaData.toa(artoaWorkspace.editTimeOfArrival.userSelection) = ...
-    artoaWorkspace.toaData.toa(artoaWorkspace.editTimeOfArrival.userSelection) + answer;
-
 [artoaGui.editTimeOfArrival, artoaWorkspace.editTimeOfArrival] = ...
     artoa.controller.edit.clearSelection(artoaGui.editTimeOfArrival, artoaWorkspace.editTimeOfArrival);
 
-artoa.controller.edit.updateAvailablePlots();
+%% Update plots
+
+artoa.controller.edit.recalculateToaGpsAndPlot();
+%artoa.controller.edit.updateAvailablePlots();
 
 end
 

lib/+artoa/+controller/+edit/+timeOfArrival/updateControls.m

@@ -11,4 +11,11 @@ else
     artoaGui.editTimeOfArrival.checkboxUseOffsets.Value = false;
 end
 
+if artoa.data.hasMember(artoaWorkspace, {'trackParameter', 'useEmpiricalShift'})
+    artoaGui.editTimeOfArrival.checkboxUseEmpiricalShift.Value = ...
+        artoaWorkspace.trackParameter.useEmpiricalShift;
+else
+    artoaGui.editTimeOfArrival.checkboxUseEmpiricalShift.Value = false;
+end
+
 end

lib/+artoa/+controller/+edit/recalculateToaGpsAndPlot.m

@@ -11,7 +11,7 @@ end
 %% Recalculate TOAs
 
 % prepare toa data for recalculation
-toaData = artoa.controller.prepareToaDataForCalculations();
+toaData = artoa.controller.getInputToaDataWithEmpiricalShift();
 
 if artoaWorkspace.editOffsets.useOffsets
     artoaWorkspace.toaData = artoa.toa.recalculate( ...

lib/+artoa/+controller/+main/open.m

@@ -40,6 +40,7 @@ callbacks.convertProfilesToRfb = @artoa.controller.file.profile2rfb.open;
 %% Prepare callbacks for track parameter
 callbacks.checkboxDopplerCorrection = @artoa.controller.track.parameter.checkboxDopplerCorrection;
 callbacks.checkboxCalculateVariations = @artoa.controller.track.parameter.checkboxCalculateVariations;
+callbacks.checkboxUseEmpiricalShift = @artoa.controller.track.parameter.checkboxUseEmpiricalShift;
 callbacks.comboboxInterpolationMethod = @artoa.controller.track.parameter.comboboxInterpolationMethod;
 callbacks.comboboxSoundspeedMethod = @artoa.controller.track.parameter.comboboxSoundspeedMethod;
 callbacks.inputOutputInterpolationInterval = @artoa.controller.track.parameter.inputOutputInterpolationInterval;

lib/+artoa/+controller/+main/updateControls.m

@@ -11,4 +11,11 @@ else
     artoaGui.editOffsets.checkboxUseOffsets.Value = false;
 end
 
+if artoa.data.hasMember(artoaWorkspace, {'trackParameter', 'useEmpiricalShift'})
+    artoaGui.trackParameter.checkboxUseEmpiricalShift.Value = ...
+        artoaWorkspace.trackParameter.useEmpiricalShift;
+else
+    artoaGui.trackParameter.checkboxUseEmpiricalShift.Value = false;
+end
+
 end

lib/+artoa/+controller/+track/+parameter/checkboxUseEmpiricalShift.m

+function [] = checkboxUseEmpiricalShift(~, event)
+%CHECKBOXAPPLYEMPIRICALSHIFT Toggles the value that decides wether to use
+%empiricalShift in tracking algorithm.
+%   Detailed explanation goes here
+
+global artoaWorkspace artoaGui;
+
+if nargin == 0
+    newValue = logical(artoaGui.trackParameter.checkboxUseEmpiricalShift.Value);
+else
+    newValue = logical(event.Source.Value);
+end
+
+artoaWorkspace.trackParameter.useEmpiricalShift = newValue;
+
+%% Update gui
+% Needs to be done because the checkbox has also been integrated into the TOA window.
+artoa.controller.edit.timeOfArrival.updateControls();
+
+%% Recalculate
+artoa.controller.edit.recalculateToaGpsAndPlot();
+
+end
+

lib/+artoa/+controller/+track/+parameter/updateGui.m

@@ -18,6 +18,8 @@ for i = 1:length(fieldNames)
             artoaGui.trackParameter.checkboxDopplerCorrection.Value = currentValue;
         case 'calculateVariations'
             artoaGui.trackParameter.checkboxCalculateVariations.Value = currentValue;
+        case 'useEmpiricalShift'
+            artoaGui.trackParameter.checkboxUseEmpiricalShift.Value = currentValue;
         case 'trackingMethodValue'
             artoaGui.trackParameter.comboboxTrackingMethod.Value = currentValue;
         case 'interpolationMethodValue'

lib/+artoa/+controller/+track/calculateTrajectoryObject.m

@@ -71,7 +71,17 @@ trajectoryObject.temperature(dateIndices) = artoaWorkspace.temperature(indices);
         };
 
         % reset the toa data for recalculation
+        % in general there is no reason why you create a workspace
+        % and use the initial state of the data as input to
+        % the tracking algorithm.
+        % However in this case, the tracking algorithm contains
+        % all necessary preparations to the data and applies them.
+        % This was due to a design that allows to use the tracking
+        % algorithm in separate from the rest of the program.
+        % If this should be subject to change, it is required to remove all
+        % adjustments to the TOA data in the tracking algorithm below.
         toaData = artoaWorkspace.toaData;
+        toaData.toa = artoaDataInput.toaData.toa;
 
         [ ...
             trajectory, ...

lib/+artoa/+controller/prepareToaDataForCalculations.m → lib/+artoa/+controller/getInputToaDataWithEmpiricalShift.m

-function [toaData] = prepareToaDataForCalculations()
+function [toaData] = getInputToaDataWithEmpiricalShift()
 %PREPARETOADATAFORCALCULATIONS This function returns a toaData struct that matches the initial state including the empirical shift.
 %   This function is required to recalculate the TOAs. Because toaData.toa
 %   is used for storing the TOAs that have been calculated, this struct is
@@ -9,6 +9,12 @@ function [toaData] = prepareToaDataForCalculations()
 global artoaWorkspace artoaDataInput;
 
 toaData = artoaWorkspace.toaData;
+toaData.toa = artoaDataInput.toaData.toa;
 
-toaData.toa = artoaDataInput.toaData.toa - artoaWorkspace.toaData.empiricalShift;
+%% Add emprical shift if selected
+if artoaWorkspace.trackParameter.useEmpiricalShift
+    toaData.toa = artoaDataInput.toaData.toa + artoaWorkspace.toaData.empiricalShift;
 end
+
+end
+

lib/+artoa/+gui/+edit/timeOfArrival.m

@@ -269,6 +269,16 @@ artoaGui.editTimeOfArrival.checkboxUseOffsets = uicontrol( ...
     'CallBack', artoaGui.callbacks.timeOfArrival.checkboxUseOffsets ...
 );
 
+artoaGui.editTimeOfArrival.checkboxUseEmpiricalShift = uicontrol( ...
+    'Parent', artoaGui.editTimeOfArrival.frameControlsMisc, ...
+    'String', 'Apply empirical shift', ...
+    'Style', 'checkbox', ...
+    'FontSize', 8, ...
+    'Units', 'normalized', ...
+    'Position', [.156 .25 .69 .3], ...
+    'CallBack', artoaGui.callbacks.timeOfArrival.checkboxUseEmpiricalShift ...
+);
+
 %% Duplicate applied TOA table
 
 artoaGui.editTimeOfArrival.frameDuplicateAppliedToa = uipanel( ...

lib/+artoa/+gui/main.m

@@ -31,6 +31,7 @@ availableCallbacks = { ...
     'switchHideDeletedDataPoints', ...
     'checkboxDopplerCorrection', ... % FIRST ITEM TRACK PARAMETER CALLBACKS
     'checkboxCalculateVariations', ...
+    'checkboxUseEmpiricalShift', ...
     'comboboxInterpolationMethod', ...
     'comboboxSoundspeedMethod', ...
     'inputOutputInterpolationInterval', ...
@@ -504,6 +505,17 @@ artoaGui.trackParameter.checkboxCalculateVariations = uicontrol( ...
     'CallBack', pCallbacks.checkboxCalculateVariations ...
 );
 
+artoaGui.trackParameter.checkboxUseEmpiricalShift = uicontrol( ...
+    'Parent', artoaGui.trackParameter.frameTrackButtons, ...
+    'String', 'Use empirical shift', ...
+    'Style', 'checkbox', ...
+    'FontSize', 8, ...
+    'Units', 'normalized', ...
+    'Position', [left+.075 .25 .20 2.5*buttonHeight], ...
+    'Value', 0, ...
+    'CallBack', pCallbacks.checkboxUseEmpiricalShift ...
+);
+
 % Combination buttons frame
 
 artoaGui.trackParameter.frameCombinationButtons = uipanel( ...

lib/+artoa/+trajectory/calculate.m

@@ -62,8 +62,11 @@ if pOffsetsParameter.useOffsets
         pOffsetsParameter.offsets, ...
         soundsourceStruct ...
     );
-    pToaData.toa = pToaData.toa - pToaData.empiricalShift;
+end
 
+%% Use empirical shift if selected
+if pTrackingParameter.useEmpiricalShift
+    pToaData.toa = pToaData.toa + -1 * pToaData.empiricalShift;
 end
 
 %% Prepare data for every sound source
@@ -411,4 +414,4 @@ for oCombination = 1:size(soundsourceCombinations, 1)
 end
 
 
-end
+end
\ No newline at end of file

lib/+artoa/+versioning/+migrations/apply.m

@@ -50,7 +50,7 @@ try
     disp(['Starting migration from Version ' itmVersion ' to Version ' versionsFileNames(end).name(2:end - 2)]);
 
     %% Modify required variables
-    for o = 1:size(versionsFileNames)
+    for o = 1:length(versionsFileNames)
         if (versionsFileNames(o).isdir)
             warning([versionsFileNames(o).name 'is a directory and will be omitted...']);
             continue;

lib/+artoa/+versioning/+migrations/versions/v4368.m

+%% Add variable for the usage of empirical shift
+if ~artoa.data.hasMember(artoaWorkspace, 'trackParameter', 'useEmpiricalShift')
+	artoaWorkspace.trackParameter.useEmpiricalShift = any(artoaWorkspace.toaData.empiricalShift ~= 0);
+end