Merge pull request #161 from ImperialCollegeLondon/task/hs-field-events

task: Add support for HelioSwarm events in field view

Author: mfacchinelli

.env

@@ -1 +1 @@
-MAG_DATA_VISUALIZATION_VERSION=7.7.1
+MAG_DATA_VISUALIZATION_VERSION=7.8.0

.vscode/settings.json

@@ -12,6 +12,7 @@
         "**/*~": true
     },
     "cSpell.words": [
+        "AGROW",
         "Bartington",
         "cspice",
         "downsample",
@@ -20,6 +21,8 @@
         "IMAP",
         "Plottable",
         "signedness",
-        "SOLARORBITER"
+        "SOLARORBITER",
+        "Stackedplot",
+        "SUPPORTEDEVENTS"
     ]
 }

app/mission/hs/+mag/+app/+hs/+control/Field.m

@@ -0,0 +1,71 @@
+classdef Field < mag.app.Control & mag.app.mixin.StartEndDate
+% FIELD View-controller for generating "mag.hs.view.Field".
+
+    properties (Constant)
+        Name = "Field"
+    end
+
+    properties (Constant, Access = private)
+        % SUPPORTEDEVENTS Events supported by "mag.hs.view.Field".
+        SupportedEvents (1, 1) string = "Range"
+    end
+
+    properties (SetAccess = private)
+        Layout matlab.ui.container.GridLayout
+        EventsTree matlab.ui.container.CheckBoxTree
+    end
+
+    methods
+
+        function instantiate(this, parent)
+
+            this.Layout = this.createDefaultGridLayout(parent);
+
+            % Start and end dates.
+            this.addStartEndDateButtons(this.Layout, StartDateRow = 1, EndDateRow = 2);
+
+            % Events.
+            eventsLabel = uilabel(this.Layout, Text = "Events:");
+            eventsLabel.Layout.Row = 3;
+            eventsLabel.Layout.Column = 1;
+
+            this.EventsTree = uitree(this.Layout, "checkbox");
+            this.EventsTree.Layout.Row = [3, 4];
+            this.EventsTree.Layout.Column = [2, 3];
+
+            for e = this.SupportedEvents
+                uitreenode(this.EventsTree, Text = e);
+            end
+        end
+
+        function supported = isSupported(~, results)
+            supported = results.HasScience;
+        end
+
+        function command = getVisualizeCommand(this, results)
+
+            arguments (Input)
+                this
+                results (1, 1) mag.Instrument
+            end
+
+            arguments (Output)
+                command (1, 1) mag.app.Command
+            end
+
+            [startTime, endTime] = this.getStartEndTimes();
+
+            if isempty(this.EventsTree.CheckedNodes)
+                events = string.empty();
+            else
+                events = {this.EventsTree.CheckedNodes.Text};
+            end
+
+            results = mag.app.internal.cropResults(results, startTime, endTime);
+
+            command = mag.app.Command(Functional = @(varargin) mag.hs.view.Field(varargin{:}).visualizeAll(), ...
+                PositionalArguments = {results}, ...
+                NamedArguments = struct(Events = string(events)));
+        end
+    end
+end

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

@@ -9,7 +9,7 @@
 
         function supportedVisualizations = getSupportedVisualizations(~, ~)
 
-            supportedVisualizations = [mag.app.control.Field(@mag.hs.view.Field), ...
+            supportedVisualizations = [mag.app.hs.control.Field(), ...
                 mag.app.control.HK(@mag.hs.view.HK), ...
                 mag.app.control.PSD(@mag.hs.view.PSD), ...
                 mag.app.control.Spectrogram(@mag.hs.view.Spectrogram), ...

resources/release-notes.md

@@ -1,3 +1,7 @@
+## App
+
+- (HelioSwarm) Add support for visualizing Range events with field
+
 ## Software
 
 - (All) Add option to specify PNG resolution when saving figures

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

@@ -1,6 +1,11 @@
 classdef Field < mag.graphics.view.View
 % FIELD Show magnetic field and optional HK for HelioSwarm.
 
+    properties
+        % EVENTS Event names to show.
+        Events (1, :) string {mustBeMember(Events, "Range")} = string.empty()
+    end
+
     methods
 
         function this = Field(results, options)
@@ -22,23 +27,27 @@ function visualize(this)
             science = this.Results.Science;
             hk = this.Results.HK;
 
+            [numEvents, eventData] = this.getEventData(science);
+
             if this.Results.HasHK
 
                 this.Figures = this.Factory.assemble( ...
                     science, mag.graphics.style.Stackedplot(Title = this.getFieldTitle(science), YLabels = ["x [nT]", "y [nT]", "z [nT]", "|B| [nT]"], Layout = [3, 1], Charts = mag.graphics.chart.Stackedplot(YVariables = ["X", "Y", "Z", "B"], Filter = science.Quality.isPlottable())), ...
+                    eventData{:}, ...
                     hk, mag.graphics.style.Default(Title = "Temperatures", YLabel = this.TLabel, Legend = ["Board", "Sensor"], Charts = mag.graphics.chart.Plot(YVariables = ["Board", "Sensor"] + "Temperature")), ...
                     Title = this.getFigureTitle(science), ...
                     Name = this.getFigureName(science), ...
-                    Arrangement = [4, 1], ...
+                    Arrangement = [4 + numEvents, 1], ...
                     LinkXAxes = true, ...
                     WindowState = "maximized");
             else
 
                 this.Figures = this.Factory.assemble( ...
                     science, mag.graphics.style.Stackedplot(Title = this.getFieldTitle(science), YLabels = ["x [nT]", "y [nT]", "z [nT]", "|B| [nT]"], Layout = [3, 1], Charts = mag.graphics.chart.Stackedplot(YVariables = ["X", "Y", "Z", "B"], Filter = science.Quality.isPlottable())), ...
+                    eventData{:}, ...
                     Title = this.getFigureTitle(science), ...
                     Name = this.getFigureName(science), ...
-                    Arrangement = [3, 1], ...
+                    Arrangement = [3 + numEvents, 1], ...
                     LinkXAxes = true, ...
                     WindowState = "maximized");
             end
@@ -47,6 +56,31 @@ function visualize(this)
 
     methods (Access = private)
 
+        function [numEvents, eventData] = getEventData(this, science)
+
+            numEvents = 0;
+            eventData = {};
+
+            if ~science.HasData
+                return;
+            end
+
+            for e = this.Events
+
+                switch e
+                    case "Range"
+
+                        % TODO: This should not rely on mag.imap.chart.Event, which is IMAP-specific.
+                        numEvents = numEvents + 1;
+                        ed = {science, mag.graphics.style.Default(Title = "Ranges", YLabel = "range [-]", YLimits = "manual", Charts = mag.imap.chart.Event(EventOfInterest = "Range", IgnoreMissing = false, YOffset = 0.25))};
+                    otherwise
+                        error("Unrecognized event ""%s"".", e);
+                end
+
+                eventData = [eventData, ed]; %#ok<AGROW>
+            end
+        end
+
         function value = getFigureTitle(this, data)
             value = compose("%s (%s)", data.Metadata.getDisplay("Mode"), this.getDataFrequency(data.Metadata));
         end