Class GaussianBlurProcessor

Defines Gaussian blur by a (Sigma, Radius) pair.

Inheritance

object

GaussianBlurProcessor

Implements

IImageProcessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SixLabors.ImageSharp.Processing.Processors.Convolution

Assembly: SixLabors.ImageSharp.dll

Syntax

public sealed class GaussianBlurProcessor : IImageProcessor

Constructors

GaussianBlurProcessor()

Initializes a new instance of the GaussianBlurProcessor class.

Declaration

public GaussianBlurProcessor()

GaussianBlurProcessor(int)

Initializes a new instance of the GaussianBlurProcessor class.

Declaration

public GaussianBlurProcessor(int radius)

Parameters

Type	Name	Description
int	radius	The 'radius' value representing the size of the area to sample.

GaussianBlurProcessor(float)

Initializes a new instance of the GaussianBlurProcessor class.

Declaration

public GaussianBlurProcessor(float sigma)

Parameters

Type	Name	Description
float	sigma	The 'sigma' value representing the weight of the blur.

GaussianBlurProcessor(float, BorderWrappingMode, BorderWrappingMode)

Initializes a new instance of the GaussianBlurProcessor class.

Declaration

public GaussianBlurProcessor(float sigma, BorderWrappingMode borderWrapModeX, BorderWrappingMode borderWrapModeY)

Parameters

Type	Name	Description
float	sigma	The 'sigma' value representing the weight of the blur.
BorderWrappingMode	borderWrapModeX	The BorderWrappingMode to use when mapping the pixels outside of the border, in X direction.
BorderWrappingMode	borderWrapModeY	The BorderWrappingMode to use when mapping the pixels outside of the border, in Y direction.

GaussianBlurProcessor(float, int)

Initializes a new instance of the GaussianBlurProcessor class.

Declaration

public GaussianBlurProcessor(float sigma, int radius)

Parameters

Type	Name	Description
float	sigma	The 'sigma' value representing the weight of the blur.
int	radius	The 'radius' value representing the size of the area to sample. This should be at least twice the sigma value.

GaussianBlurProcessor(float, int, BorderWrappingMode, BorderWrappingMode)

Initializes a new instance of the GaussianBlurProcessor class.

Declaration

public GaussianBlurProcessor(float sigma, int radius, BorderWrappingMode borderWrapModeX, BorderWrappingMode borderWrapModeY)

Parameters

Type	Name	Description
float	sigma	The 'sigma' value representing the weight of the blur.
int	radius	The 'radius' value representing the size of the area to sample. This should be at least twice the sigma value.
BorderWrappingMode	borderWrapModeX	The BorderWrappingMode to use when mapping the pixels outside of the border, in X direction.
BorderWrappingMode	borderWrapModeY	The BorderWrappingMode to use when mapping the pixels outside of the border, in Y direction.

Fields

DefaultSigma

The default value for Sigma.

Declaration

public const float DefaultSigma = 3

Field Value

Type	Description
float

Properties

BorderWrapModeX

Gets the BorderWrappingMode to use when mapping the pixels outside of the border, in X direction.

Declaration

public BorderWrappingMode BorderWrapModeX { get; }

Property Value

Type	Description
BorderWrappingMode

BorderWrapModeY

Gets the BorderWrappingMode to use when mapping the pixels outside of the border, in Y direction.

Declaration

public BorderWrappingMode BorderWrapModeY { get; }

Property Value

Type	Description
BorderWrappingMode

Radius

Gets the radius defining the size of the area to sample.

Declaration

public int Radius { get; }

Property Value

Type	Description
int

Sigma

Gets the sigma value representing the weight of the blur

Declaration

public float Sigma { get; }

Property Value

Type	Description
float

Methods

CreatePixelSpecificProcessor<TPixel>(Configuration, Image<TPixel>, Rectangle)

Creates a pixel specific IImageProcessor<TPixel> that is capable of executing the processing algorithm on an Image<TPixel>.

Declaration

public IImageProcessor<TPixel> CreatePixelSpecificProcessor<TPixel>(Configuration configuration, Image<TPixel> source, Rectangle sourceRectangle) where TPixel : unmanaged, IPixel<TPixel>

Parameters

Type	Name	Description
Configuration	configuration	The configuration which allows altering default behaviour or extending the library.
Image<TPixel>	source	The source image. Cannot be null.
Rectangle	sourceRectangle	The Rectangle structure that specifies the portion of the image object to draw.

Returns

Type	Description
IImageProcessor<TPixel>	The IImageProcessor<TPixel>

Type Parameters

Name	Description
TPixel	The pixel type.

Implements

IImageProcessor