Issue332 create new spectrogram types

AudioAnalysis.sln.DotSettings

@@ -300,6 +300,7 @@
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=dedupe/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=DTMF/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Ecosounds/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=enumerables/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=ffmpeg/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=ffprobe/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=flac/@EntryIndexedValue">True</s:Boolean>

src/Acoustics.Shared/Acoustics.Shared.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFramework>netcoreapp3.1</TargetFramework>
     <AssemblyTitle>Acoustics.Shared</AssemblyTitle>
@@ -28,6 +28,7 @@
     <PackageReference Include="Microsoft.Extensions.Configuration" Version="3.1.6" />
     <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="3.1.6" />
     <PackageReference Include="Mono.Posix.NETStandard" Version="1.0.0" />
+    <PackageReference Include="morelinq" Version="3.3.2" />
     <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
     <PackageReference Include="ObjectCloner" Version="2.2.2" />
     <PackageReference Include="ObjectCloner.Extensions" Version="2.0.1" />

src/Acoustics.Shared/ColorScales/Palette.cs

@@ -16,6 +16,6 @@ public class Palette
 
         public List<Color[]> Colors { get; internal set; }
 
-        public Color[] ForClassCount(int classCount) => this.Colors.FirstOrDefault(x => x.Length == classCount);
+        public Color[] ForClassCount(int classCount) => this.Colors.FirstOrDefault(x => x.Length >= classCount);
     }
 }

src/Acoustics.Shared/Extensions/ArrayExtensions.cs

@@ -10,7 +10,12 @@
 // ReSharper disable once CheckNamespace
 namespace System
 {
+    //using MoreLinq;
+    using static MoreLinq.Extensions.RepeatExtension;
+    using System.Collections.Generic;
     using System.Diagnostics;
+    using System.Linq;
+    using Acoustics.Shared.Extensions;
 
     public static class ArrayExtensions
     {
@@ -105,6 +110,43 @@ public static T[] Print<T>(this T[] array)
             return array;
         }
 
+        /// <summary>
+        /// Prints a multi-dimensional matrix as a C# literal.
+        /// </summary>
+        /// <remarks>Assumes all ranks have a lower bound of zero.</remarks>
+        /// <typeparam name="T">Cast element items to T before toString is called.</typeparam>
+        /// <param name="array">The source array to print.</param>
+        public static string PrintAsLiteral<T>(this Array array)
+        {
+            var dimensions = Enumerable.Range(0, array.Rank);
+            var sizes = dimensions.Select(array.GetLength).ToArray();
+            //var dimensionsWithSize = dimensions.Zip(sizes);
+
+            var last = Enumerable.Range(0, sizes[^1]).ToArray();
+
+            // the last dimension we iterate across to generate the literal values
+            var result = sizes[..^1]
+                .Select(s => Enumerable.Range(0, s))
+                .MultiCartesian(FormatValue)
+                .Join(", ")
+                .WordWrap(leftPadding: 4, splitOn: "},", keepSplit: true);
+
+            return @$"{{
+                {result}
+            }}";
+
+            string FormatValue(IEnumerable<int> indices)
+            {
+                var depth = sizes.Length;
+                var lineDepth = depth - 1;
+                var start = "{ ".Repeat(lineDepth).Join();
+                var end = " }".Repeat(lineDepth).Join();
+                var value = last.Select(x => (T)array.GetValue(indices.Append(x).ToArray())).Join(", ");
+
+                return start + value + end;
+            }
+        }
+
         /// <summary>
         /// Compares two arrays, matching each element in order using the default Equals method for the array type T.
         /// </summary>

src/Acoustics.Shared/Extensions/CartesianExtension.cs

@@ -0,0 +1,77 @@
+// <copyright file="CartesianExtension.cs" company="QutEcoacoustics">
+// All code in this file and all associated files are the copyright and property of the QUT Ecoacoustics Research Group (formerly MQUTeR, and formerly QUT Bioacoustics Research Group).
+// </copyright>
+
+namespace Acoustics.Shared.Extensions
+{
+    using System;
+    using System.Collections.Generic;
+    using System.Linq;
+    using MoreLinq.Extensions;
+
+    /// <summary>
+    /// Extensions to the MoreLinq.Cartesian function.
+    /// </summary>
+    public static class CartesianExtension
+    {
+        /// <summary>
+        /// Returns the Cartesian product of multiple sequences by combining each element of every set with every other element
+        /// and applying the user-defined projection to the pair.
+        /// </summary>
+        /// <typeparam name="TSource">The type of the elements of <paramref name="enumerables"/>.</typeparam>
+        /// <typeparam name="TResult">The type of the elements of the result sequence.</typeparam>
+        /// <param name="enumerables">The sequence of sequences of element.s</param>
+        /// <param name="resultSelector">A projection function that combines elements from both sequences.</param>
+        /// <returns>A sequence representing the Cartesian product of the source sequences.</returns>
+        public static IEnumerable<TResult> MultiCartesian<TSource, TResult>(
+            this IEnumerable<IEnumerable<TSource>> enumerables,
+            Func<IEnumerable<TSource>, TResult> resultSelector)
+        {
+            if (enumerables == null)
+            {
+                throw new ArgumentNullException(nameof(enumerables));
+            }
+
+            if (resultSelector == null)
+            {
+                throw new ArgumentNullException(nameof(resultSelector));
+            }
+
+            var enumerators = enumerables
+                .Select(e => e?.GetEnumerator() ?? throw new ArgumentException("One of the enumerables is null"))
+                .Pipe(e => e.MoveNext())
+                .ToArray();
+
+            do
+            {
+                yield return resultSelector(enumerators.Select(e => e.Current));
+            } while (MoveNext());
+
+            foreach (var enumerator in enumerators)
+            {
+                enumerator.Dispose();
+            }
+
+            bool MoveNext()
+            {
+                for (var i = enumerators.Length - 1; i >= 0; i--)
+                {
+                    if (enumerators[i].MoveNext())
+                    {
+                        return true;
+                    }
+
+                    if (i == 0)
+                    {
+                        continue;
+                    }
+
+                    enumerators[i].Reset();
+                    enumerators[i].MoveNext();
+                }
+
+                return false;
+            }
+        }
+    }
+}

