(4c -> 4) Add color by `InstanceGroup` option

[7174Andy]

Description

We already have the option to add colors by instances present in the video frame. However, it would be more comfortable to have another option to add colors by instance groups. A toggle option named "Color by Instance Group" is added under "View" in SLEAP. When selected, each instance will be colored by its respective instance group.

• [x] Add attributes (session: RecordingSession and frame_indx: int) that contain the instance groups that we want to color
• [x] Implement get_instance_group_color similar to get_track_color under color.py
• [x] Modify get_item_color so that the function can determine the color of the instance group item.
• [ ] Add a new toggle menu for coloring by instance groups
• [ ] Connect the newly added toggle menu to the ColorManager class so that it can color the instance by instance group

Types of changes

• [ ] Bugfix
• [x] New feature
• [ ] Refactor / Code style update (no logical changes)
• [ ] Build / CI changes
• [ ] Documentation Update
• [ ] Other (explain)

Outside contributors checklist

• [x] Review the guidelines for contributing to this repository
• [x] Read and sign the CLA and add yourself to the authors list
• [x] Make sure you are making a pull request against the develop branch (not main). Also you should start your branch off develop
• [x] Add tests that prove your fix is effective or that your feature works
• [x] Add necessary documentation (if appropriate)

Thank you for contributing to SLEAP!

:heart:

[coderabbitai[bot]]

[!WARNING]

Rate Limit Exceeded

@roomrys has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 29 minutes and 45 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 1a8da95e25286f2739dc4da03f9be8a727bcb1b5 and 93e38f2229c2ebff9139951c5b07cc726c5d66ea.

Walkthrough

The recent updates introduce the handling of instance groups in the SLEAP application, enhancing color management and removing redundant commands related to instance groups. The ColorManager now supports instance group colors, and the GUI has been updated to reflect these changes. Additionally, several test functions and commands related to instance groups have been removed, streamlining the codebase.

Changes

Files	Change Summary
sleap/gui/app.py	Added "instance_groups" to distinctly_color_options for color management.
sleap/gui/color.py	Updated ColorManager to handle instance group colors and included RecordingSession and frame index.
sleap/gui/commands.py	Removed methods and classes related to instance groups.
sleap/io/cameras.py	Modified methods for handling instances and instance groups, including parameter adjustments.
tests/gui/test_color.py	Added test for instance group colors in ColorManager.
tests/gui/test_commands.py	Removed tests for setting and adding instance groups.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant GUI
    participant ColorManager
    participant RecordingSession

    User->>GUI: Select "instance_groups" color option
    GUI->>ColorManager: Request color for instance group
    ColorManager->>RecordingSession: Fetch instance group data
    RecordingSession-->>ColorManager: Return instance group data
    ColorManager-->>GUI: Provide color for instance group
    GUI-->>User: Display colored instance groups

Poem

In the code where colors bloom,
Instance groups now find their room.
Commands trimmed, a cleaner slate,
Colors dance, no longer late.
Tests refined, a brighter hue,
SLEAP evolves, fresh and new.
🌈🐇

---

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
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov[bot]]

Codecov Report

Attention: Patch coverage is 55.55556% with 8 lines in your changes are missing coverage. Please review.

Project coverage is 74.14%. Comparing base (45eeea7) to head (1a8da95).

:exclamation: Current head 1a8da95 differs from pull request most recent head 93e38f2

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

Files	Patch %	Lines
sleap/gui/color.py	52.94%	8 Missing :warning:

Additional details and impacted files

@@                           Coverage Diff                           @@
##           liezl/add-gui-elements-for-sessions    #1760      +/-   ##
=======================================================================
- Coverage                                74.16%   74.14%   -0.02%     
=======================================================================
  Files                                      135      135              
  Lines                                    25185    25201      +16     
=======================================================================
+ Hits                                     18678    18686       +8     
- Misses                                    6507     6515       +8     

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