You are here: Start » FIL.NET » Function Reference » Image » Image Local Transforms » FIL.GradientImage
Computes a gradient image with smoothing operator of any size. The output pixels are signed.
Namespace: | FilNet |
---|---|
Assembly: | FIL.NET.dll |
Syntax
C++
C#
public static void GradientImage ( FilNet.Image inImage, FilNet.GradientOperator inOperator, float inStdDevX, FilNet.Image outGradientImage )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
![]() | inImage | FilNet.Image | Input image. | ||
![]() | inOperator | FilNet.GradientOperator | Defines how the gradient is computed. | ||
![]() | inStdDevX | float | <0.0f, INF> | 2.0f | Horizontal smoothing standard deviation. Default value: 2.0f. |
![]() | outGradientImage | FilNet.Image | Gradients of the image. |
Remarks
Please note that about a half of the pixels will be negative and in the preview windows they will be displayed as black.
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 | Region exceeds an input image in GradientImage. |
Function Overrides
- GradientImage(Image, NullableRef<Region>, GradientOperator, Single, Nullable<Single>, Image)
- GradientImage(Image, NullableRef<Region>, GradientOperator, Single, Nullable<Single>, Image, Image)