src/Acoustics.Shared/Extensions/ExtensionsString.cs

@@ -203,13 +203,15 @@ public static string Truncate(this string text, int length, string ellipsis, boo
             return text + ellipsis;
         }
 
-        public static string WordWrap(this string text, int wrapThreshold = 120, int leftPadding = 0)
+        public static string WordWrap(this string text, int wrapThreshold = 120, int leftPadding = 0, string splitOn = " ", bool keepSplit = false)
         {
             if (string.IsNullOrEmpty(text))
             {
                 return text;
             }
 
+            int splitLength = splitOn.Length;
+
             string leftPad = string.Empty.PadRight(leftPadding);
 
             // wrap lines
@@ -229,16 +231,16 @@ public static string WordWrap(this string text, int wrapThreshold = 120, int lef
 
                 while (currentLine.Length > wrapThreshold)
                 {
-                    int splitPoint = currentLine.Substring(0, wrapThreshold).LastIndexOf(' ');
+                    int splitPoint = currentLine.Substring(0, wrapThreshold).LastIndexOf(splitOn);
 
                     if (splitPoint < 0)
                     {
                         splitPoint = wrapThreshold; // cuts through a word
                     }
 
-                    result.AppendLine(leftPad + currentLine.Substring(0, splitPoint));
+                    result.AppendLine(leftPad + currentLine.Substring(0, splitPoint + (keepSplit ? splitLength : 0)));
 
-                    currentLine = currentLine.Substring(splitPoint + 1);
+                    currentLine = currentLine.Substring(splitPoint + splitLength);
                 }
 
                 if (currentLine.IsNotWhitespace())

src/AnalysisConfigFiles/Towsey.SpectrogramGenerator.yml

@@ -26,7 +26,10 @@ Images:
   - DecibelSpectrogramNoiseReduced
   - Experimental
   - DifferenceSpectrogram
+  - MelScaleSpectrogram
   - CepstralSpectrogram
+  - OctaveScaleSpectrogram
+  - RibbonSpectrogram
   - AmplitudeSpectrogramLocalContrastNormalization
 
 

src/AnalysisPrograms/PlanesTrainsAndAutomobiles.cs

@@ -185,18 +185,23 @@ public static Tuple<BaseSonogram, double[,], double[], List<AcousticEvent>> Dete
             TimeSpan duration = recording.Duration;
             NoiseReductionType nrt = SNR.KeyToNoiseReductionType("STANDARD");
 
-            var sonogram = (BaseSonogram)SpectrogramStandard.GetSpectralSonogram(
-                recording.BaseName,
-                windowSize,
-                windowOverlap,
-                bitsPerSample,
-                windowPower,
-                sr,
-                duration,
-                nrt,
-                matrix);
-
-            sonogram.DecibelsNormalised = new double[rowCount];
+            //Set the default values config
+            SonogramConfig sonoConfig = new SonogramConfig
+            {
+                SourceFName = recording.BaseName,
+                WindowSize = windowSize,
+                WindowOverlap = windowOverlap,
+                NoiseReductionType = nrt,
+                epsilon = Math.Pow(0.5, bitsPerSample - 1),
+                WindowPower = windowPower,
+                SampleRate = sr,
+                Duration = duration,
+            };
+
+            var sonogram = new SpectrogramStandard(sonoConfig, matrix)
+            {
+                DecibelsNormalised = new double[rowCount],
+            };
 
             //foreach frame or time step
             for (int i = 0; i < rowCount; i++)
@@ -205,7 +210,7 @@ public static Tuple<BaseSonogram, double[,], double[], List<AcousticEvent>> Dete
             }
 
             sonogram.DecibelsNormalised = DataTools.normalise(sonogram.DecibelsNormalised);
-            return Tuple.Create(sonogram, hits, scoreArray, predictedEvents);
-        } //end Execute_HDDetect
+            return Tuple.Create((BaseSonogram)sonogram, hits, scoreArray, predictedEvents);
+        }
     }
-} //end class PlanesTrainsAndAutomobiles
+}