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

GradientMagnitudeImage_Signed

Header:	AVL.h
Namespace:	avl
Module:	FoundationBasic

Computes an image of gradient for only selected direction.

Applications: For highly optimized analysis of gradient directions.

Syntax

void avl::GradientMagnitudeImage_Signed
(
	const avl::Image& inImage,
	atl::Optional<const avl::Region&> inRoi,
	avl::EdgeTransition::Type inEdgeTransition,
	avl::DifferentiationMethod::Type inDiffMethod,
	avl::GradientOrientation::Type inGradientOrientation,
	avl::Image& outImage
)

Parameters

Name	Type	Default	Description
inImage	const Image&		Input image
inRoi	Optional<const Region&>	NIL	Range of pixels to be processed
inEdgeTransition	EdgeTransition::Type
inDiffMethod	DifferentiationMethod::Type
inGradientOrientation	GradientOrientation::Type
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.