ImageSharp/src/ImageSharp/Processing/Extensions/Convolution/GaussianSharpenExtensions.cs

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

using SixLabors.ImageSharp.Processing.Processors.Convolution;

namespace SixLabors.ImageSharp.Processing;

/// <summary>
/// Defines Gaussian sharpening extensions to apply on an <see cref="Image"/>
/// using Mutate/Clone.
/// </summary>
public static class GaussianSharpenExtensions
{
    /// <summary>
    /// Applies a Gaussian sharpening filter to the image.
    /// </summary>
    /// <param name="source">The current image processing context.</param>
    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
    public static IImageProcessingContext GaussianSharpen(this IImageProcessingContext source) =>
        source.ApplyProcessor(new GaussianSharpenProcessor());

    /// <summary>
    /// Applies a Gaussian sharpening filter to the image.
    /// </summary>
    /// <param name="source">The current image processing context.</param>
    /// <param name="sigma">The 'sigma' value representing the weight of the blur.</param>
    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
    public static IImageProcessingContext GaussianSharpen(this IImageProcessingContext source, float sigma) =>
        source.ApplyProcessor(new GaussianSharpenProcessor(sigma));

    /// <summary>
    /// Applies a Gaussian sharpening filter to the image.
    /// </summary>
    /// <param name="source">The current image processing context.</param>
    /// <param name="sigma">The 'sigma' value representing the weight of the blur.</param>
    /// <param name="rectangle">
    /// The <see cref="Rectangle"/> structure that specifies the portion of the image object to alter.
    /// </param>
    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
    public static IImageProcessingContext GaussianSharpen(
        this IImageProcessingContext source,
        float sigma,
        Rectangle rectangle) =>
        source.ApplyProcessor(new GaussianSharpenProcessor(sigma), rectangle);

    /// <summary>
    /// Applies a Gaussian sharpening filter to the image.
    /// </summary>
    /// <param name="source">The current image processing context.</param>
    /// <param name="sigma">The 'sigma' value representing the weight of the blur.</param>
    /// <param name="rectangle">
    /// The <see cref="Rectangle"/> structure that specifies the portion of the image object to alter.
    /// </param>
    /// <param name="borderWrapModeX">
    /// The <see cref="BorderWrappingMode"/> to use when mapping the pixels outside of the border, in X direction.
    /// </param>
    /// <param name="borderWrapModeY">
    /// The <see cref="BorderWrappingMode"/> to use when mapping the pixels outside of the border, in Y direction.
    /// </param>
    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
    public static IImageProcessingContext GaussianSharpen(this IImageProcessingContext source, float sigma, Rectangle rectangle, BorderWrappingMode borderWrapModeX, BorderWrappingMode borderWrapModeY)
    {
        var processor = new GaussianSharpenProcessor(sigma, borderWrapModeX, borderWrapModeY);
        return source.ApplyProcessor(processor, rectangle);
    }
}