search

talmolab / sleap

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

Updated trail length viewing options #1822

Closed keyaloding closed 3 months ago

keyaloding commented 3 months ago

Description

Right now, the maximum trail length that the GUI displays to the user is 250 frames. I updated the GUI and sleap/prefs.py so that the user can select a custom trail length by modifying prefences.yaml. The trail length is now stored as an attribute of MainWindow. The custom length now appears in the GUI. I have tested this with various trail lengths, including trail lengths longer than the number of frames in the video and I have not experienced any issues. I also updated the GUI documentation so that the user is aware of this feature.

Types of changes

Does this address any currently open issues?

Outside contributors checklist

Thank you for contributing to SLEAP!

:heart:

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

This update focuses on enhancing the trail length options in the SLEAP application. It introduces customizable trail lengths based on user preferences, updates the Track class to accommodate new length options, adjusts the GUI documentation to reflect these changes, and ensures that the trail length is consistently managed in the app and preferences files.

Changes

File(s) Change Summary
sleap/gui/overlays/tracks.py Expanded Track.get_length_options to include user-defined trail length preferences and additional lengths
docs/guides/gui.md Updated documentation to describe new trail length options and caution about potential lag
sleap/gui/app.py Modified __init__, closeEvent, and _load_overlays methods to handle the new trail_length parameter
sleap/prefs.py Enhanced load_ method to set default trail length preference if not present

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Preferences
    participant App
    participant Track

    User->>Preferences: Set custom trail length in preferences.yaml
    Preferences-->>App: Load preferences with custom trail length
    App->>Track: Initialize with new trail length options
    Track-->>App: Provide trail length options including custom length
    App->>User: Display updated trail length options in GUI

Poem

In trails of code, the changes bloom,
Lengths extended, no more gloom.
Preferences set, the trail is seen,
A custom path, a coder's dream.
The GUI sings, with options bright,
New lengths to track, a joyous sight.
🎨🐇 In trails we trust, our paths alight! 🌟

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 3 months ago

Codecov Report

Attention: Patch coverage is 66.66667% with 2 lines in your changes missing coverage. Please review.

Project coverage is 74.15%. Comparing base (7ed1229) to head (91e38f1). Report is 17 commits behind head on develop.

Files Patch % Lines
sleap/gui/overlays/tracks.py 66.66% 1 Missing :warning:
sleap/prefs.py 0.00% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #1822 +/- ## =========================================== + Coverage 73.30% 74.15% +0.85% =========================================== Files 134 135 +1 Lines 24087 24562 +475 =========================================== + Hits 17658 18215 +557 + Misses 6429 6347 -82 ```

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