Adds documentation to SaveIntermediateCsvFiles config option

Yaml autoformatter also ran.

Fixes #245

src/AnalysisConfigFiles/Ecosounds.AED.yml

@@ -25,7 +25,8 @@ BgNoiseThreshold: 3.5
 ## IAnalyzer Settings
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]
 SaveIntermediateWavFiles: Never
-SaveIntermediateCsvFiles: true
+# If `true` saves a data into a seperate file every `SegmentDuration` seconds. Accepts a boolean value: [false|true]
+SaveIntermediateCsvFiles: false
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]
 SaveSonogramImages: Never
 

src/AnalysisConfigFiles/Ecosounds.GroundParrot.yml

@@ -9,7 +9,8 @@ EprNormalizedMinScore: ~
 ## IAnalyzer Settings
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]
 SaveIntermediateWavFiles: Never
-SaveIntermediateCsvFiles: true
+# If `true` saves a data into a seperate file every `SegmentDuration` seconds. Accepts a boolean value: [false|true]
+SaveIntermediateCsvFiles: false
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]
 SaveSonogramImages: Never
 

src/AnalysisConfigFiles/Ecosounds.StandardizedFeatures.yml

@@ -8,27 +8,27 @@ SegmentDuration: 60
 SegmentOverlap: 0
 
 # Bands array with 4 properties:
-# FftWindow. units=samples. Typical value=512. Overwrites FrameLength. 
+# FftWindow. units=samples. Typical value=512. Overwrites FrameLength.
 # MelScale. units=frequencybins. Overwrites FrequencyScale. Whether frequency is rescaled.
 # Filter. units=?. Whether some filter will be applied. Not implemented yet.
 # Bandwidth. units=fraction. Selects band from amplitude spectrogram. Bandwidth 0.0 - 1.0 equals complete ampliude spectrogram
 Bands:
   - FftWindow: 1024
     MelScale: ~
     Filter: None
-    Bandwidth: 
+    Bandwidth:
       Min: 0.0
       Max: 1.0
   - FftWindow: 512
     MelScale: 200
     Filter: None
-    Bandwidth: 
+    Bandwidth:
       Min: 0.33
       Max: 0.66
   - FftWindow: 1024
     MelScale: 200
     Filter: None
-    Bandwidth: 
+    Bandwidth:
       Min: 0.33
       Max: 0.66
 
@@ -64,6 +64,7 @@ FrequencyScale: Linear
 # SAVE INTERMEDIARY FILES
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]
 SaveIntermediateWavFiles: Never
+# If `true` saves a data into a seperate file every `SegmentDuration` seconds. Accepts a boolean value: [false|true]
 SaveIntermediateCsvFiles: false
 # One-minute spectrograms can be saved in any analysis task.
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]

src/AnalysisConfigFiles/RecognizerConfigFiles/Ecosounds.MultiRecognizer.yml

@@ -2,7 +2,7 @@
 # Summary: Runs a list of event recognizers that implement the IEventRecognizer interface.
 # AnalysisName: Ecosounds.MultiRecognizer
 
-# The default sample rate for all recognizers is 22050. No point changing this. 
+# The default sample rate for all recognizers is 22050. No point changing this.
 # ResampleRate: 22050
 
 # LIST OF REQUIRED SPECIES RECOGNISERS
@@ -29,12 +29,13 @@ EventThreshold: 0.2
 
 
 ## Specifically for AnalyzeLongRecording
-# SegmentDuration: units=seconds;    
+# SegmentDuration: units=seconds;
 SegmentDuration: 60
 # SegmentOverlap: units=seconds;
 SegmentOverlap: 0
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]
 SaveIntermediateWavFiles: Never
+# If `true` saves a data into a seperate file every `SegmentDuration` seconds. Accepts a boolean value: [false|true]
 SaveIntermediateCsvFiles: false
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]
 SaveSonogramImages: True

src/AnalysisConfigFiles/RecognizerConfigFiles/Stark.CriniaTinnula.yml

@@ -3,19 +3,19 @@ SpeciesName: Crinia tinnula
 AbbreviatedSpeciesName: C.tinnula
 
 # min and max of the freq band to search
-MinHz: 3000          
+MinHz: 3000
 MaxHz: 6000
