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

Update motion blur #2154

Merged
merged 3 commits into from
Nov 18, 2024
Merged

Update motion blur #2154

merged 3 commits into from
Nov 18, 2024

Conversation

ternaus
Copy link
Collaborator

@ternaus ternaus commented Nov 18, 2024

Addresses: #2101

Summary by Sourcery

Enhancements:

  • Enhance the MotionBlur transform to support directional kernels with controllable angle, direction, and position.

Copy link
Contributor

sourcery-ai bot commented Nov 18, 2024

Reviewer's Guide by Sourcery

This PR enhances the MotionBlur transform by introducing more precise control over motion blur effects. The implementation replaces the previous random line-based kernel generation with a more sophisticated directional kernel system that offers control over angle, direction, and position of the blur effect.

Updated class diagram for MotionBlur

classDiagram
    class MotionBlur {
        -int|tuple[int, int] blur_limit
        -bool allow_shifted
        -tuple[float, float] angle_range
        -tuple[float, float] direction_range
        -float p
        +apply(np.ndarray img, np.ndarray kernel, **params: Any) np.ndarray
        +get_transform_init_args_names() tuple[str, ...]
        +get_params() dict[str, Any]
    }
    class Blur {
        <<abstract>>
    }
    MotionBlur --|> Blur
    note for MotionBlur "Enhanced with angle_range and direction_range for directional blur control"
Loading

Class diagram for create_motion_kernel function

classDiagram
    class create_motion_kernel {
        +np.ndarray create_motion_kernel(int kernel_size, float angle, float direction, bool allow_shifted, Random random_state)
    }
    note for create_motion_kernel "Generates a directional motion blur kernel with angle and direction control"
Loading

File-Level Changes

Change Details Files
Implemented new motion blur kernel generation with controllable parameters
  • Added new parameters angle_range and direction_range for controlling blur orientation and bias
  • Created new create_motion_kernel function for generating directional blur kernels
  • Replaced random line generation with trigonometric-based kernel creation
  • Added support for direction bias to control blur distribution
albumentations/augmentations/blur/functional.py
albumentations/augmentations/blur/transforms.py
Enhanced documentation and examples
  • Added detailed explanations of angle and direction parameters
  • Included visual examples of different blur configurations
  • Added comprehensive references to related research and implementations
  • Updated code examples to demonstrate common use cases
albumentations/augmentations/blur/transforms.py
Added parameter validation and type annotations
  • Added validation for angle_range and direction_range parameters
  • Implemented range bound checking for direction values
  • Updated transform initialization schema with new parameters
albumentations/augmentations/blur/transforms.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ternaus - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

codecov bot commented Nov 18, 2024

Codecov Report

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

Project coverage is 90.34%. Comparing base (b1a79c2) to head (297daa0).
Report is 286 commits behind head on main.

Files with missing lines Patch % Lines
albumentations/augmentations/blur/functional.py 96.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff            @@
##           main    #2154       +/-   ##
=========================================
+ Coverage      0   90.34%   +90.34%     
=========================================
  Files         0       48       +48     
  Lines         0     8399     +8399     
=========================================
+ Hits          0     7588     +7588     
- Misses        0      811      +811     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

@ternaus ternaus merged commit 46054a2 into main Nov 18, 2024
16 checks passed
@ternaus ternaus deleted the update_motion_blur branch November 18, 2024 23:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant