You are here: Start » FIL.NET » FIL.SmoothImage_Mean
FIL.SmoothImage_Mean
Smooths an image by averaging pixels within a rectangular kernel.
| Namespace: | FilNet |
|---|---|
| Assembly: | FIL.NET.dll |
Syntax
C++
C#
public static void SmoothImage_Mean ( FilNet.Image inImage, FilNet.KernelShape inKernel, int inRadiusX, FilNet.Image outImage )
Parameters
| Name | Type | Range | Default | Description | |
|---|---|---|---|---|---|
 | inImage | FilNet.Image | Input image. | ||
| inKernel | FilNet.KernelShape | Kernel shape. | ||
| inRadiusX | int | <0, INF> | 1 | Nearly half of the kernel's width (2*R+1). Default value: 1. |
 | outImage | FilNet.Image | Output image. |
Description
Replaces each pixel with the average of all pixels contained in a rectangular kernel.
The width of the kernel is 2 * inRadiusX + 1, the height is 2 * inRadiusY + 1.
When inRadiusY is set to Auto, then its value is implicitly copied from inRadiusX.
Examples
 |
 |
SmoothImage_Mean performed on a sample image with inRadiusX = 4.
Hardware Acceleration
This operation supports automatic parallelization for multicore and multiprocessor systems.
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. |
