Add audiomoth GPS sync tools and refactor localization into modules #1064
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
module was bloated, now have folder with __init__ that imports the public-facing API classes/functions, and separate modules for localization_algorithms.py, spatial_event.py, synchronized_recorder_array.py refactored top-level imports and tests accordingly
resolves Audio.trim with datetime #926 adds tests for various behaviors
needs tests where should example script go? bioacoustics cookbook or tutorials? I've added an example script to tutorials
this is now the type returned by SpatialEvent.estimate_location, instead of modifying itself in place and returning itself resolves Some attributes of SpatialEvent are vague #932 updates tutorial and tests
renames some variables, adds docstrings to variables, adds comments, and adds thorough documentation to docstrings
was using list(set(files)) which can result in changing order of files, noticed because tests sometimes failed when assuming order of label df rows was retained
creates a `localize_events_parallel` function and moves most of the input validation in localize_detections to create_candidate_events() where it makes sense for it to be. Now, localize_detections() just wraps create_candidate_events() with localize_events_parallel() and filters the returned events into localized and unlocalized lists. resolves SynchronizedRecorderArray API should allow localizing a list of already-created events #1041 instead of adding a method to SynchronizedRecorderArray, it made more sense to add a function to the spatial_event module: this function is not dependent on anything within the SynchronizedRecorderArray object, it works directly on a list of SpatialEvent objects
resolves add tools for reviewing localized SpatialEvents #981 the full review process should be provided in a notebook, but this may be the only functionality we want to include within opso for now: loads audio clips used to localize a PositionEstimate with offsets based on tdoa, such that the signal should align in time if tdoas are correct. Provides example for visualizing, and test.
resolves add tools for reviewing localized SpatialEvents #981
had only changed one occurrence of list(set(files)), not both, on previous commit throughout code, use unique() function that retains order instead of list(set(x))
This was
linked to
issues
Oct 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Separated localization module into folder with submodules because it was becoming bloated
resolves #914 by adding sync tools (Audiomoth GPS firmware only for now)