-# duration of DCT in seconds 
+# duration of DCT in seconds
 
 # Event threshold - use this to determine FP / FN trade-off for events.
 EventThreshold: 0.30
 
 Profiles:
     Standard: &Standard
         # min and max of the freq band to search
-        MinHz: 3500          
+        MinHz: 3500
         MaxHz: 6000
-        # duration of DCT in seconds 
+        # duration of DCT in seconds
         DctDuration: 0.15
         # minimum acceptable value of a DCT coefficient
         DctThreshold: 0.6
@@ -29,22 +29,22 @@ Profiles:
         # Event threshold - use this to determine FP / FN trade-off for events.
         EventThreshold: 0.30
     HighFrequency:
-        # Debra wrote this for high oscillation rate calls in Aura 
+        # Debra wrote this for high oscillation rate calls in Aura
         <<: *Standard
-        MinHz: 3800          
+        MinHz: 3800
         MaxHz: 5100
         DctDuration: 0.15
         DctThreshold: 0.45
-        MinOcilFreq: 100       
+        MinOcilFreq: 100
         MaxOcilFreq: 150
         MinDuration: 0.04
         MaxDuration: 0.8
-    LowFrequency: 
+    LowFrequency:
         # Debra wrote this for low oscillation rate calls in Aura
         <<: *Standard
-        MinHz: 3800          
+        MinHz: 3800
         MaxHz: 5100
-        MinOcilFreq: 45        
+        MinOcilFreq: 45
         MaxOcilFreq: 60
         MinDuration: 0.04
 
@@ -57,12 +57,13 @@ Profiles:
 ResampleRate: 22050
 
 ## Specifically for AnalyzeLongRecording
-# SegmentDuration: units=seconds;    
+# SegmentDuration: units=seconds;
 SegmentDuration: 60
 # SegmentOverlap: units=seconds;
 SegmentOverlap: 0
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]
 SaveIntermediateWavFiles: Never
+# If `true` saves a data into a seperate file every `SegmentDuration` seconds. Accepts a boolean value: [false|true]
 SaveIntermediateCsvFiles: false
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]
 SaveSonogramImages: Never

src/AnalysisConfigFiles/RecognizerConfigFiles/Stark.LitoriaFreycineti.yml

@@ -5,7 +5,7 @@ AbbreviatedSpeciesName: L.freycineti
 # min and max of the freq band to search
 MinHz: 1400
 MaxHz: 1900
-# duration of DCT in seconds 
+# duration of DCT in seconds
 DctDuration: 0.10
 # minimum acceptable value of a DCT coefficient
 DctThreshold: 0.60
@@ -24,7 +24,7 @@ Profiles:
         # min and max of the freq band to search
         MinHz: 3000
         MaxHz: 5000
-        # duration of DCT in seconds 
+        # duration of DCT in seconds
         DctDuration: 0.15
         # minimum acceptable value of a DCT coefficient
         DctThreshold: 0.6
@@ -38,7 +38,7 @@ Profiles:
         # Event threshold - use this to determine FP / FN trade-off for events.
         EventThreshold: 0.30
     HighFrequency:
-        # Debra wrote this for high oscillation rate calls in Aura 
+        # Debra wrote this for high oscillation rate calls in Aura
         <<: *Standard
         MinHz: 3800
         MaxHz: 5100
@@ -48,7 +48,7 @@ Profiles:
         MaxOcilFreq: 150
         MinDuration: 0.04
         MaxDuration: 0.8
-    LowFrequency: 
+    LowFrequency:
         # Debra wrote this for low oscillation rate calls in Aura
         <<: *Standard
         MinHz: 3800
@@ -66,12 +66,13 @@ Profiles:
 ResampleRate: 22050
 
 ## Specifically for AnalyzeLongRecording
-# SegmentDuration: units=seconds;    
+# SegmentDuration: units=seconds;
 SegmentDuration: 60
 # SegmentOverlap: units=seconds;
 SegmentOverlap: 0
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]
 SaveIntermediateWavFiles: Never
+# If `true` saves a data into a seperate file every `SegmentDuration` seconds. Accepts a boolean value: [false|true]
 SaveIntermediateCsvFiles: false
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]
 SaveSonogramImages: Never

