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.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: SixLabors.ImageSharp.Processing.Processors.Convolution

Assembly: SixLabors.ImageSharp.dll

Syntax

public sealed class GaussianBlurProcessor : IImageProcessor

Constructors

| Improve this Doc View Source

GaussianBlurProcessor()

Initializes a new instance of the GaussianBlurProcessor class.

Declaration

public GaussianBlurProcessor()

| Improve this Doc View Source

GaussianBlurProcessor(Int32)

Initializes a new instance of the GaussianBlurProcessor class.

Declaration

public GaussianBlurProcessor(int radius)

Parameters

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

| Improve this Doc View Source

GaussianBlurProcessor(Single)

Initializes a new instance of the GaussianBlurProcessor class.

Declaration

public GaussianBlurProcessor(float sigma)

Parameters

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

| Improve this Doc View Source

GaussianBlurProcessor(Single, Int32)

Initializes a new instance of the GaussianBlurProcessor class.

Declaration

public GaussianBlurProcessor(float sigma, int radius)

Parameters

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

Fields

| Improve this Doc View Source

DefaultSigma

The default value for Sigma.

Declaration

public const float DefaultSigma = 3F

Field Value

Type	Description
Single

Properties

| Improve this Doc View Source

Radius

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

Declaration

public int Radius { get; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

Sigma

Gets the sigma value representing the weight of the blur

Declaration

public float Sigma { get; }

Property Value

Type	Description
Single

Methods

| Improve this Doc View Source

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 : struct, 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