You are here: Start » AVL.NET » Function Reference » Image » Image Local Transforms » AVL.SmoothImage_Mean
Smooths an image by averaging pixels within a rectangular kernel.
Namespace: | AvlNet |
---|---|
Assembly: | AVL.NET.dll |
Syntax
public static void SmoothImage_Mean ( AvlNet.Image inImage, NullableRef<AvlNet.Region> inRoi, NullableRef<AvlNet.Region> inSourceRoi, AvlNet.Pixel? inBorderColor, AvlNet.KernelShape inKernel, int inRadiusX, int? inRadiusY, AvlNet.Image outImage )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
![]() | inImage | AvlNet.Image | Input image. | ||
![]() | inRoi | AvlNet.NullableRef<AvlNet.Region> | Range of outImage pixels to be computed. Default value: atl::NIL. | ||
![]() | inSourceRoi | AvlNet.NullableRef<AvlNet.Region> | Range of inImage pixels to be read. Default value: atl::NIL. | ||
![]() | inBorderColor | AvlNet.Pixel? | Color of the imaginary pixels outside the image boundaries. Default value: atl::NIL. | ||
![]() | inKernel | AvlNet.KernelShape | Kernel shape. | ||
![]() | inRadiusX | int | <0, INF> | 1 | Nearly half of the kernel's width (2*R+1). Default value: 1. |
![]() | inRadiusY | int? | <0, INF> | Nearly half of the kernel's height (2*R+1), or same as inRadiusX. Default value: atl::NIL. | |
![]() | outImage | AvlNet.Image | Output image. |
Description
Examples
![]() |
![]() |
SmoothImage_Mean performed on a sample image with inRadiusX = 4.
Hardware Acceleration
This operation is optimized for PARALLEL SSE2 technology for pixels of types: UINT8, SINT8, SINT16, SINT32, REAL.
This operation is optimized for SSE41 technology for pixels of type: UINT16.
This operation is optimized for AVX2 technology for pixels of types: UINT8, SINT8, SINT16, SINT32, REAL, UINT16.
This operation is optimized for NEON technology for pixels of types: UINT8, UINT16.
Hardware acceleration settings may be manipulated with Settings class.
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | inBorderColor is relevant only when inSourceRoi is set to Auto (NIL) in SmoothImage_Mean. |
DomainError | Not supported kernel on input in SmoothImage_Mean. |
DomainError | Region exceeds an input image in SmoothImage_Mean. |