Skip to content

Commit

Permalink
doc: Update species_config.csv comments
Browse files Browse the repository at this point in the history
  • Loading branch information
tphakala committed Aug 2, 2024
1 parent 73bfac8 commit a87fa93
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions doc/species_config.csv
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# Example configuration for species-specific confidence thresholds
# Format: species, confidence
# - Species: Localized common name or scientific name (case insensitive)
# - Confidence value: Range from 0.0 to 1.0 for species reporting.
# Values exceeding 1.0 are used to explicitly exclude species
# Species Configuration File
# Format: species,confidence[,actions]
# - Species: Common or scientific name (case insensitive)
# - Confidence: 0.0 to 1.0 for detection threshold, >1.0 to exclude
# - Actions (optional): Semicolon-separated list, e.g., ExecuteScript:/path/to/script.sh:param1
# you can provide parameters to script by separating them with : (colon)

# Exclude non-bird labels (e.g., environmental sounds, human activities)
# Exclude non-bird labels (confidence > 1.0)
Dog,2.0
Engine,2.0
Environmental,2.0
Expand All @@ -17,16 +18,19 @@ Noise,2.0
Power tools,2.0
Siren,2.0

# Higher threshold for uncommon species (which are frequently misidentified)
# Higher threshold for commonly misidentified species
common kingfisher,1.0
eurasian moorhen,1.0
common snipe,1.0

# Lower threshold for owls (due to rarity or specific interest)
# Lower threshold for species of interest (e.g., owls)
tawny owl,0.4
long-eared owl,0.4
boreal owl,0.4
great grey owl,0.4
northern hawk-owl,0.4
snowy owl,0.4
northern pygmy-owl,0.4
northern pygmy-owl,0.4

# Example with actions (uncomment and modify as needed):
# rare_species,0.3,ExecuteScript:/scripts/rare_alert.sh:CommonName:Confidence

0 comments on commit a87fa93

Please sign in to comment.