task: remove use of computePSD

ImperialCollegeLondon · Dec 16, 2024 · 02ebcdc · 02ebcdc
1 parent eda1862
commit 02ebcdc
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 3 deletions.
diff --git a/resources/release-notes.md b/resources/release-notes.md
@@ -6,3 +6,4 @@
 # Software
 
 - Add support for PSD and Spectrogram for HelioSwarm data visualization
+- Remove use of `mag.Science/computePSD` and warn for deprecation
diff --git a/src/data/+mag/Science.m b/src/data/+mag/Science.m
@@ -274,6 +274,9 @@ function replace(this, timeFilter, filler)
         end
 
         function data = computePSD(this, varargin)
+
+            warning("""computePSD"" will be removed in a future release. With appropriate changes, use ""mag.psd"" instead.");
+
             data = mag.psd(this, varargin{:});
         end
     end

diff --git a/src/mission/imap/+mag/+imap/+view/EventPSD.m b/src/mission/imap/+mag/+imap/+view/EventPSD.m
@@ -77,7 +77,7 @@ function visualize(this)
                 if (duration > 0) && (height(data.Data(timerange(startTime, startTime + duration, "closed"), :)) > 7)
 
                     % Compute PSD.
-                    psd = data.computePSD(Start = startTime, Duration = duration);
+                    psd = mag.psd(data, Start = startTime, Duration = duration);
 
                     % Add plot.
                     charts = [charts, {psd, ...

diff --git a/tests/unit/data/tScience.m b/tests/unit/data/tScience.m
@@ -370,7 +370,7 @@ function computePSD_sineWave_default(testCase)
             science = testCase.createSineWaveTestData();
 
             % Execute.
-            psd = science.computePSD();
+            psd = testCase.verifyWarning(@() science.computePSD(), "");
 
             % Verify.
             [~, idxMax] = max([psd.X, psd.Y, psd.Z]);
@@ -386,7 +386,7 @@ function computePSD_sineWave_startAndDuration(testCase)
             science = testCase.createSineWaveTestData();
 
             % Execute.
-            psd = science.computePSD(Start = science.Time(10), Duration = milliseconds(500));
+            psd = testCase.verifyWarning(@() science.computePSD(Start = science.Time(10), Duration = milliseconds(500)), "");
 
             % Verify.
             [~, idxMax] = max([psd.X, psd.Y, psd.Z]);
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,3 +6,4 @@
		# Software

		- Add support for PSD and Spectrogram for HelioSwarm data visualization
		- Remove use of `mag.Science/computePSD` and warn for deprecation
-Original file line number
+Diff line change
@@ Expand Up / @@ -274,6 +274,9 @@ function replace(this, timeFilter, filler) @@
             end
             function data = computePSD(this, varargin)
+                warning("""computePSD"" will be removed in a future release. With appropriate changes, use ""mag.psd"" instead.");
                 data = mag.psd(this, varargin{:});
             end
         end
@@ Expand Down @@