[DRAFT] Annotation

[Gautzilla]

🖼️ Annotation results are coming to OSEkit!

How does it work

The idea is to be able to load APLOSE results csv into OSEkit as a collection of new Annotation objects:

annotations = Annotation.from_csv(Path("aplose_results.csv"))

The annotations could then be filtered thanks to their properties :

verified_annotations = [
    a for a in annotations if all(v.is_validated for v in a.verifications)
]

Using the Annotation with OSEkit

The Annotation class inherits from the Event class: its begin and end properties can be used to access the audio corresponding to the annotation box easily, e.g.:

from osekit.core.audio_data import AudioData
from osekit.core.audio_dataset import AudioDataset
from osekit.core.audio_file import AudioFile

afs = [AudioFile(...)] # Or even project.origin_files with the Public API

annotation_audio_dataset = AudioDataset(
    [
        AudioData.from_files(
            files=afs,
            begin=annotation.begin,
            end=annotation.end,
        )
        for annotation in annotations
    ]
)

# Then you could e.g. plot each spectrogram with SpectroDataset.from_audio_dataset

[coveralls]

coverage: 98.991% (+0.04%) from 98.955% — Gautzilla:annotation into Project-OSmOSE:main

[ElodieENSTA]

The column names hasn't change on APLOSE side

[Gautzilla]

damn good catch, I didn't see that my refactor affected also the dict keys!

I really should write an integration test before messing with everything 🥸