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

Fix random shadow intensity #2124

Merged
merged 2 commits into from
Nov 8, 2024
Merged

Fix random shadow intensity #2124

merged 2 commits into from
Nov 8, 2024

Conversation

ternaus
Copy link
Collaborator

@ternaus ternaus commented Nov 8, 2024

Fixes: #2070

Summary by Sourcery

Bug Fixes:

  • Correct the calculation of shadow intensity in the RandomShadow transformation by adjusting the formula to use darkness instead of shadow intensity directly.

Copy link
Contributor

sourcery-ai bot commented Nov 8, 2024

Reviewer's Guide by Sourcery

This PR fixes the shadow intensity calculation in the RandomShadow augmentation by inverting the intensity value to properly darken the image. It also improves documentation by clarifying the relationship between shadow intensity values and shadow darkness.

Sequence diagram for add_shadow function

sequenceDiagram
    participant img as Image
    participant vertices_list as VerticesList
    participant intensities as Intensities
    participant mask as Mask
    participant img_shadowed as ImageShadowed

    img->>add_shadow: Call function
    add_shadow->>mask: Calculate shadowed_indices
    add_shadow->>add_shadow: Calculate darkness = 1 - shadow_intensity
    add_shadow->>img_shadowed: Apply darkness to shadowed_indices
    img_shadowed-->>img: Return modified image
Loading

Updated class diagram for RandomShadow

classDiagram
    class RandomShadow {
        - num_shadows_limit: tuple[int, int] = (1, 2)
        - shadow_dimension: int = 5
        - shadow_intensity_range: tuple[float, float] = (0.5, 0.5)
        - p: float = 0.5
    }
    note for RandomShadow "shadow_intensity_range description updated to clarify its effect on shadow darkness."
Loading

File-Level Changes

Change Details Files
Fix shadow intensity calculation logic
  • Invert shadow intensity value by using (1 - shadow_intensity) to properly darken the image
  • Update documentation to clarify that larger intensity values result in darker shadows
albumentations/augmentations/transforms.py
albumentations/augmentations/functional.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: 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 Nov 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.25%. Comparing base (b1a79c2) to head (93b169a).
Report is 258 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##           main    #2124       +/-   ##
=========================================
+ Coverage      0   90.25%   +90.25%     
=========================================
  Files         0       47       +47     
  Lines         0     7749     +7749     
=========================================
+ Hits          0     6994     +6994     
- Misses        0      755      +755     

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

@ternaus ternaus merged commit 802981d into main Nov 8, 2024
16 checks passed
@ternaus ternaus deleted the fix_random_shadow_intensity branch November 8, 2024 23:50
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.

[Bug] RandomShadow + shadow_intensity
1 participant