Create new SpectralIndexvalues class

Issue #252 Create a new SpectralIndexValues class just for Content description so that we can use a results class that fits the purpose, i.e. just six spectral indices.

src/AudioAnalysisTools/ContentDescriptionTools/SpectralIndexValuesforContentDescription.cs

@@ -0,0 +1,183 @@
+// <copyright file="SpectralIndexValuesforContentDescription.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 AudioAnalysisTools.Indices
+{
+    using System;
+    using System.Collections.Generic;
+    using System.Drawing;
+    using System.Linq;
+    using Acoustics.Shared;
+    using AnalysisBase.ResultBases;
+    //using Fasterflect;
+    using TowseyLibrary;
+
+    /// <summary>
+    /// TODO THIS CLASS IS WORK IN PROGRESS.
+    /// IT IS PART OF CONTENT DESCRIPTION project.
+    /// Purpose of this class is to avoid using the class IndexCalculateResult for returning results from IndexCalculateSixOnly.Analysis();
+    /// This class is stripped down to just the required six spectral indices.
+    /// </summary>
+    public class SpectralIndexValuesforContentDescription : ResultBase
+    {
+        //static SpectralIndexValuesforContentDescription()
+        //{
+        //    var getters = ReflectionExtensions.GetGetters<SpectralIndexValues, double[]>();
+
+        //    CachedSelectors = new Dictionary<string, Func<SpectralIndexBase, double[]>>(getters.Count);
+        //    foreach (var keyValuePair in getters)
+        //    {
+        //        // var key = keyValuePair.Key;
+        //        var selector = keyValuePair.Value;
+
+        //        CachedSelectors.Add(
+        //            keyValuePair.Key,
+        //            spectrumBase => selector((SpectralIndexValues)spectrumBase));
+        //    }
+
+        //    Keys = CachedSelectors.Keys.ToArray();
+
+        //    var setters = ReflectionExtensions.GetSetters<SpectralIndexValues, double[]>();
+
+        //    CachedSetters = new Dictionary<string, Action<SpectralIndexValues, double[]>>(getters.Count);
+        //    foreach (var keyValuePair in setters)
+        //    {
+        //        // var key = keyValuePair.Key;
+        //        var setter = keyValuePair.Value;
+
+        //        CachedSetters.Add(
+        //            keyValuePair.Key,
+        //            (spectrumBase, value) => setter(spectrumBase, value));
+        //    }
+        //}
+
+        public SpectralIndexValuesforContentDescription()
+        {
+            // empty constructor important!
+        }
+
+        //public SpectralIndexValuesforContentDescription(int spectrumLength, Dictionary<string, IndexProperties> indexProperties, IndexCalculateConfig configuration)
+        //{
+        //    foreach (var cachedSetter in CachedSetters)
+        //    {
+        //        var defaultValue = 0.0;
+
+        //        if (indexProperties.ContainsKey(cachedSetter.Key))
+        //        {
+        //            var indexProperty = indexProperties[cachedSetter.Key];
+        //            if (indexProperty.IsSpectralIndex)
+        //            {
+        //                defaultValue = indexProperty.DefaultValue;
+        //            }
+        //        }
+
+        //        double[] initArray = new double[spectrumLength].FastFill(defaultValue);
+
+        //        // WARNING: Potential throw site
+        //        // No need to give following warning because should call CheckExistenceOfSpectralIndexValues() method before entering loop.
+        //        // This prevents multiple warnings through loop.
+        //        //this.SetPropertyValue(cachedSetter.Key, initArray);
+
+        //        cachedSetter.Value(this, initArray);
+        //    }
+
+        //    this.Configuration = configuration;
+        //}
+
+        /// <summary>
+        /// Imports a dictionary of spectra.
+        /// Assumes `CheckExistenceOfSpectralIndexValues` has already been called.
+        /// Assumes frequency component is in fist index (i.e. frequency is rows) and time in second index (time is columns).
+        /// </summary>
+        /// <param name="dictionaryOfSpectra">
+        /// The dictionary to convert to spectral index base
+        /// </param>
+        public static SpectralIndexValues[] ImportFromDictionary(Dictionary<string, double[,]> dictionaryOfSpectra)
+        {
+            return dictionaryOfSpectra.FromTwoDimensionalArray(CachedSetters, TwoDimensionalArray.Rotate90AntiClockWise);
+        }
+
+        /// <summary>
+        /// Used to check that the keys in the indexProperties dictionary correspond to Properties in the SpectralIndexValues class.
+        /// Call this method before entering a loop because do not want the error message at every iteration through loop.
+        /// </summary>
+        public static void CheckExistenceOfSpectralIndexValues(Dictionary<string, IndexProperties> indexProperties)
+        {
+            foreach (var kvp in indexProperties)
+            {
+                if (!kvp.Value.IsSpectralIndex)
+                {
+                    continue;
+                }
+
+                var success = CachedSelectors.ContainsKey(kvp.Key);
+                if (!success)
+                {
+                    LoggedConsole.WriteWarnLine(
+                        "### WARNING: The PROPERTY <" + kvp.Key + "> does not exist in the SpectralIndexValues class!");
+                }
+            }
+        }
+
+        public static Dictionary<string, Func<SpectralIndexBase, double[]>> CachedSelectors { get; }
+
+        public static Dictionary<string, Action<SpectralIndexValues, double[]>> CachedSetters { get; }
+
+        public static string[] Keys { get; }
+
+        public static Image CreateImageOfSpectralIndices(SpectralIndexValues spectralIndices)
+        {
+            var images = new List<Image>();
+            foreach (var key in Keys)
+            {
+                var spectrum = CachedSelectors[key](spectralIndices);
+                double[] normalisedIndex = DataTools.normalise(spectrum);
+
+                var image = GraphsAndCharts.DrawGraph(key, normalisedIndex, 100);
+                images.Add(image);
+            }
+
+            var combinedImage = ImageTools.CombineImagesVertically(images.ToArray());
+            return combinedImage;
+        }
+
+        /// <summary>
+        /// Gets the configuration used to generate these results.
+        /// </summary>
+        /// <remarks>
+        /// This property was added when we started generating lots of results that used
+        /// different parameters - we needed a way to disambiguate them.
+        /// </remarks>
+        public IndexCalculateConfig Configuration { get; }
+
+        // 1:
+        public double[] ACI { get; set; }
+
+        // 2:
+        public double[] BGN { get; set; }
+
+        // Entropy
+        // 4:
+        public double[] ENT { get; set; }
+
+        // 5:
+        public double[] EVN { get; set; }
+
+        /// <summary>
+        /// Gets or sets the oscillation spectral index index. Created October 2018.
+        /// </summary>
+        public double[] OSC { get; set; }
+
+        /// <summary>
+        /// Gets or sets PMN = Power Minus Noise.
+        /// PMN is measured in decibels but should replace POW as the average decibel spectrogram.
+        /// </summary>
+        public double[] PMN { get; set; }
+
+        //public override Dictionary<string, Func<SpectralIndexBase, double[]>> GetSelectors()
+        //{
+        //    return CachedSelectors;
+        //}
+    }
+}

src/AudioAnalysisTools/Indices/IndexCalculateSixOnly.cs

@@ -67,6 +67,7 @@ public static IndexCalculateResult Analysis(
             int freqBinCount = frameSize / 2;
             var indexProperties = GetIndexProperties();
             var result = new IndexCalculateResult(freqBinCount, indexProperties, indexCalculationDuration, segmentOffsetTimeSpan, config);
+            //var result = new SpectralIndexValuesforContentDescription();
 
             //result.SummaryIndexValues = null;
             SpectralIndexValues spectralIndices = result.SpectralIndexValues;