AdaptiveThresholdExtensions.cs

// Copyright (c) Six Labors.
// Licensed under the Six Labors Split License.

using SixLabors.ImageSharp.Processing.Processors.Binarization;

namespace SixLabors.ImageSharp.Processing;

/// <summary>
/// Extensions to perform AdaptiveThreshold through Mutator.
/// </summary>
public static class AdaptiveThresholdExtensions
{
    /// <summary>
    /// Applies Bradley Adaptive Threshold to the image.
    /// </summary>
    /// <param name="source">The current image processing context.</param>
    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
    public static IImageProcessingContext AdaptiveThreshold(this IImageProcessingContext source)
        => source.ApplyProcessor(new AdaptiveThresholdProcessor());

    /// <summary>
    /// Applies Bradley Adaptive Threshold to the image.
    /// </summary>
    /// <param name="source">The current image processing context.</param>
    /// <param name="thresholdLimit">Threshold limit (0.0-1.0) to consider for binarization.</param>
    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
    public static IImageProcessingContext AdaptiveThreshold(this IImageProcessingContext source, float thresholdLimit)
        => source.ApplyProcessor(new AdaptiveThresholdProcessor(thresholdLimit));

    /// <summary>
    /// Applies Bradley Adaptive Threshold to the image.
    /// </summary>
    /// <param name="source">The current image processing context.</param>
    /// <param name="upper">Upper (white) color for thresholding.</param>
    /// <param name="lower">Lower (black) color for thresholding.</param>
    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
    public static IImageProcessingContext AdaptiveThreshold(this IImageProcessingContext source, Color upper, Color lower)
        => source.ApplyProcessor(new AdaptiveThresholdProcessor(upper, lower));

    /// <summary>
    /// Applies Bradley Adaptive Threshold to the image.
    /// </summary>
    /// <param name="source">The current image processing context.</param>
    /// <param name="upper">Upper (white) color for thresholding.</param>
    /// <param name="lower">Lower (black) color for thresholding.</param>
    /// <param name="thresholdLimit">Threshold limit (0.0-1.0) to consider for binarization.</param>
    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
    public static IImageProcessingContext AdaptiveThreshold(this IImageProcessingContext source, Color upper, Color lower, float thresholdLimit)
        => source.ApplyProcessor(new AdaptiveThresholdProcessor(upper, lower, thresholdLimit));

    /// <summary>
    /// Applies Bradley Adaptive Threshold to the image.
    /// </summary>
    /// <param name="source">The current image processing context.</param>
    /// <param name="upper">Upper (white) color for thresholding.</param>
    /// <param name="lower">Lower (black) color for thresholding.</param>
    /// <param name="rectangle">Rectangle region to apply the processor on.</param>
    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
    public static IImageProcessingContext AdaptiveThreshold(this IImageProcessingContext source, Color upper, Color lower, Rectangle rectangle)
        => source.ApplyProcessor(new AdaptiveThresholdProcessor(upper, lower), rectangle);

    /// <summary>
    /// Applies Bradley Adaptive Threshold to the image.
    /// </summary>
    /// <param name="source">The current image processing context.</param>
    /// <param name="upper">Upper (white) color for thresholding.</param>
    /// <param name="lower">Lower (black) color for thresholding.</param>
    /// <param name="thresholdLimit">Threshold limit (0.0-1.0) to consider for binarization.</param>
    /// <param name="rectangle">Rectangle region to apply the processor on.</param>
    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
    public static IImageProcessingContext AdaptiveThreshold(this IImageProcessingContext source, Color upper, Color lower, float thresholdLimit, Rectangle rectangle)
        => source.ApplyProcessor(new AdaptiveThresholdProcessor(upper, lower, thresholdLimit), rectangle);
}