|
GaussianBlur Class |
Gaussian blur filter.
Inheritance HierarchySystemObject
Accord.Imaging.FiltersBaseUsingCopyPartialFilter
Accord.Imaging.FiltersConvolution
Accord.Imaging.FiltersGaussianBlur
Accord.Imaging.FiltersBaseUsingCopyPartialFilter
Accord.Imaging.FiltersConvolution
Accord.Imaging.FiltersGaussianBlur
Namespace: Accord.Imaging.Filters
Assembly: Accord.Imaging (in Accord.Imaging.dll) Version: 3.8.0
SyntaxThe GaussianBlur type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | GaussianBlur |
Initializes a new instance of the GaussianBlur class.
|
| GaussianBlur(Double) |
Initializes a new instance of the GaussianBlur class.
|
| GaussianBlur(Double, Int32) |
Initializes a new instance of the GaussianBlur class.
|
Properties| Name | Description | |
|---|---|---|
 | Divisor |
Division factor.
(Inherited from Convolution.) |
| DynamicDivisorForEdges |
Use dynamic divisor for edges or not.
(Inherited from Convolution.) |
| FormatTranslations |
Format translations dictionary.
(Inherited from Convolution.) |
| Kernel |
Convolution kernel.
(Inherited from Convolution.) |
| ProcessAlpha |
Specifies if alpha channel must be processed or just copied.
(Inherited from Convolution.) |
| Sigma |
Gaussian sigma value, [0.5, 5.0].
|
| Size |
Kernel size, [3, 21].
|
| Threshold |
Threshold to add to weighted sum.
(Inherited from Convolution.) |
Methods| Name | Description | |
|---|---|---|
| Apply(Bitmap) |
Apply filter to an image.
(Inherited from BaseUsingCopyPartialFilter.) |
| Apply(BitmapData) |
Apply filter to an image.
(Inherited from BaseUsingCopyPartialFilter.) |
| Apply(UnmanagedImage) |
Apply filter to an image in unmanaged memory.
(Inherited from BaseUsingCopyPartialFilter.) |
| Apply(UnmanagedImage, UnmanagedImage) |
Apply filter to an image in unmanaged memory.
(Inherited from BaseUsingCopyPartialFilter.) |
| ApplyInPlace(Bitmap) |
Apply filter to an image.
(Inherited from BaseUsingCopyPartialFilter.) |
| ApplyInPlace(BitmapData) |
Apply filter to an image.
(Inherited from BaseUsingCopyPartialFilter.) |
| ApplyInPlace(UnmanagedImage) |
Apply filter to an unmanaged image.
(Inherited from BaseUsingCopyPartialFilter.) |
| ApplyInPlace(Bitmap, Rectangle) |
Apply filter to an image or its part.
(Inherited from BaseUsingCopyPartialFilter.) |
| ApplyInPlace(BitmapData, Rectangle) |
Apply filter to an image or its part.
(Inherited from BaseUsingCopyPartialFilter.) |
| ApplyInPlace(UnmanagedImage, Rectangle) |
Apply filter to an unmanaged image or its part.
(Inherited from BaseUsingCopyPartialFilter.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods| Name | Description | |
|---|---|---|
 | HasMethod |
Checks whether an object implements a method with the given name.
(Defined by ExtensionMethods.) |
| IsEqual |
Compares two objects for equality, performing an elementwise
comparison if the elements are vectors or matrices.
(Defined by Matrix.) |
| To(Type) | Overloaded.
Converts an object into another type, irrespective of whether
the conversion can be done at compile time or not. This can be
used to convert generic types to numeric types during runtime.
(Defined by ExtensionMethods.) |
| ToT | Overloaded.
Converts an object into another type, irrespective of whether
the conversion can be done at compile time or not. This can be
used to convert generic types to numeric types during runtime.
(Defined by ExtensionMethods.) |
RemarksThe filter performs convolution filter using the kernel, which is calculate with the help of Kernel2D(Int32) method and then converted to integer kernel by dividing all elements by the element with the smallest value. Using the kernel the convolution filter is known as Gaussian blur.
Using Sigma property it is possible to configure sigma value of Gaussian function.
For the list of supported pixel formats, see the documentation to Convolution filter.
 Note |
|---|
| By default this filter sets ProcessAlpha property to , so the alpha channel of 32 bpp and 64 bpp images is blurred as well. |
Sample usage:
// create filter with kernel size equal to 11 // and Gaussia sigma value equal to 4.0 GaussianBlur filter = new GaussianBlur( 4, 11 ); // apply the filter filter.ApplyInPlace( image );
Initial image:
Result image:
See Also