src/AnalysisConfigFiles/RecognizerConfigFiles/Stark.LitoriaOlong.yml

@@ -3,17 +3,17 @@ SpeciesName: Litoria olongburensis
 AbbreviatedSpeciesName: L.olong
 
 # min and max of the freq band to search
-MinHz: 2000          
+MinHz: 2000
 MaxHz: 3500
-# duration of DCT in seconds 
-# want one that contains 5 oscillations 
+# duration of DCT in seconds
+# want one that contains 5 oscillations
 DctDuration: 0.2
 # minimum acceptable value of a DCT coefficient
 DctThreshold: 0.6
 # ignore oscillation rates below the min & above the max threshold
 # OSCILLATIONS PER SECOND
 
-MinOcilFreq: 22      
+MinOcilFreq: 22
 MaxOcilFreq: 53
 # Minimum and maximum duration for the length of a true call.
 MinDuration: 0.25
@@ -34,12 +34,13 @@ FrameSize: 64
 ResampleRate: 22050
 
 ## Specifically for AnalyzeLongRecording
-# SegmentDuration: units=seconds;    
+# SegmentDuration: units=seconds;
 SegmentDuration: 60
 # SegmentOverlap: units=seconds;
 SegmentOverlap: 0
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]
 SaveIntermediateWavFiles: Never
+# If `true` saves a data into a seperate file every `SegmentDuration` seconds. Accepts a boolean value: [false|true]
 SaveIntermediateCsvFiles: false
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]
 SaveSonogramImages: Never

src/AnalysisConfigFiles/RecognizerConfigFiles/Towsey.ArdeaInsignis.yml

@@ -6,7 +6,7 @@ AbbreviatedSpeciesName: A.insignis
 SeverityOfNoiseRemoval: 2.0
 
 # min and max of the freq band to search
-MinHz: 280          
+MinHz: 280
 MaxHz: 500
 
 # Decibel threshold
@@ -29,12 +29,13 @@ EventThreshold: 0.30
 ResampleRate: 22050
 
 ## Specifically for AnalyzeLongRecording
-# SegmentDuration: units=seconds;    
+# SegmentDuration: units=seconds;
 SegmentDuration: 60
 # SegmentOverlap: units=seconds;
 SegmentOverlap: 5
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]
 SaveIntermediateWavFiles: WhenEventsDetected
+# If `true` saves a data into a seperate file every `SegmentDuration` seconds. Accepts a boolean value: [false|true]
 SaveIntermediateCsvFiles: false
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]
 SaveSonogramImages: WhenEventsDetected

src/AnalysisConfigFiles/RecognizerConfigFiles/Towsey.CriniaRemota.yml

@@ -10,26 +10,27 @@ FrameSize: 128
 #BgNoiseThreshold: 3.0
 
 # min and max of the freq band to search
-MinHz: 3200          
+MinHz: 3200
 MaxHz: 4300
 Dominantfreq: 3500
 # duration of DCT in seconds - default = 0.4
 DctDuration: 0.2
 # minimum acceptable value of a DCT coefficient  # default = 0.6
-DctThreshold: 0.2  
+DctThreshold: 0.2
 # Minimum and maximum duration in seconds for the length of a true call.
 MinDuration: 0.25
 MaxDuration: 0.80
 # Event threshold - use this to determine FP / FN trade-off for events.
 EventThreshold: 0.5
 
 ## Specifically for AnalyzeLongRecording
-# SegmentDuration: units=seconds;    
+# SegmentDuration: units=seconds;
 SegmentDuration: 60
 # SegmentOverlap: units=seconds;
 SegmentOverlap: 0
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]
 SaveIntermediateWavFiles: Never
+# If `true` saves a data into a seperate file every `SegmentDuration` seconds. Accepts a boolean value: [false|true]
 SaveIntermediateCsvFiles: false
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]
 SaveSonogramImages: Never

src/AnalysisConfigFiles/RecognizerConfigFiles/Towsey.CycloranaNovaehollandiae.yml

@@ -3,20 +3,20 @@ SpeciesName: Cyclorana novaehollandiae
 AbbreviatedSpeciesName: C.novae
 
 # min and max of the freq band to search
-MinHz: 400          
+MinHz: 400
 MaxHz: 600
