search

talmolab / sleap

A deep learning framework for multi-animal pose tracking.
https://sleap.ai
Other
437 stars 97 forks source link

Add feature to maintain current frame index #1789

Closed ramizhajj1 closed 5 months ago

ramizhajj1 commented 6 months ago

Description

Includes modifications to the switch_frame function and the GoAdjacentView class in the sleap/gui/app.py file. The changes ensure that when switching videos, the application attempts to maintain the current frame index if the new video has enough frames

Types of changes

Does this address any currently open issues?

[list open issues here]

Outside contributors checklist

Thank you for contributing to SLEAP!

:heart:

coderabbitai[bot] commented 6 months ago

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes introduce significant new functionality and updates across multiple aspects of the project. Key updates include the addition of session and instance group management in the GUI, handling of OpenCV package installations, and improvements to testing and documentation. These enhancements aim to improve the user experience, streamline package management, and ensure robust testing of new features.

Changes

Files/Groups Change Summary
.conda/bld.bat, .conda/build.sh, .conda_mac/build.sh Uninstall all OpenCV packages and install opencv-contrib-python<4.7.0 using pip.
.github/workflows/ci.yml Added a step to reinstall the correct version of OpenCV; updated comment for clarity.
dev_requirements.txt Added a comment to clarify the purpose of pytest-xvfb for running tests without UI.
docs/installation.md Added a non-recommended "terrible hack" section involving conda and pip commands for development purposes.
requirements.txt Updated to include sleap-anipose and instructions for managing OpenCV packages.
sleap/gui/app.py, sleap/gui/commands.py, sleap/gui/dataviews.py, sleap/gui/dialogs/delete.py, sleap/gui/shortcuts.py, sleap/gui/widgets/docks.py, sleap/gui/widgets/video.py Added new functionality and methods related to sessions and instance groups, updated GUI state handling, and improved point update logic.
sleap/instance.py Enhanced method functionalities, logging, and class inheritance for better point and instance management.
sleap/io/dataset.py Enhanced caching and management of labeled frame data and recording sessions.
sleap/io/format/hdf5.py, sleap/io/format/labels_json.py, sleap/io/video.py Improved import handling, deserialization, and documentation.
sleap/util.py Added deep conversion of iterables and improved JSON decoding.
tests/conftest.py, tests/fixtures/cameras.py, tests/fixtures/datasets.py Added fixtures for cameras, sessions, and datasets to support new testing scenarios.
tests/gui/test_app.py, tests/gui/test_commands.py, tests/gui/test_dataviews.py, tests/gui/widgets/test_docks.py Added and updated test functions to cover new GUI and command functionalities.
tests/io/test_cameras.py, tests/io/test_dataset.py Added test functions for camera-related data structures and session manipulation within labels.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant GUI
    participant Commands
    participant DataCache
    participant Labels

    User->>GUI: Add Session
    GUI->>Commands: addSession()
    Commands->>DataCache: add_recording_session()
    DataCache->>Labels: add_session()
    Labels->>DataCache: update_cache()
    DataCache-->>GUI: Session Added

    User->>GUI: Triangulate Session
    GUI->>Commands: triangulateSession()
    Commands->>DataCache: triangulate_instances()
    DataCache-->>GUI: Triangulation Complete

Poem

In code we weave, where sessions thrive,
With OpenCV, our apps come alive.
A GUI bright, for tasks so light,
Commands and tests, all set just right.
A rabbit's joy, in code's employ,
To build and fix, with seamless ploy.
🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 6 months ago

Codecov Report

Attention: Patch coverage is 42.85714% with 4 lines in your changes missing coverage. Please review.

Project coverage is 74.10%. Comparing base (f9858ad) to head (08117b8).

:exclamation: Current head 08117b8 differs from pull request most recent head b3960ea

Please upload reports for the commit b3960ea to get more accurate results.

Files Patch % Lines
sleap/gui/app.py 42.85% 4 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## liezl/add-gui-elements-for-sessions #1789 +/- ## ======================================================================= - Coverage 74.11% 74.10% -0.01% ======================================================================= Files 135 135 Lines 25306 25309 +3 ======================================================================= Hits 18755 18755 - Misses 6551 6554 +3 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.