Add TODO notes to two classes

Issue #278 Add TODO notes to two methods which call GenerateSpectrograms().
QutEcoacoustics · Dec 13, 2019 · 3c544d9 · 3c544d9
1 parent 5752c02
commit 3c544d9
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 11 deletions.
diff --git a/src/AnalysisPrograms/Audio2InputForConvCNN.cs b/src/AnalysisPrograms/Audio2InputForConvCNN.cs
@@ -795,27 +795,19 @@ public AnalysisResult2 Analyze<T>(AnalysisSettings analysisSettings, SegmentSett
             var audioFile = segmentSettings.SegmentAudioFile;
             var recording = new AudioRecording(audioFile.FullName);
             var outputDirectory = segmentSettings.SegmentOutputDirectory;
-
-            var analysisResult = new AnalysisResult2(analysisSettings, segmentSettings, recording.Duration);
-
             bool saveCsv = analysisSettings.AnalysisDataSaveBehavior;
-
-            //Config configuration = ConfigFile.Deserialize(analysisSettings.ConfigFile);
-            //if (configuration.GetBoolOrNull(AnalysisKeys.MakeSoxSonogram) == true)
-            //{
-            //    Log.Warn("SoX spectrogram generation config variable found (and set to true) but is ignored when running as an IAnalyzer");
-            //}
+            var analysisResult = new AnalysisResult2(analysisSettings, segmentSettings, recording.Duration);
 
             // generate spectrogram
+            // TODO the following may need to be checked since change of method signature in December 2019.
             //var configurationDictionary = new Dictionary<string, string>(configuration.ToDictionary());
             //configurationDictionary[ConfigKeys.Recording.Key_RecordingCallName] = audioFile.FullName;
             //configurationDictionary[ConfigKeys.Recording.Key_RecordingFileName] = audioFile.Name;
             //var soxImage = new FileInfo(Path.Combine(segmentSettings.SegmentOutputDirectory.FullName, audioFile.Name + ".SOX.png"));
             var configInfo = ConfigFile.Deserialize<AnalyzerConfig>(analysisSettings.ConfigFile);
             var spectrogramResult = Audio2Sonogram.GenerateSpectrogramImages(audioFile, configInfo);
 
-            // this analysis produces no results!
-            // but we still print images (that is the point)
+            // this analysis produces no results! But we still print images (that is the point)
             if (analysisSettings.AnalysisImageSaveBehavior.ShouldSave(analysisResult.Events.Length))
             {
                 Debug.Assert(segmentSettings.SegmentImageFile.Exists);

diff --git a/src/AnalysisPrograms/SURFAnalysis.cs b/src/AnalysisPrograms/SURFAnalysis.cs
@@ -530,6 +530,7 @@ public AnalysisResult2 Analyze<T>(AnalysisSettings analysisSettings, SegmentSett
             //var soxImage = new FileInfo(Path.Combine(segmentSettings.SegmentOutputDirectory.FullName, audioFile.Name + ".SOX.png"));
 
             // generate spectrogram
+            // TODO the following may need to be checked since change of method signature in December 2019.
             var configInfo = ConfigFile.Deserialize<AnalyzerConfig>(analysisSettings.ConfigFile);
             var spectrogramResult = Audio2Sonogram.GenerateSpectrogramImages(audioFile, configInfo);