GetWaveDimensions: Add it

Although the function is rather short, it is still nicer to have a single instance of the code. We also choose to use a double precision wave as that holds all possible current wave sizes and does not have the various issues as the 64bit integer waves have.
AllenInstitute · Aug 19, 2024 · 5583b7e · 5583b7e
1 parent 71bffbb
commit 5583b7e
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 8 deletions.
diff --git a/Packages/MIES/MIES_PulseAveraging.ipf b/Packages/MIES/MIES_PulseAveraging.ipf
@@ -3448,12 +3448,12 @@ static Function/S PA_ShowImage(string win, STRUCT PulseAverageSettings &pa, STRU
 				scaleChanged   = (DimOffset(img, ROWS) != refScaleLeft) || (DimOffset(img, ROWS) + (DimSize(img, ROWS) - 1) * DimDelta(img, ROWS) != refScaleRight)
 				xUnits         = WaveUnits(set2[0][0], ROWS)
 
-				Make/FREE/N=(MAX_DIMENSION_COUNT) oldSizes = DimSize(img, p)
+				WAVE oldSizes = GetWaveDimensions(img)
 				EnsureLargeEnoughWave(img, indexShouldExist = requiredEntries, dimension = COLS, initialValue = NaN)
 				Redimension/N=(refScalePoints, -1) img
 				// inclusive scale must be set after redimension
 				SetScale/P x, refScaleLeft, refScaleDelta, xUnits, img
-				Make/FREE/N=(MAX_DIMENSION_COUNT) newSizes = DimSize(img, p)
+				WAVE newSizes = GetWaveDimensions(img)
 
 				if(!(mode != POST_PLOT_ADDED_SWEEPS                       \
 				     || !EqualWaves(oldSizes, newSizes, EQWAVES_DATA)     \

diff --git a/Packages/MIES/MIES_Utilities_WaveHandling.ipf b/Packages/MIES/MIES_Utilities_WaveHandling.ipf
@@ -78,7 +78,7 @@ threadsafe Function EnsureLargeEnoughWave(WAVE wv, [variable indexShouldExist, v
 	Make/FREE/L/N=(MAX_DIMENSION_COUNT) targetSizes = -1
 	targetSizes[dimension] = indexShouldExist
 
-	Make/FREE/L/N=(MAX_DIMENSION_COUNT) oldSizes = DimSize(wv, p)
+	WAVE oldSizes = GetWaveDimensions(wv)
 
 	Redimension/N=(targetSizes[ROWS], targetSizes[COLS], targetSizes[LAYERS], targetSizes[CHUNKS]) wv
 
@@ -115,14 +115,22 @@ Function EnsureSmallEnoughWave(wv, [maximumSize])
 		maximumSize = MAXIMUM_WAVE_SIZE
 	endif
 
-	Make/FREE/I/N=(MAX_DIMENSION_COUNT) oldSizes
-	oldSizes[] = DimSize(wv, p)
+	WAVE oldSizes = GetWaveDimensions(wv)
 
 	if(oldSizes[ROWS] > maximumSize)
 		Redimension/N=(maximumSize, -1, -1, -1) wv
 	endif
 End
 
+/// @brief Return a wave with `MAX_DIMENSION_COUNT` entries with the size of each dimension
+threadsafe Function/WAVE GetWaveDimensions(WAVE wv)
+
+	ASSERT_TS(WaveExists(wv), "Missing wave")
+	Make/FREE/D/N=(MAX_DIMENSION_COUNT) sizes = DimSize(wv, p)
+
+	return sizes
+End
+
 /// @brief Returns the size of the wave in bytes
 threadsafe static Function GetWaveSizeImplementation(wv)
 	WAVE wv
@@ -616,8 +624,7 @@ threadsafe Function ReduceWaveDimensionality(WAVE/Z wv, [variable minDimension])
 	minDimension = ParamIsDefault(minDimension) ? COLS : minDimension
 	ASSERT_TS(IsInteger(minDimension) && minDimension >= ROWS && minDimension < MAX_DIMENSION_COUNT, "Invalid minDimension")
 	minDimension = limit(minDimension, COLS, MAX_DIMENSION_COUNT - 1)
-	Make/FREE/N=(MAX_DIMENSION_COUNT) waveSize
-	waveSize[] = DimSize(wv, p)
+	WAVE waveSize = GetWaveDimensions(wv)
 	for(i = MAX_DIMENSION_COUNT - 1; i >= minDimension; i -= 1)
 		if(waveSize[i] == 1)
 			waveSize[i] = 0

diff --git a/Packages/tests/Basic/UTF_Utils_WaveHandling.ipf b/Packages/tests/Basic/UTF_Utils_WaveHandling.ipf
@@ -1225,7 +1225,7 @@ Function RUR_Works()
 
 	WAVE dup = RemoveUnusedRows(wv)
 
-	Make/FREE/N=(MAX_DIMENSION_COUNT) dims = DimSize(dup, p)
+	WAVE dims = GetWaveDimensions(dup)
 	CHECK_EQUAL_WAVES(dims, {4, 3, 2, 0}, mode = WAVE_DATA)
 	CHECK(!WaveRefsEqual(wv, dup))
 End
@@ -1944,3 +1944,33 @@ Function ZWI_Works3()
 End
 
 /// @}
+
+/// GetWaveDimensions
+/// @{
+
+Function GWD_ChecksParam()
+
+	try
+		GetWaveDimensions($"")
+		FAIL()
+	catch
+		CHECK_NO_RTE()
+	endtry
+End
+
+Function GWD_Works()
+
+	Make/FREE/N=0 wv
+	WAVE sizes = GetWaveDimensions(wv)
+	CHECK_EQUAL_WAVES(sizes, {0, 0, 0, 0}, mode = WAVE_DATA)
+
+	Make/FREE/N=(1, 2, 3, 4) wv
+	WAVE sizes = GetWaveDimensions(wv)
+	CHECK_EQUAL_WAVES(sizes, {1, 2, 3, 4}, mode = WAVE_DATA)
+
+	Make/FREE/N=(1, 2, 0, 4) wv
+	WAVE sizes = GetWaveDimensions(wv)
+	CHECK_EQUAL_WAVES(sizes, {1, 2, 0, 4}, mode = WAVE_DATA)
+End
+
+/// @}