-# duration of DCT in seconds 
+# duration of DCT in seconds
 DctDuration: 0.1
 # minimum acceptable value of a DCT coefficient
 DctThreshold: 0.45
 # ignore oscillation rates below the min & above the max threshold
 # OSCILLATIONS PER SECOND
-MinOcilFreq: 200        
+MinOcilFreq: 200
 MaxOcilFreq: 240
 # Minimum and maximum duration for the length of a true advertisement call.
 # As of 4 June 2015, the Code for Canetoad recogniser was changed to include recognition of release calls.
 # The min duration setting of 5 seconds should not be changed because it is boundary between advert calls ( >5s duration) and release calls (<5s duration).
-# The min duration for a release call will be set = to the DCT duration in the code. 
+# The min duration for a release call will be set = to the DCT duration in the code.
 MinDuration: 0.2
 MaxDuration: 0.3
 # Event threshold - use this to determine FP / FN trade-off for events.
@@ -32,12 +32,13 @@ ResampleRate: 22050
 FrameSize: 64
 
 ## Specifically for AnalyzeLongRecording
-# SegmentDuration: units=seconds;    
+# SegmentDuration: units=seconds;
 SegmentDuration: 60
 # SegmentOverlap: units=seconds;
 SegmentOverlap: 0
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]
 SaveIntermediateWavFiles: Never
+# If `true` saves a data into a seperate file every `SegmentDuration` seconds. Accepts a boolean value: [false|true]
 SaveIntermediateCsvFiles: false
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]
 SaveSonogramImages: Never

src/AnalysisConfigFiles/RecognizerConfigFiles/Towsey.Frogs.OBSOLETE.yml

@@ -4,7 +4,7 @@ DisplayColumns: Frog
 # FROG_DATA_FILE=FrogDataAndCompilationFile.csv
 FROG_DATA_FILE: CompilationOf31FrogSpeciesForCurramoreSE-QLD.csv
 
-#SegmentDuration: units=seconds,   SegmentOverlap=seconds        
+#SegmentDuration: units=seconds,   SegmentOverlap=seconds
 SegmentDuration: 60
 SegmentOverlap: 0
 MinPeriod: 0.01
@@ -16,9 +16,10 @@ IntensityThreshold: 0.22
 #use this threshold if obtaining max value over a period
 #IntensityThreshold: 0.1
 #######################################
-# save sonograms and other files 
+# save sonograms and other files
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]
 SaveIntermediateWavFiles: Never
+# If `true` saves a data into a seperate file every `SegmentDuration` seconds. Accepts a boolean value: [false|true]
 SaveIntermediateCsvFiles: false
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]
 SaveSonogramImages: Never

src/AnalysisConfigFiles/RecognizerConfigFiles/Towsey.IctalurusFurcatus.yml

@@ -6,15 +6,15 @@ AbbreviatedSpeciesName: I.furcatus
 # cat fish produces "stridulatory sounds" by rubbing the base of the pectoral spine against the pectoral girdle...
 
 # min and max of the freq band to search
-MinHz: 3500          
+MinHz: 3500
 MaxHz: 4500
-# duration of DCT in seconds 
+# duration of DCT in seconds
 DctDuration: 0.2
 # minimum acceptable value of a DCT coefficient
 DctThreshold: 0.6
 # ignore oscillation rates below the min & above the max threshold
 # OSCILLATIONS PER SECOND
-MinOcilFreq: 40        
+MinOcilFreq: 40
 MaxOcilFreq: 60
 # Minimum and maximum duration for the length of a true call.
 MinDuration: 0.1
@@ -31,12 +31,13 @@ EventThreshold: 0.30
 # ResampleRate: 22050
 
 ## Specifically for AnalyzeLongRecording
-# SegmentDuration: units=seconds;    
+# SegmentDuration: units=seconds;
 SegmentDuration: 60
 # SegmentOverlap: units=seconds;
 SegmentOverlap: 0
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]
 SaveIntermediateWavFiles: Never
+# If `true` saves a data into a seperate file every `SegmentDuration` seconds. Accepts a boolean value: [false|true]
 SaveIntermediateCsvFiles: false
 # Available options (case-sensitive): [False/Never | True/Always | WhenEventsDetected]
 SaveSonogramImages: Never