Add plasmashadow

[ternaus]

Adresses: #2105

Summary by Sourcery

Add the PlasmaShadow transformation to apply organic-looking shadow effects using plasma fractal noise patterns, update documentation, and include tests for the new feature.

New Features:

• Introduce the PlasmaShadow transformation, which applies a plasma-based shadow effect to images, creating organic-looking shadows using a fractal noise pattern.

Enhancements:

• Refactor the order of parameters in the constructor of several transformations to ensure consistency.

Documentation:

• Add documentation for the new PlasmaShadow transformation in the README file, including a link to its detailed description.

Tests:

• Add a test case for the new PlasmaShadow transformation in the augmentation definitions test suite.

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR introduces a new image augmentation transform called PlasmaShadow that creates organic-looking shadows using plasma fractal noise patterns. The implementation follows the existing pattern of other transforms in the codebase and includes comprehensive documentation, parameter validation, and integration with the existing augmentation framework.

Sequence diagram for applying PlasmaShadow

sequenceDiagram
    participant User
    participant PlasmaShadow
    participant fmain
    User->>PlasmaShadow: Call apply(img, intensity, plasma_pattern)
    PlasmaShadow->>fmain: Call apply_plasma_shadow(img, intensity, plasma_pattern)
    fmain-->>PlasmaShadow: Return shadowed image
    PlasmaShadow-->>User: Return shadowed image

Loading

Class diagram for the new PlasmaShadow transform

classDiagram
    class PlasmaShadow {
        +tuple[float, float] shadow_intensity
        +int plasma_size
        +float roughness
        +float p
        +bool|None always_apply
        +get_params_dependent_on_data(params: dict[str, Any], data: dict[str, Any]) dict[str, Any]
        +apply(img: np.ndarray, intensity: float, plasma_pattern: np.ndarray, **params: Any) np.ndarray
        +get_transform_init_args_names() tuple[str, ...]
    }
    PlasmaShadow --|> ImageOnlyTransform
    class ImageOnlyTransform {
        <<abstract>>
    }

Loading

File-Level Changes

Change	Details	Files
Added new PlasmaShadow transform class for creating organic shadow effects	Implemented PlasmaShadow class with configurable shadow intensity, plasma size, and roughness parameters Added parameter validation using InitSchema Created apply_plasma_shadow function for the actual shadow effect implementation Added comprehensive docstring with mathematical formulation and usage examples	albumentations/augmentations/transforms.py
Added functional implementation for plasma shadow effect	Implemented apply_plasma_shadow function with clipping decorator Added shadow mask calculation using plasma pattern	albumentations/augmentations/functional.py
Standardized parameter ordering in transform classes	Reordered p and always_apply parameters to maintain consistency across transforms Fixed parameter order in super() calls	albumentations/augmentations/transforms.py
Updated documentation and tests	Added PlasmaShadow to the list of available transforms in README.md Added PlasmaShadow to the test definitions	README.md tests/aug_definitions.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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

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: 1 issue found
• 🟡 Complexity: 1 issue found
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.33%. Comparing base (b1a79c2) to head (ee6b6ed).
Report is 285 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##           main    #2153       +/-   ##
=========================================
+ Coverage      0   90.33%   +90.33%     
=========================================
  Files         0       48       +48     
  Lines         0     8391     +8391     
=========================================
+ Hits          0     7580     +7580     
- Misses        0      811      +811     

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