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 audio loader docstrings

Browse Source
This commit is contained in:
mbsantiago 2026-03-08 17:02:35 +00:00
parent ce952e364b
commit bfc88a4a0f
1 changed files with 24 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
src/batdetect2/typing/preprocess.py
View File

@ -74,9 +74,9 @@ class AudioLoader(Protocol):
Returns
-------
xr.DataArray
The loaded and preprocessed audio waveform. Typically loads only
the first channel.
np.ndarray
The loaded and preprocessed audio waveform as a 1-D NumPy
array. Typically loads only the first channel.
Raises
------
@ -105,9 +105,10 @@ class AudioLoader(Protocol):
Returns
-------
xr.DataArray
The loaded and preprocessed audio waveform for the specified clip
duration. Typically loads only the first channel.
np.ndarray
The loaded and preprocessed audio waveform for the specified
clip duration as a 1-D NumPy array. Typically loads only the
first channel.
Raises
------
@ -147,4 +148,21 @@ class PreprocessorProtocol(Protocol):
def process_spectrogram(self, spec: torch.Tensor) -> torch.Tensor: ...
def process_numpy(self, wav: np.ndarray) -> np.ndarray:
"""Run the full preprocessing pipeline on a NumPy waveform.
This default implementation converts the array to a
``torch.Tensor``, calls :meth:`__call__`, and converts the
result back to a NumPy array. Concrete implementations may
override this for efficiency.
Parameters
----------
wav : np.ndarray
Input waveform as a 1-D NumPy array.
Returns
-------
np.ndarray
Preprocessed spectrogram as a NumPy array.
"""
return self(torch.tensor(wav)).numpy()