Updated all recognisers with new metadata fields

Also removed a few that were plain broken and definitely unused

src/AnalysisBase/AbstractStrongAnalyser.cs

@@ -34,6 +34,8 @@ public abstract class AbstractStrongAnalyser : IAnalyser2
         /// <inheritdoc/>
         public virtual AnalysisSettings DefaultSettings => new AnalysisSettings();
 
+        public abstract Status Status { get; }
+
         /// <inheritdoc cref="IAnalyser2.ParseConfig"/>
         public virtual AnalyzerConfig ParseConfig(FileInfo file)
         {

src/AnalysisBase/IHasStatus.cs

@@ -13,6 +13,6 @@ namespace AnalysisBase
 {
     public interface IHasStatus
     {
-        public Status Status => Status.Unknown;
+        public Status Status { get; }
     }
 }

src/AnalysisBase/Status.cs

@@ -1,5 +1,5 @@
 // --------------------------------------------------------------------------------------------------------------------
-// <copyright file="IAnalyser2.cs" company="QutEcoacoustics">
+// <copyright file="Status.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>
 // <summary>
@@ -13,12 +13,39 @@ namespace AnalysisBase
 {
     public enum Status
     {
+        /// <summary>
+        /// Unknown or not set.
+        /// </summary>
         Unknown = 0,
+
+        /// <summary>
+        /// Code exists and it may run without failure.
+        /// </summary>
         InDevelopment,
+
+        /// <summary>
+        /// The analysis works as determined by at least one unit test.
+        /// </summary>
         Alpha,
+
+        /// <summary>
+        /// The analysis is covered by a suite of external tests as well as internal unit tests.
+        /// </summary>
         Beta,
+
+        /// <summary>
+        /// Works, internal tests, external tests, wide spread utility.
+        /// </summary>
         Maintained,
+
+        /// <summary>
+        /// Not maintined, or updated. May work but most likely stale and out of date.
+        /// </summary>
         Unmaintained,
+
+        /// <summary>
+        /// Does not work, or you are advised not to use due to fundamental problems.
+        /// </summary>
         Retired,
     }
 }

src/AnalysisPrograms/AED.cs

@@ -119,6 +119,8 @@ public AedConfiguration()
         /// </summary>
         public override string Identifier => EcosoundsAedIdentifier;
 
+        public override Status Status => Status.Maintained;
+
         public static Tuple<EventCommon[], AudioRecording, BaseSonogram> Detect(
             FileInfo audioFile,
             AedConfiguration aedConfiguration,

src/AnalysisPrograms/AcousticIndices.cs

@@ -54,7 +54,7 @@ public class AcousticIndices : IAnalyser2
         public string Identifier => TowseyAcoustic;
 
         public string Description
-            => "[BETA] Generates all our default summary & spectral acoustic indices. Also generates false color spectrograms IFF IndexCalculationDuration==60.0";
+            => "Generates all our default summary & spectral acoustic indices. Also generates false color spectrograms IFF IndexCalculationDuration==60.0";
 
         public void BeforeAnalyze(AnalysisSettings analysisSettings)
         {
@@ -489,5 +489,7 @@ public static IndexCalculateResult[] CalculateIndicesInSubsegments(
             SegmentMediaType = MediaTypes.MediaTypeWav,
             SegmentOverlapDuration = TimeSpan.Zero,
         };
+
+        public Status Status => Status.Maintained;
     }
 }

src/AnalysisPrograms/Audio2InputForConvCNN.cs

@@ -782,6 +782,8 @@ public PreprocessorForConvDnn()
 
         public AnalysisSettings DefaultSettings { get; private set; }
 
+        public Status Status => Status.Unmaintained;
+
         public AnalyzerConfig ParseConfig(FileInfo file)
         {
             return ConfigFile.Deserialize<AnalyzerConfig>(file);

src/AnalysisPrograms/ChannelIntegrity.cs

@@ -27,6 +27,8 @@ public class ChannelIntegrityAnalyzer : AbstractStrongAnalyser
 
         public override string Identifier => "Towsey.ChannelIntegrity";
 
+        public override Status Status => Status.Alpha;
+
         public override AnalysisResult2 Analyze<T>(AnalysisSettings analysisSettings, SegmentSettings<T> segmentSettings)
         {
             // boilerplate Analyzer

src/AnalysisPrograms/ContentDescription/UseModel.cs

@@ -58,6 +58,8 @@ public class UseModel : AbstractStrongAnalyser
             AnalysisTargetSampleRate = ContentSignatures.SampleRate,
         };
 
+        public override Status Status => Status.InDevelopment;
+
         public override void BeforeAnalyze(AnalysisSettings analysisSettings)
         {
             // Read in the functional templates file. These doe the content description.

src/AnalysisPrograms/EventStatistics/EventStatisticsAnalysis.cs

@@ -28,7 +28,7 @@ public class EventStatisticsAnalysis : AbstractStrongAnalyser
 
         public override string Identifier { get; } = "Ecosounds.EventStatistics";
 
-        public override string Description { get; } = "[BETA] Calculates useful statistics (features) from an acoustic event";
+        public override string Description { get; } = "Calculates useful statistics (features) from an acoustic event";
 
         public override AnalysisSettings DefaultSettings { get; } = new AnalysisSettings
         {
@@ -41,6 +41,8 @@ public class EventStatisticsAnalysis : AbstractStrongAnalyser
             AnalysisTargetSampleRate = null,
         };
 
+        public override Status Status => Status.Maintained;
+
         public override AnalyzerConfig ParseConfig(FileInfo file)
         {
             return ConfigFile.Deserialize<EventStatisticsConfiguration>(file);

src/AnalysisPrograms/GroundParrotRecogniser.cs

@@ -42,7 +42,7 @@ public class GroundParrotRecogniser : AbstractStrongAnalyser
         private const string EcosoundsGroundParrotIdentifier = "Ecosounds.GroundParrot";
         private static readonly ILog Log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
 
-        public override string Description => "[UNMAINTAINED] Uses event pattern recognition for ground-parrots";
+        public override string Description => "Uses event pattern recognition for ground-parrots";
 
         [Command(
             CommandName,
@@ -275,6 +275,8 @@ public static List<AcousticEvent> ReadGroundParrotTemplateAsList(BaseSonogram so
 
         public override string Identifier => EcosoundsGroundParrotIdentifier;
 
+        public override Status Status => Status.Unmaintained;
+
         public override AnalysisResult2 Analyze<T>(AnalysisSettings analysisSettings, SegmentSettings<T> segmentSettings)
         {
             FileInfo audioFile = segmentSettings.SegmentAudioFile;

src/AnalysisPrograms/KoalaMale.cs

@@ -57,7 +57,7 @@ public class KoalaMale : AbstractStrongAnalyser
 
         public const int ResampleRate = 17640;
 
-        public override string Description => "[BETA/EXPERIMENTAL] Recogniser for male koalla bellow. Detects inhalation oscillations.";
+        public override string Description => "Recogniser for male koalla bellow. Detects inhalation oscillations.";
 
         public string DefaultConfiguration => string.Empty;
 
@@ -74,6 +74,8 @@ public class KoalaMale : AbstractStrongAnalyser
 
         public override string Identifier => "Towsey." + AnalysisName;
 
+        public override Status Status => Status.Unmaintained;
+
         public static KoalaMaleResults Analysis(FileInfo segmentOfSourceFile, IDictionary<string, string> configDict, TimeSpan segmentStartOffset)
         {
             var recording = new AudioRecording(segmentOfSourceFile.FullName);

src/AnalysisPrograms/Recognizers/Base/MultiRecognizer.cs

@@ -50,6 +50,10 @@ public class MultiRecognizerConfig : RecognizerConfig
 
         public override string SpeciesName => "MultiRecognizer";
 
+        public override string CommonName => string.Empty;
+
+        public override Status Status => Status.Unmaintained;
+
         private static readonly ILog Log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
 
         public override AnalyzerConfig ParseConfig(FileInfo file)

src/AnalysisPrograms/Recognizers/Birds/AnthusNovaeseelandiae.cs

@@ -43,6 +43,10 @@ internal class AnthusNovaeseelandiae : RecognizerBase
 
         public override string Description => "[ALPHA] Designed to detect chirrup calls of the Australian Pipit.";
 
+        public override string CommonName => "Australasian pipit";
+
+        public override Status Status => Status.Alpha;
+
         public override AnalyzerConfig ParseConfig(FileInfo file)
         {
             RuntimeHelpers.RunClassConstructor(typeof(PipitConfig).TypeHandle);

src/AnalysisPrograms/Recognizers/Birds/ArdeaInsignis.cs

@@ -33,12 +33,16 @@ namespace AnalysisPrograms.Recognizers.Birds
     /// </summary>
     public class ArdeaInsignis : RecognizerBase
     {
-        public override string Description => "[BETA/Experimental] White Heron - Bhutan";
+        public override string Description => "White Heron - Bhutan";
 
         public override string Author => "Towsey";
 
         public override string SpeciesName => "ArdeaInsignis";
 
+        public override string CommonName => "White Heron";
+
+        public override Status Status => Status.Beta;
+
         private static readonly ILog Log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
 
         /// <summary>

src/AnalysisPrograms/Recognizers/Birds/CisticolaExilis.cs

@@ -39,7 +39,11 @@ internal class CisticolaExilis : RecognizerBase
 
         public override string SpeciesName => "CisticolaExilis";
 
-        public override string Description => "[ALPHA] Detects acoustic events for the golden-headed cisticola.";
+        public override string Description => "Detects acoustic events for the golden-headed cisticola.";
+
+        public override string CommonName => "Golden-headed cisticola";
+
+        public override Status Status => Status.InDevelopment;
 
         public override AnalyzerConfig ParseConfig(FileInfo file)
         {

src/AnalysisPrograms/Recognizers/Birds/LewiniaPectoralis.cs

@@ -46,6 +46,10 @@ public class LewiniaPectoralis : RecognizerBase
 
         public override string SpeciesName => "LewiniaPectoralis";
 
+        public override string CommonName => "Lewin's Rail";
+
+        public override Status Status => Status.Beta;
+
         private static readonly ILog Log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
 
         //private const bool DoRecognizerTest = true;

src/AnalysisPrograms/Recognizers/Birds/NinoxBoobook.cs

@@ -40,7 +40,11 @@ internal class NinoxBoobook : RecognizerBase
 
         public override string SpeciesName => "NinoxBoobook";
 
-        public override string Description => "[ALPHA] Detects acoustic events for the Australian Boobook owl.";
+        public override string Description => "Detects acoustic events for the Australian Boobook owl.";
+
+        public override string CommonName => "Boobook Owl";
+
+        public override Status Status => Status.Alpha;
 
         public override AnalyzerConfig ParseConfig(FileInfo file)
         {

src/AnalysisPrograms/Recognizers/Birds/NinoxConnivens.cs

@@ -34,7 +34,7 @@ public class NinoxConnivens : RecognizerBase
 
         public override string CommonName => "Barking owl";
 
-        public Status Status => Status.InDevelopment;
+        public override Status Status => Status.InDevelopment;
 
         public override string Description => $"Acoustic event recognizer for the {this.CommonName}.";
 

src/AnalysisPrograms/Recognizers/Birds/NinoxStrenua.cs

@@ -34,10 +34,12 @@ public class NinoxStrenua : RecognizerBase
 
         public override string SpeciesName => "NinoxStrenua";
 
-        public override string Description => "[ALPHA] Detects acoustic events for the Australian Powerful Owl.";
+        public override string Description => "Detects acoustic events for the Australian Powerful Owl.";
 
         public override string CommonName => "Powerful Owl";
 
+        public override Status Status => Status.Alpha;
+
         public override AnalyzerConfig ParseConfig(FileInfo file)
         {
             RuntimeHelpers.RunClassConstructor(typeof(NinoxStrenuaConfig).TypeHandle);

src/AnalysisPrograms/Recognizers/Birds/TytoNovaehollandiae.cs

@@ -31,7 +31,7 @@ public class TytoNovaehollandiae : RecognizerBase
 
         public override string CommonName => "Masked owl";
 
-        public Status Status => Status.Alpha;
+        public override Status Status => Status.Alpha;
 
         public override string Description => $"Acoustic event recognizer for the {this.CommonName}.";
 

src/AnalysisPrograms/Recognizers/Birds/TytoTenebricosa.cs

@@ -33,7 +33,7 @@ public class TytoTenebricosa : RecognizerBase
 
         public override string CommonName => "Greater sooty owl";
 
-        public Status Status => Status.InDevelopment;
+        public override Status Status => Status.InDevelopment;
 
         public override string Description => $"Acoustic event recognizer for the {this.CommonName}.";
 

src/AnalysisPrograms/Recognizers/Frogs/CriniaRemota.cs

@@ -48,12 +48,16 @@ namespace AnalysisPrograms.Recognizers.Frogs
     /// </summary>
     internal class CriniaRemota : RecognizerBase
     {
-        public override string Description => "[BETA/Experimental] Remote froglet. See class header for algorithm description.";
+        public override string Description => "Remote froglet. See class header for algorithm description.";
 
         public override string Author => "Towsey";
 
         public override string SpeciesName => "CriniaRemota";
 
+        public override string CommonName => "The Remote froglet";
+
+        public override Status Status => Status.Beta;
+
         //private static readonly ILog Log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
 
         /// <summary>

src/AnalysisPrograms/Recognizers/Frogs/LitoriaBicolor.cs

@@ -43,12 +43,16 @@ namespace AnalysisPrograms.Recognizers.Frogs
 
     public class LitoriaBicolor : RecognizerBase
     {
-        public override string Description => "[ALPHA/EMBRYONIC] Detects acoustic events of Litoria bicolor";
+        public override string Description => "Detects acoustic events of Litoria bicolor";
 
         public override string Author => "Towsey";
 
         public override string SpeciesName => "LitoriaBicolor";
 
+        public override string CommonName => "Northern dwarf tree frog";
+
+        public override Status Status => Status.InDevelopment;
+
         private static readonly ILog Log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
 
         /// <summary>

src/AnalysisPrograms/Recognizers/Frogs/LitoriaCaerulea.cs

@@ -38,12 +38,16 @@ namespace AnalysisPrograms.Recognizers.Frogs
     /// </summary>
     public class LitoriaCaerulea : RecognizerBase
     {
-        public override string Description => "[ALPHA/EMBRYONIC] Detects acoustic events of Litoria caerulea";
+        public override string Description => "Detects acoustic events of Litoria caerulea";
 
         public override string Author => "Towsey";
 
         public override string SpeciesName => "LitoriaCaerulea";
 
+        public override string CommonName => "Common Green Tree Frog";
+
+        public override Status Status => Status.InDevelopment;
+
         private static readonly ILog Log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
 
         /// <summary>

src/AnalysisPrograms/Recognizers/Frogs/LitoriaFallax.cs

@@ -45,6 +45,10 @@ internal class LitoriaFallax : RecognizerBase
 
         public override string SpeciesName => "LitoriaFallax";
 
+        public override string CommonName => "Eastern dwarf tree frog";
+
+        public override Status Status => Status.InDevelopment;
+
         private static readonly ILog Log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
 
         /// <summary>

src/AnalysisPrograms/Recognizers/Frogs/LitoriaFreycineti.cs

@@ -33,12 +33,16 @@ namespace AnalysisPrograms.Recognizers.Frogs
     /// </summary>
     internal class LitoriaFreycineti : RecognizerBase
     {
-        public override string Description => "[ALPHA/EMBRYONIC] Detects acoustic events of Litoria freycineti";
+        public override string Description => "Detects acoustic events of Litoria freycineti";
 
         public override string Author => "Stark";
 
         public override string SpeciesName => "LitoriaFreycineti";
 
+        public override string CommonName => "Freycinet's frog";
+
+        public override Status Status => Status.Unmaintained;
+
         private static readonly ILog Log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
 
         /// <summary>

src/AnalysisPrograms/Recognizers/Frogs/LitoriaNasuta.cs

@@ -41,12 +41,16 @@ namespace AnalysisPrograms.Recognizers.Frogs
     /// </summary>
     internal class LitoriaNasuta : RecognizerBase
     {
-        public override string Description => "[ALPHA/EMBRYONIC] Detects acoustic events of Litoria nasuta";
+        public override string Description => "Detects acoustic events of Litoria nasuta";
 
         public override string Author => "Towsey";
 
         public override string SpeciesName => "LitoriaNasuta";
 
+        public override string CommonName => "The Striped Rocket Frog";
+
+        public override Status Status => Status.InDevelopment;
+
         private static readonly ILog Log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
 
         /// <summary>