Merge pull request #210 from ImperialCollegeLondon/fix/small-app-fixes

fix: Small app fixes

Author: mfacchinelli

resources/mpackage.json

@@ -1,6 +1,6 @@
 {
     "name": "MAGDataVisualization",
-    "version": "8.5.0",
+    "version": "8.5.1",
     "id": "69962df8-e93e-47cd-a1d6-766ad3e9da8a",
     "formerNames": [],
     "displayName": "MAG Data Visualization",

resources/release-notes.md

@@ -1,12 +1,5 @@
-## App
-
-- (All) Add "Health" tab to display health check results
-- (All) Exported MAT file is renamed to "Analysis (dd-MMM-yyyy HHmmss).mat"
-- (All) Issue a warning if an analysis generated with older release is imported
-
 ## Software
 
-- (IMAP) Add health checks for secondary currents and voltages, temperatures, saturation, missed ITFs, and activation
-- (IMAP) HK figure names include first timestamp date and time
-- (All) `mag.Instrument/crop` method crops data based on input timerange, not science timerange
-- (All) `mag.version` should not return a `datetime`-like string
+- (All) Fix issue with loading events from `mag.TimeSeries` in `mag.graphics.chart.Stackedplot` (when `EventsVisible = true`)
+- (IMAP) Support old IMAP science file format (file time defined as `HH'h'` instead of `HH'h'mm`)
+- (IMAP) Fix typos is power health check descriptions

src/analyze/+mag/+process/Timestamp.m

@@ -51,8 +51,8 @@
             end
 
             % Add time offset to all timestamps.
-            timeStamp = coarseAndFineTime(:, 1) + (coarseAndFineTime(:, 2) / double(intmax("uint16")));
-            time = timeStamp + timeOffset;
+            timestamp = coarseAndFineTime(:, 1) + (coarseAndFineTime(:, 2) / double(intmax("uint16")));
+            time = timestamp + timeOffset;
         end
     end
 end

src/data/+mag/Science.m

@@ -29,8 +29,6 @@
         CompressionWidth (:, 1) double
         % QUALITY Quality flag denoting whether data is of high quality.
         Quality (:, 1) mag.meta.Quality
-        % EVENTS Events detected.
-        Events eventtable
     end
 
     properties (SetAccess = immutable)
@@ -109,10 +107,6 @@
             quality = this.Data.(this.Settings.Quality);
         end
 
-        function events = get.Events(this)
-            events = this.Data.Properties.Events;
-        end
-
         function crop(this, timeFilter)
 
             arguments

src/data/+mag/TimeSeries.m

@@ -13,6 +13,8 @@
         Time (:, 1) datetime
         % DT Time derivative.
         dT (:, 1) duration
+        % EVENTS Events detected.
+        Events eventtable
         IndependentVariable
         DependentVariables
     end
@@ -31,6 +33,10 @@
             dt = this.computeDerivative(this.Time);
         end
 
+        function events = get.Events(this)
+            events = this.Data.Properties.Events;
+        end
+
         function independentVariable = get.IndependentVariable(this)
             independentVariable = this.Time;
         end

src/mission/imap/+mag/+imap/+health/Power.m

@@ -226,11 +226,11 @@ function checkMissedITFFrames(this, pwr)
                 limit = limits{v};
 
                 if any(value < limit(1))
-                    results(end + 1) = mag.health.Result(Name = v, Status = status, Description = compose("Exceeds %s low limits (%.5g < %.5g).", type, min(value), limit(1)));
+                    results(end + 1) = mag.health.Result(Name = v, Status = status, Description = compose("Exceeds %s low limit (%.5g < %.5g).", type, min(value), limit(1)));
                 end
 
                 if any(value > limit(2))
-                    results(end + 1) = mag.health.Result(Name = v, Status = status, Description = compose("Exceeds %s high limits (%.5g > %.5g).", type, max(value), limit(2)));
+                    results(end + 1) = mag.health.Result(Name = v, Status = status, Description = compose("Exceeds %s high limit (%.5g > %.5g).", type, max(value), limit(2)));
                 end
             end
         end

src/mission/imap/+mag/+imap/+in/ScienceCSV.m

@@ -33,26 +33,26 @@
             rawSecondary = rawData(:, regexpPattern(".*(sec|sequence|compression).*"));
 
             % Extract file metadata.
-            [mode, primaryFrequency, secondaryFrequency, packetFrequency, timeStamp] = this.extractFileMetadata(fileName);
+            [mode, primaryFrequency, secondaryFrequency, packetFrequency, timestamp] = this.extractFileMetadata(fileName);
 
             % Process science data.
-            data = [this.processScience(rawPrimary, "pri", Sensor = mag.meta.Sensor.FOB, Mode = mode, DataFrequency = primaryFrequency, PacketFrequency = packetFrequency, Timestamp = timeStamp), ...
-                this.processScience(rawSecondary, "sec", Sensor = mag.meta.Sensor.FIB, Mode = mode, DataFrequency = secondaryFrequency, PacketFrequency = packetFrequency, Timestamp = timeStamp)];
+            data = [this.processScience(rawPrimary, "pri", Sensor = mag.meta.Sensor.FOB, Mode = mode, DataFrequency = primaryFrequency, PacketFrequency = packetFrequency, Timestamp = timestamp), ...
+                this.processScience(rawSecondary, "sec", Sensor = mag.meta.Sensor.FIB, Mode = mode, DataFrequency = secondaryFrequency, PacketFrequency = packetFrequency, Timestamp = timestamp)];
         end
     end
 
     methods (Access = private)
 
-        function [mode, primaryFrequency, secondaryFrequency, packetFrequency, timeStamp] = extractFileMetadata(this, fileName)
+        function [mode, primaryFrequency, secondaryFrequency, packetFrequency, timestamp] = extractFileMetadata(this, fileName)
         % EXTRACTMETADATA Extract metadata information from file name.
 
             rawData = regexp(fileName, this.FileNamePattern, "names");
 
             % If no metadata was found, assume default values.
             if isempty(rawData)
 
-                timeStamp = regexp(fileName, "(?<date>\d+)-(?<time>\w+)", "names");
-                timeStamp = datetime(timeStamp.date + timeStamp.time, InputFormat = "uuuuMMddHH'h'mm", TimeZone = mag.time.Constant.TimeZone, Format = mag.time.Constant.Format);
+                timestamp = regexp(fileName, "(?<date>\d+)-(?<time>\w+)", "names");
+                timestamp = mag.time.decodeDate(timestamp.date + timestamp.time, ExtraFormats = "uuuuMMdd" + ["HH'h'mm", "HH'h'"]);
 
                 if contains(fileName, "ialirt", IgnoreCase = true)
 
@@ -84,7 +84,8 @@
                 primaryFrequency = rawData.primaryFrequency;
                 secondaryFrequency = rawData.secondaryFrequency;
                 packetFrequency = rawData.packetFrequency;
-                timeStamp = datetime(rawData.date + rawData.time, InputFormat = "uuuuMMddHH'h'mm", TimeZone = mag.time.Constant.TimeZone, Format = mag.time.Constant.Format);
+
+                timestamp = mag.time.decodeDate(rawData.date + rawData.time, ExtraFormats = "uuuuMMdd" + ["HH'h'mm", "HH'h'"]);
             end
         end
 

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

@@ -1,8 +1,11 @@
-function date = decodeDate(date)
+function date = decodeDate(date, options)
 % DECODEDATE Decode a date string as a duration.
 
     arguments (Input)
         date string {mustBeScalarOrEmpty}
+        options.ExtraFormats (1, :) string = string.empty()
+        options.TimeZone (1, 1) string = mag.time.Constant.TimeZone
+        options.DisplayFormat (1, 1) string = mag.time.Constant.Format
     end
 
     arguments (Output)
@@ -13,6 +16,10 @@
     formats = horzcat(formats, replace(formats, "-", "/"));
     formats = horzcat(formats, replace(formats, "-", " "));
 
+    if ~isempty(options.ExtraFormats)
+        formats = [formats, options.ExtraFormats];
+    end
+
     conversion = @(f) datetime(date, InputFormat = f);
 
     for f = formats
@@ -21,8 +28,8 @@
 
             date = conversion(f);
 
-            date.TimeZone = mag.time.Constant.TimeZone;
-            date.Format = mag.time.Constant.Format;
+            date.TimeZone = options.TimeZone;
+            date.Format = options.DisplayFormat;
             return;
         catch exception
 

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

@@ -1,15 +1,21 @@
-function time = decodeTime(time)
+function time = decodeTime(time, options)
 % DECODETIME Decode a time string as a duration.
 
     arguments (Input)
         time string {mustBeScalarOrEmpty}
+        options.ExtraFormats (1, :) string = string.empty()
     end
 
     arguments (Output)
         time duration {mustBeScalarOrEmpty}
     end
 
     formats = ["hh:mm", "hh:mm:ss", "hh:mm:ss.SSS"];
+
+    if ~isempty(options.ExtraFormats)
+        formats = [formats, options.ExtraFormats];
+    end
+
     conversion = @(f) duration(time, InputFormat = f);
 
     for f = formats

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

@@ -67,7 +67,7 @@
 
                 graph(y) = plot(ax, xData, yData(:, y), this.MarkerStyle{:}, this.LineCustomization{:}, Color = colors(y, :));
 
-                if this.EventsVisible && ~isempty(data.Properties.Events)
+                if this.EventsVisible
                     this.addEventsData(ax, data);
                 end
             end
@@ -78,11 +78,21 @@
 
         function addEventsData(ax, data)
 
+            if isa(data, "mag.TimeSeries")
+                events = data.Events;
+            elseif istimetable(data)
+                events = data.Properties.Events;
+            else
+                events = [];
+            end
+
+            if isempty(events)
+                return;
+            end
+
             hold(ax, "on");
             resetAxesHold = onCleanup(@() hold(ax, "off"));
 
-            events = data.Properties.Events;
-
             eventTimes = events.Properties.RowTimes;
             eventLabels = events.(events.Properties.EventLabelsVariable);