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

Updated shiftscalerotate #2250

Merged
merged 1 commit into from
Jan 7, 2025
Merged

Updated shiftscalerotate #2250

merged 1 commit into from
Jan 7, 2025

Conversation

ternaus
Copy link
Collaborator

@ternaus ternaus commented Jan 7, 2025

Summary by Sourcery

Enhancements:

  • Replace deprecated value and mask_value arguments with fill and fill_mask in ShiftScaleRotate.

Copy link
Contributor

sourcery-ai bot commented Jan 7, 2025

Reviewer's Guide by Sourcery

This pull request updates the ShiftScaleRotate transform to change the default border_mode from cv2.BORDER_REFLECT_101 to cv2.BORDER_CONSTANT. It also replaces deprecated arguments value and mask_value with fill and fill_mask, respectively. A warning is also added to suggest using the more general Affine transform instead of ShiftScaleRotate.

Class diagram showing changes to ShiftScaleRotate class

classDiagram
    class ShiftScaleRotate {
        +border_mode: int = cv2.BORDER_CONSTANT
        +fill: ColorType = 0
        +fill_mask: ColorType = 0
        -value: ColorType [removed]
        -mask_value: ColorType [removed]
        +__init__(scale_limit, rotate_limit, interpolation, border_mode, shift_limit_x, shift_limit_y, rotate_method, p)
    }
    Affine <|-- ShiftScaleRotate
    note for ShiftScaleRotate "Changed default border_mode
Removed deprecated value and mask_value
Updated warning message"
Loading

State diagram showing parameter deprecation flow

stateDiagram-v2
    [*] --> OldParameters
    OldParameters --> NewParameters
    state OldParameters {
        value --> fill
        mask_value --> fill_mask
    }
    state NewParameters {
        border_mode: BORDER_CONSTANT
        fill
        fill_mask
    }
    NewParameters --> [*]
Loading

File-Level Changes

Change Details Files
Changed default border mode
  • Changed the default border_mode argument of the ShiftScaleRotate class from cv2.BORDER_REFLECT_101 to cv2.BORDER_CONSTANT.
albumentations/augmentations/geometric/transforms.py
Replaced deprecated arguments
  • Removed deprecated value and mask_value arguments from the ShiftScaleRotate class.
  • Replaced them with fill and fill_mask arguments, respectively.
  • Added a deprecation warning for users still using the old arguments, suggesting to use the new fill and fill_mask instead.
albumentations/augmentations/geometric/transforms.py
Added warning about deprecation
  • Added a warning that suggests using the Affine transform instead of ShiftScaleRotate.
  • Changed the warning type from DeprecationWarning to UserWarning.
albumentations/augmentations/geometric/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 - here's some feedback:

Overall Comments:

  • Changing the default border_mode from BORDER_REFLECT_101 to BORDER_CONSTANT is a breaking change that could affect existing image processing pipelines. Please provide justification for this change in the PR description.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 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 Jan 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.90%. Comparing base (b1a79c2) to head (2a3f842).
Report is 356 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##           main    #2250       +/-   ##
=========================================
+ Coverage      0   89.90%   +89.90%     
=========================================
  Files         0       50       +50     
  Lines         0     9003     +9003     
=========================================
+ Hits          0     8094     +8094     
- Misses        0      909      +909     

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

@ternaus ternaus merged commit fb2e64e into main Jan 7, 2025
16 checks passed
@ternaus ternaus deleted the update_shift_scale_rotate branch January 7, 2025 19:52
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