You are here: Start » FIL.NET » Function Reference » Image » Image Local Transforms » FIL.SmoothImage_Mean_Mask
FIL.SmoothImage_Mean_Mask
Smooths an image by averaging pixels within a small rectangular kernel.
| Namespace: | FilNet |
|---|---|
| Assembly: | FIL.NET.dll |
Syntax
public static void SmoothImage_Mean_Mask ( FilNet.Image inImage, FilNet.MeanKernel inKernel, FilNet.Image outImage )
Parameters
| Name | Type | Range | Default | Description | |
|---|---|---|---|---|---|
 | inImage | FilNet.Image | Input image. | ||
| inKernel | FilNet.MeanKernel | Selects a predefined kernel. | ||
 | outImage | FilNet.Image | Output image. |
Description
This operation is a simplified, fast in computation, version of SmoothImage_Mean, with predefined kernel and simplified ROI handling.
Kernel used in operation can be chosen by inKernel parameter:
- Box_3x3: 3 by 3 pixels, the closest equivalent is SmoothImage_Mean call with inKernel = Box, inRadiusX = 1, inRadiusY = 1, inIterationsCount = 1
- Box_5x5: 5 by 5 pixels, the closest equivalent is SmoothImage_Mean call with inKernel = Box, inRadiusX = 2, inRadiusY = 2, inIterationsCount = 1
Although above calls are described as closest equivalent their results may vary.
Examples
 |
 |
SmoothImage_Mean_Mask performed on a sample image with inKernel = Box5x5.
Hardware Acceleration
This operation is optimized for SSE2 technology for pixels of types: UINT8, SINT16.
This operation is optimized for AVX2 technology for pixels of types: SSE2: UINT8, SINT16.
This operation is optimized for NEON technology for pixels of types: UINT8, SINT8, UINT16, SINT16.
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 | Region exceeds an input image in SmoothImage_Mean_Mask. |
