Back to FabImage Library website

You are here: Start » Function Reference » Image » Image Local Transforms » GradientMagnitudeImage_Signed

GradientMagnitudeImage_Signed


Header: FIL.h
Namespace: fil
Module: FoundationBasic

Computes an image of gradient for only selected direction.

Applications: For highly optimized analysis of gradient directions.

Syntax

C++
C#
 
void fil::GradientMagnitudeImage_Signed
(
	const fil::Image& inImage,
	ftl::Optional<const fil::Region&> inRoi,
	fil::EdgeTransition::Type inEdgeTransition,
	fil::DifferentiationMethod::Type inDiffMethod,
	fil::GradientOrientation::Type inGradientOrientation,
	fil::Image& outImage
)

Parameters

Name Type Default Description
Input value
 inImage const Image& Input image
Input value
 inRoi Optional<const Region&> NIL Range of pixels to be processed
Input value
 inEdgeTransition EdgeTransition::Type
Input value
 inDiffMethod DifferentiationMethod::Type
Input value
 inGradientOrientation GradientOrientation::Type
Output value
 outImage Image& Output image

Requirements

For input inImage only pixel formats are supported: 1⨯uint8, 1⨯int8, 1⨯uint16, 1⨯int16, 1⨯int32, 1⨯real.

Read more about pixel formats in Image documentation.

Hardware Acceleration

This operation is optimized for SSE41 technology for pixels of type: UINT8.

This operation is optimized for AVX2 technology for pixels of type: UINT8.

This operation is optimized for NEON technology for pixels of type: UINT8.

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

List of possible exceptions:

Error type Description
DomainError Not supported inImage pixel format in GradientMagnitudeImage_Signed. Supported formats: 1xUInt8, 1xInt8, 1xUInt16, 1xInt16, 1xInt32, 1xReal.