lionel/batdetect2
1
0
Fork 0
mirror of https://github.com/macaodha/batdetect2.git synced 2026-04-04 15:20:19 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update docs on roi separation

Browse Source
This commit is contained in:
mbsantiago 2026-03-29 13:11:49 +01:00
parent 2b235e28bb
commit 591d4f4ae8
2 changed files with 23 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/source/how_to/configure-roi-mapping.md
View File

@ -9,10 +9,11 @@ The default mapper is `anchor_bbox`.
```yaml ```yaml
roi: roi:
name: anchor_bbox default:
anchor: bottom-left name: anchor_bbox
time_scale: 1000.0 anchor: bottom-left
frequency_scale: 0.001163 time_scale: 1000.0
frequency_scale: 0.001163
``` ```
## 2) Choose an anchor strategy ## 2) Choose an anchor strategy
@ -32,15 +33,17 @@ comparing experiments.
## 4) (Optional) override ROI mapping for specific classes ## 4) (Optional) override ROI mapping for specific classes
You can set class-level `roi` in `classification_targets` when needed. Add class-specific mappers under `roi.overrides`.
```yaml ```yaml
classification_targets: roi:
- name: species_x default:
tags: name: anchor_bbox
- key: class anchor: bottom-left
value: Species X time_scale: 1000.0
roi: frequency_scale: 0.001163
overrides:
species_x:
name: anchor_bbox name: anchor_bbox
anchor: center anchor: center
time_scale: 1000.0 time_scale: 1000.0

12
docs/source/reference/targets-config-workflow.md
View File

@ -11,7 +11,8 @@ Fields:
- `detection_target`: one `TargetClassConfig` defining detection eligibility. - `detection_target`: one `TargetClassConfig` defining detection eligibility.
- `classification_targets`: list of `TargetClassConfig` entries for class - `classification_targets`: list of `TargetClassConfig` entries for class
encoding/decoding. encoding/decoding.
- `roi`: default ROI mapper config. - `roi`: ROI mapping config with `default` mapper and optional per-class
`overrides`.
## `TargetClassConfig` ## `TargetClassConfig`
@ -23,7 +24,6 @@ Fields:
- `tags`: tag list used for matching (shortcut for `match_if`). - `tags`: tag list used for matching (shortcut for `match_if`).
- `match_if`: explicit condition config (`match_if` is accepted as alias). - `match_if`: explicit condition config (`match_if` is accepted as alias).
- `assign_tags`: tags used when decoding this class. - `assign_tags`: tags used when decoding this class.
- `roi`: optional class-specific ROI mapper override.
`tags` and `match_if` are mutually exclusive. `tags` and `match_if` are mutually exclusive.
@ -42,7 +42,8 @@ Built from `batdetect2.data.conditions`.
## ROI mapper config ## ROI mapper config
`roi` supports built-in mappers including: `roi.default` and each `roi.overrides.<class_name>` entry support built-in
mappers including:
- `anchor_bbox` - `anchor_bbox`
- `peak_energy_bbox` - `peak_energy_bbox`
@ -53,6 +54,11 @@ Key `anchor_bbox` fields:
- `time_scale` - `time_scale`
- `frequency_scale` - `frequency_scale`
Top-level ROI mapping shape:
- `default`: fallback mapper used for all classes.
- `overrides`: optional mapping from class name to mapper config.
## Related pages ## Related pages
- Detection target setup: {doc}`../how_to/configure-target-definitions` - Detection target setup: {doc}`../how_to/configure-target-definitions`