Generate suggestions using max point displacement threshold

gqcpm commented 2 months ago

Description

Created 2 new functions that should resolve the feature request #1761: function max_point_displacement, _max_point_displacement_video.
Added to yaml file to include max_point_displacement.
Create test for new function . . . will need to edit

Types of changes

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

Does this address any currently open issues?

1761

Thank you for contributing to SLEAP!

:heart:

Summary by CodeRabbit

New Features
- Introduced a new configuration option for max point displacement to help users detect frames with significant point movement.
- Enhanced functionality for analyzing point displacement in video frames, allowing users to set a maximum displacement threshold.
Tests
- Added a new test for the max point displacement feature to ensure its accuracy and reliability.

coderabbitai[bot] commented 2 months ago

Walkthrough

The latest update enhances the SLEAP application by introducing functionality to detect significant point displacement in video frames. This includes new configuration options, methods for analyzing displacements, and tests to ensure reliability, all aimed at improving the user experience and analytical capabilities of the application.

Changes

File	Summary
sleap/config/suggestions.yaml	Added `max point displacement` configuration in `main` options, defining a new threshold parameter.
sleap/gui/suggestions.py	Introduced `max_point_displacement` method in `Suggestions` class to analyze video frame displacements.
tests/gui/test_suggestions.py	Added `test_max_point_displacement_suggestions` to validate the functionality of the new displacement feature.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SLEAP_Config
    participant Suggestions
    participant TestSuite

    User->>SLEAP_Config: Update suggestions.yaml
    SLEAP_Config->>Suggestions: Read max point displacement config
    User->>Suggestions: Request frame suggestions with displacement threshold
    Suggestions->>Suggestions: Process max point displacement
    Suggestions->>User: Return list of suggested frames
    TestSuite->>Suggestions: Run tests for max point displacement
    Suggestions->>TestSuite: Return test results

Poem

In fields of code, we hop and play,
With points that shift, we find our way.
Configs and tests, a joyful spree,
SLEAP now tracks with glee, you’ll see!
So let’s leap high, and never cease,
In every frame, we find our peace. 🌟🐇

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 Configuration 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 2 months ago

Codecov Report

Attention: Patch coverage is 94.73684% with 1 line in your changes missing coverage. Please review.

Project coverage is 74.34%. Comparing base (7ed1229) to head (b0c47af). Report is 23 commits behind head on develop.

Files	Patch %	Lines
sleap/gui/suggestions.py	94.73%	1 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## develop #1862 +/- ## =========================================== + Coverage 73.30% 74.34% +1.03% =========================================== Files 134 135 +1 Lines 24087 24724 +637 =========================================== + Hits 17658 18382 +724 + Misses 6429 6342 -87 ```

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

talmolab / sleap