Updated GaussNoise

[ternaus]

Summary by Sourcery

Refactor the GaussNoise, Solarize, and Equalize augmentations to use standard deviation instead of variance, and to normalize parameters to the range [0, 1]. Additionally, deprecate legacy parameters in favor of more consistent alternatives.

Enhancements:

• Replace variance-based noise generation with standard deviation-based noise generation in GaussNoise.
• Normalize parameters to the range [0, 1] for Solarize and GaussNoise.
• Deprecate legacy parameters var_limit and mean in GaussNoise, and threshold in Solarize.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request refactors the GaussNoise, Solarize, and Equalize transforms to use more descriptive parameter names and removes deprecated parameters. It also updates the type hints for the mode parameter in Equalize and removes the unused ImageMode import.

Class diagram showing changes to GaussNoise, Solarize, and Equalize transforms

classDiagram
    class GaussNoise {
        -std_range: tuple[float, float]
        -mean_range: tuple[float, float]
        -per_channel: bool
        -noise_scale_factor: float
        +apply(img: ndarray)
        +get_params_dependent_on_data()
    }
    note for GaussNoise "Removed deprecated var_limit and mean parameters"

    class Solarize {
        +threshold_range: tuple[float, float]
        +normalize_threshold(threshold, threshold_range)
    }
    note for Solarize "Added threshold normalization"

    class Equalize {
        +mode: Literal[cv, pil]
        +by_channels: bool
        +mask: ndarray|Callable
        +mask_params: Sequence[str]
    }
    note for Equalize "Updated mode type from ImageMode to Literal"

Loading

File-Level Changes

Change	Details	Files
Refactored GaussNoise to use std_range and mean_range parameters, removing deprecated var_limit and mean parameters.	Replaced var_limit with std_range for specifying the standard deviation range of the Gaussian noise. Replaced mean with mean_range for specifying the mean range of the Gaussian noise. Removed deprecated parameters and updated the implementation accordingly. Updated the InitSchema to use the new parameters and remove the deprecated ones. Updated the apply and get_params_dependent_on_data methods to use the new parameters. Updated tests to reflect the parameter changes	albumentations/augmentations/transforms.py albumentations/augmentations/functional.py
Refactored Solarize to use threshold_range parameter, removing deprecated threshold parameter.	Replaced threshold with threshold_range for specifying the solarization threshold range. Added a normalization step to convert legacy threshold values to the new range. Removed deprecated parameter and updated the implementation accordingly. Updated the InitSchema to use the new parameter and remove the deprecated one. Updated tests to reflect the parameter changes	albumentations/augmentations/transforms.py
Updated Equalize transform and removed unused import.	Changed the type hint of the mode parameter from ImageMode to Literal['cv', 'pil']. Removed the unused ImageMode import from `albumentations/core/types.py	albumentations/augmentations/transforms.py albumentations/augmentations/functional.py albumentations/core/types.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: 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 ✨

• 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 89.88%. Comparing base (b1a79c2) to head (42a40f0).
Report is 369 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##           main    #2263       +/-   ##
=========================================
+ Coverage      0   89.88%   +89.88%     
=========================================
  Files         0       50       +50     
  Lines         0     8855     +8855     
=========================================
+ Hits          0     7959     +7959     
- Misses        0      896      +896     

Flag	Coverage Δ
ubuntu-py3.12	89.88% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

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