Merge pull request #164 from ImperialCollegeLondon/fix/various

fix: Various issues

Author: mfacchinelli

README.md

@@ -35,6 +35,12 @@ See [internal documentation](https://imperialcollege.atlassian.net/wiki/spaces/P
 
 ## Development
 
+To get started, clone this repository and install the package for development:
+
+``` matlab
+mpminstall(pwd(), Authoring = true);
+```
+
 When developing new features or fixing issues, create a new branch. After finishing development, make sure to write tests to cover any new changes.
 
 To change the version of the toolbox, modify the package definition file in `resources/mpackage.json`. This will automatically update the toolbox version and create a new toolbox with the correct version.

app/DataVisualization.m

@@ -126,7 +126,7 @@ function selectMission(app, mission)
                 mission = app.SelectMissionDialog.waitForSelection();
 
                 if app.SelectMissionDialog.Aborted
-                    error("mag:app:abort", "User aborted.");
+                    error("mag:app:Abort", "User aborted.");
                 else
                     app.SelectMissionDialog.delete();
                 end
@@ -144,7 +144,7 @@ function selectMission(app, mission)
                 case mag.meta.Mission.IMAP
                     app.Provider = mag.app.imap.Provider();
                 otherwise
-                    error("mag:app:unsupportedMission", "%s mission not supported.", app.Mission.DisplayName);
+                    error("mag:app:UnsupportedMission", "%s mission not supported.", app.Mission.DisplayName);
             end
 
             % Set managers.

app/core/+mag/+app/+control/SignalAnalyzer.m

@@ -70,7 +70,7 @@ function instantiate(this, parent)
             data = results.(selectedInput);
 
             if ~data.isPlottable()
-                error("mag:app:emptySignal", "Not enough data for plotting ""%s"".", selectedInput);
+                error("mag:app:EmptySignal", "Not enough data for plotting ""%s"".", selectedInput);
             end
 
             selectedData = timetable(data.Time - data.Time(1), data.(selectedSignal), VariableNames = selectedInput + "_" + selectedSignal);

app/core/+mag/+app/+control/WaveletAnalyzer.m

@@ -85,7 +85,7 @@ function instantiate(this, parent)
             data = results.(selectedInput);
 
             if ~data.isPlottable()
-                error("mag:app:emptySignal", "Not enough data for plotting ""%s"".", selectedInput);
+                error("mag:app:EmptySignal", "Not enough data for plotting ""%s"".", selectedInput);
             end
 
             propertyName = selectedInput + "_" + selectedSignal;

app/core/+mag/+app/+internal/removeNonFiniteData.m

@@ -13,7 +13,7 @@
 
     if any(locNonFinite, "all")
 
-        warning("mag:app:nonFiniteData", "Removing non-finite data.");
+        warning("mag:app:NonFiniteData", "Removing non-finite data.");
         data(any(locNonFinite, 2), :) = [];
     end
 end

app/core/+mag/+app/+internal/resampleIrregularData.m

@@ -14,7 +14,7 @@
         dt = diff(data.Properties.RowTimes);
         frequencies = 1 ./ seconds(dt);
 
-        warning("mag:app:nonFiniteData", "Resampling data as not uniformely sampled (%.3f ± %.3g Hz).", mode(frequencies), std(frequencies, 0, "omitmissing"));
+        warning("mag:app:NonFiniteData", "Resampling data as not uniformly sampled (%.3f ± %.3g Hz).", mode(frequencies), std(frequencies, 0, "omitmissing"));
 
         data = resample(data);
     end

app/core/+mag/+app/+manage/ToolbarManager.m

@@ -91,6 +91,10 @@ function setLatestErrorMessage(this, exception)
 
         function unlock(this)
 
+            if ~isvalid(this) || ~isvalid(this.Toolbar)
+                return;
+            end
+
             [this.MissionPushTool.Enable, this.ImportPushTool.Enable, ...
                 this.DebugToggleTool.Enable, this.HelpPushTool.Enable] = deal(true);
         end

app/core/+mag/+app/+manage/VisualizationManager.m

@@ -60,7 +60,7 @@ function reset(this)
         % VISUALIZE Visualize analysis using selected view.
 
             if isempty(this.SelectedControl)
-                error("mag:app:noViewSelected", "No view selected.");
+                error("mag:app:NoViewSelected", "No view selected.");
             end
 
             command = this.SelectedControl.getVisualizeCommand(analysis.Results);

app/mission/bart/+mag/+app/+bart/AnalysisManager.m

@@ -91,9 +91,9 @@ function reset(this)
             location = this.LocationEditField.Value;
 
             if isempty(location)
-                error("mag:app:emptyLocation", "Location is empty.");
+                error("mag:app:EmptyLocation", "Location is empty.");
             elseif ~isfolder(location)
-                error("mag:app:nonexistentLocation", "Location ""%s"" does not exist.", location);
+                error("mag:app:NonexistentLocation", "Location ""%s"" does not exist.", location);
             end
 
             options = {"Location", this.LocationEditField.Value, ...

app/mission/hs/+mag/+app/+hs/AnalysisManager.m

@@ -99,9 +99,9 @@ function reset(this)
             location = this.LocationEditField.Value;
 
             if isempty(location)
-                error("mag:app:emptyLocation", "Location is empty.");
+                error("mag:app:EmptyLocation", "Location is empty.");
             elseif ~isfolder(location)
-                error("mag:app:nonexistentLocation", "Location ""%s"" does not exist.", location);
+                error("mag:app:NonexistentLocation", "Location ""%s"" does not exist.", location);
             end
 
             % Retrieve data file patterns.

app/mission/imap/+mag/+app/+imap/+control/CPT.m

@@ -99,7 +99,7 @@ function validatePattern(~, changingData)
             pattern = asManyOfPattern(digitsPattern() + optionalPattern(characterListPattern(",") + whitespacePattern()));
 
             if ~matches(value, pattern)
-                error("mag:app:invalidPattern", "Value must match the pattern ""1, 2, 3"".");
+                error("mag:app:InvalidPattern", "Value must match the pattern ""1, 2, 3"".");
             end
         end
     end
@@ -115,5 +115,3 @@ function validatePattern(~, changingData)
         end
     end
 end
-
-

app/mission/imap/+mag/+app/+imap/AnalysisManager.m

@@ -128,9 +128,9 @@ function reset(this)
             location = this.LocationEditField.Value;
 
             if isempty(location)
-                error("mag:app:emptyLocation", "Location is empty.");
+                error("mag:app:EmptyLocation", "Location is empty.");
             elseif ~isfolder(location)
-                error("mag:app:nonexistentLocation", "Location ""%s"" does not exist.", location);
+                error("mag:app:NonexistentLocation", "Location ""%s"" does not exist.", location);
             end
 
             % Retrieve data file patterns.

app/mission/imap/+mag/+app/+imap/VisualizationManager.m

@@ -24,7 +24,7 @@
         function figures = visualize(this, analysis)
 
             if isempty(this.SelectedControl)
-                error("mag:app:noViewSelected", "No view selected.");
+                error("mag:app:NoViewSelected", "No view selected.");
             end
 
             if isa(this.SelectedControl, "mag.app.imap.control.AT") || isa(this.SelectedControl, "mag.app.imap.control.CPT")

buildfile.m

@@ -5,7 +5,7 @@
 
     if isMATLABReleaseOlderThan("R2025a")
 
-        warning("mag:buildtool:path", "MATLAB release ""%s"" not supported for development purposes. " + ...
+        warning("mag:buildtool:Path", "MATLAB release ""%s"" not supported for development purposes. " + ...
             "Adding all folders to the path for testing purposes.", matlabRelease().Release);
 
         % Brute-force add all folders to the path.

resources/release-notes.md

@@ -1,6 +1,13 @@
 ## App
 
 - (All) Add shortcut to open app from toolbar (quick access)
+- (All) Fix errors when closing app during mission selection
+
+## Software
+
+- (All) Add `mag.mixin.TimeSeriesOperationSupport` for simplified operations support
+- (All) Fix issues with colors and legends for multiple stackedplots
+- (IMAP) Check there is data before enabling auto-compression event in `mag.imap.view.Field`
 
 ## Package
 

src/data/+mag/+mixin/TimeSeriesOperationSupport.m

@@ -0,0 +1,92 @@
+classdef (Abstract, HandleCompatible) TimeSeriesOperationSupport
+% TIMESERIESOPERATIONSUPPORT Interface adding support for operations on
+% "mag.TimeSeries" subclasses.
+
+% Assume that this class has access to methods and properties of
+% "mag.TimeSeries":
+%#ok<*MCNPN>
+
+    methods (Sealed)
+
+        function result = join(this, those)
+
+            arguments
+                this {mustBeNonempty}
+            end
+
+            arguments (Repeating)
+                those
+            end
+
+            % If no "those" is provided and "this" is an array, combine all
+            % "these" data.
+            if isempty(those) && ~isscalar(this)
+
+                result = this(1).copy();
+                result.Data = sortrows(vertcat(this.Data));
+
+                return;
+            end
+
+            expectedClass = class(this);
+
+            if isscalar(this) && all(cellfun(@(x) isa(x, expectedClass), those))
+
+                thoseData = cellfun(@(x) x.Data, those, UniformOutput = false);
+                joinedData = sortrows(vertcat(this.Data, thoseData{:}));
+
+                result = this.copy();
+                result.Data = joinedData;
+            else
+                error("mag:join:UnsupportedType", """join"" is only supported between mag.TimeSeries objects.");
+            end
+        end
+    end
+
+    methods (Hidden, Sealed)
+
+        function result = plus(this, that)
+
+            arguments
+                this (1, 1)
+                that
+            end
+
+            operation = @(this, that) sortrows(this.Data + that.Data);
+            result = this.performOperationOrFallbackToBuiltin(that, operation, "plus");
+        end
+
+        function result = minus(this, that)
+
+            arguments
+                this (1, 1)
+                that
+            end
+
+            operation = @(this, that) sortrows(this.Data - that.Data);
+            result = this.performOperationOrFallbackToBuiltin(that, operation, "minus");
+        end
+    end
+
+    methods (Access = private)
+
+        function result = performOperationOrFallbackToBuiltin(this, that, operation, functionName, varargin)
+
+            result = [];
+
+            if isscalar(this) && all(isa(that, class(this)))
+
+                result = this.copy();
+                result.Data = operation(this, that);
+
+                return;
+            end
+
+            try
+                result = builtin(functionName, this, that, varargin{:});
+            catch exception
+                exception.throwAsCaller();
+            end
+        end
+    end
+end

src/mission/imap/+mag/+imap/+view/Field.m

@@ -93,7 +93,10 @@ function visualize(this)
 
             selectedEvents = this.Events;
 
-            if isempty(selectedEvents) && (any(diff(primary.Compression) ~= 0) || any(diff(secondary.Compression) ~= 0))
+            if isempty(selectedEvents) && ...
+                ((primary.HasData && any(diff(primary.Compression) ~= 0)) || ...
+                (secondary.HasData && any(diff(secondary.Compression) ~= 0)))
+
                 selectedEvents = "Compression";
             end
 

src/utility/+mag/+time/decodeDate.m

@@ -32,5 +32,5 @@
         end
     end
 
-    error("mag:time:parseError", "Unable to parse date '%s' using the formats %s.", date, join(compose("'%s'", formats), ", "));
+    error("mag:time:ParseError", "Unable to parse date '%s' using the formats %s.", date, join(compose("'%s'", formats), ", "));
 end

src/visualize/+mag/+graphics/+chart/Stackedplot.m

@@ -38,8 +38,12 @@
 
             Ny = width(yData);
 
-            if isempty(this.Colors) || (Ny > size(this.Colors, 1))
+            if height(this.Colors) == 1
+                colors = repmat(this.Colors, Ny, 1);
+            elseif isempty(this.Colors) || (Ny > height(this.Colors))
                 error("Mismatch in number of colors for number of plots.");
+            else
+                colors = this.Colors;
             end
 
             % Check if layout already has a stack layout.
@@ -61,7 +65,7 @@
                 hold(ax, "on");
                 resetAxesHold = onCleanup(@() hold(ax, "off"));
 
-                graph(y) = plot(ax, xData, yData(:, y), this.MarkerStyle{:}, this.LineCustomization{:}, Color = this.Colors(y, :));
+                graph(y) = plot(ax, xData, yData(:, y), this.MarkerStyle{:}, this.LineCustomization{:}, Color = colors(y, :));
 
                 if this.EventsVisible && ~isempty(data.Properties.Events)
                     this.addEventsData(ax, data);

src/visualize/+mag/+graphics/+factory/DefaultFactory.m

@@ -30,10 +30,10 @@
 
             % In MATLAB R2025a and above, force figures in the figures
             % container.
-            if matlabRelease().Release >= "R2025a"
-                windowStyle = "docked";
-            else
+            if isMATLABReleaseOlderThan("R2025a")
                 windowStyle = "normal";
+            else
+                windowStyle = "docked";
             end
 
             % Create and populate figure.

src/visualize/+mag/+graphics/+style/Stackedplot.m

@@ -49,17 +49,17 @@
             xlabel(axes, this.XLabel);
             xlim(axes, this.XLimits);
 
-            l = matlab.graphics.primitive.Text.empty(0, numel(axes));
+            t = matlab.graphics.primitive.Text.empty(0, numel(axes));
 
             if ~isempty(this.YLabels)
 
                 for i = 1:numel(this.YLabels)
-                    l(i) = ylabel(axes(i), this.YLabels(i));
+                    t(i) = ylabel(axes(i), this.YLabels(i));
                 end
             end
 
             if this.RotateLabels
-                [l.Rotation] = deal(0);
+                [t.Rotation] = deal(0);
             end
 
             ylim(axes, this.YLimits);
@@ -72,7 +72,7 @@
             this.applyGridStyle(axes);
 
             % Add legend.
-            l = this.applyLegendStyle(axes);
+            l = this.applyLegendStyle(axes(1));
 
             if ~isempty(l)
                 l.Layout.Tile = this.LegendLocation;

tests/tool/+mag/+test/runTests.m

@@ -0,0 +1,8 @@
+function testResults = runTests()
+% RUNTESTS Run all MAG tests with coverage.
+
+    root = mfilename("fullpath");
+    root = fullfile(fileparts(root), "..", "..", "..");
+
+    testResults = runtests(root, IncludeSubfolders = true, ReportCoverageFor = ["app", "src"]);
+end

tests/unit/app/tSignalAnalyzer.m

@@ -75,7 +75,7 @@ function getVisualizeCommand_nonFiniteData(testCase)
             expectedData = expectedData([1, 3:4, 6:end], :);
 
             % Exercise.
-            command = testCase.verifyWarning(@() signalAnalyzer.getVisualizeCommand(results), "mag:app:nonFiniteData", ...
+            command = testCase.verifyWarning(@() signalAnalyzer.getVisualizeCommand(results), "mag:app:NonFiniteData", ...
                 "Warning should be issued when removing non-finite data.");
 
             % Verify.
@@ -98,7 +98,7 @@ function getVisualizeCommand_noData(testCase)
             results = mag.bart.Instrument();
 
             % Exercise and verify.
-            testCase.verifyError(@() signalAnalyzer.getVisualizeCommand(results), "mag:app:emptySignal", ...
+            testCase.verifyError(@() signalAnalyzer.getVisualizeCommand(results), "mag:app:EmptySignal", ...
                 "Error should be thrown when there is no data to plot.");
         end
     end

tests/unit/app/tVisualizationManager.m

@@ -35,7 +35,7 @@ function visualize_noSelection(testCase, VisualzationClass)
             manager.instantiate(panel);
 
             % Exercise and verify.
-            testCase.verifyError(@() manager.visualize([]), "mag:app:noViewSelected", ...
+            testCase.verifyError(@() manager.visualize([]), "mag:app:NoViewSelected", ...
                 "Error should be thrown when no view is selected.");
         end
     end

tests/unit/app/tWaveletAnalyzer.m

@@ -103,7 +103,7 @@ function getVisualizeCommand_noData(testCase)
             results = mag.bart.Instrument();
 
             % Exercise and verify.
-            testCase.verifyError(@() waveletAnalyzer.getVisualizeCommand(results), "mag:app:emptySignal", ...
+            testCase.verifyError(@() waveletAnalyzer.getVisualizeCommand(results), "mag:app:EmptySignal", ...
                 "Error should be thrown when there is no data to plot.");
         end
     end