Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(4a -> 4) Add visual indicator for current camera #1783

Conversation

justinvshen
Copy link
Collaborator

Description

Add an indication for which Camcorder is linked to the Video that the user is currently viewing a frame for.

Types of changes

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

Does this address any currently open issues?

[list open issues here]

Outside contributors checklist

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

Thank you for contributing to SLEAP!

❤️

Copy link

coderabbitai bot commented May 24, 2024

Warning

Review failed

The pull request is closed.


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
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.

@roomrys roomrys added the MultiView Stack This PR is part of the MultView stacked PRs. label May 24, 2024
@roomrys roomrys changed the title Add visual indicator for current camera (4a -> 4) Add visual indicator for current camera May 24, 2024
@roomrys
Copy link
Collaborator

roomrys commented May 29, 2024

Awesome! Works as expected.

image
image

Copy link
Collaborator

@roomrys roomrys left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! Works as expected, just a request on the formatting. Also, run black to lint/format any python files you've touched (ideally before pushing):

black sleap/gui/app.py

. Otherwise, the Lint test will fail.

You can also set your VSCode up to run black for you each time you save a file.

image
image

sleap/gui/app.py Outdated
@@ -1391,6 +1391,10 @@ def updateStatusMessage(self, message: Optional[str] = None):
else:
self.statusBar().setStyleSheet("color: black")

# TODO(JS): Add Camera indicator test here
if self.state["session"] is not None and current_video is not None:
message += f'{spacer}Camera: {self.state["session"].get_camera(video=self.state["video"])}'
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't really want to rely on the Camcorder.__repr__ here. Can we instead print just the Camcorder.name?

Suggested change
message += f'{spacer}Camera: {self.state["session"].get_camera(video=self.state["video"])}'
camera = self.state["session"].get_camera(video=self.state["video"])
if camera is not None:
message += f'{spacer}Camera: {camera.name}'

sleap/gui/app.py Outdated
@@ -1391,6 +1391,10 @@ def updateStatusMessage(self, message: Optional[str] = None):
else:
self.statusBar().setStyleSheet("color: black")

# TODO(JS): Add Camera indicator test here
Copy link
Collaborator

@roomrys roomrys May 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We normally add tests in the tests folder, but for this particular PR (since it is extremely visual/GUI-based) I would just manually test it by using the GUI with

sleap-label tests\data\cameras\minimal_session\min_session_frame_groups.slp

and then clicking through the Videos to see that the statusBar is updated accordingly.

Suggested change
# TODO(JS): Add Camera indicator test here

@roomrys roomrys marked this pull request as ready for review May 30, 2024 21:20
Copy link
Collaborator

@roomrys roomrys left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@roomrys roomrys merged commit 52962a0 into talmolab:liezl/add-gui-elements-for-sessions May 30, 2024
3 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
MultiView Stack This PR is part of the MultView stacked PRs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants