Back to Aurora Vision Library website

You are here: Start » Function Reference » Surface » Surface Features » SurfaceNormalsImage

SurfaceNormalsImage


Header: AVL.h
Namespace: avl
Module: Vision3DStandard

Computes a normals image for a surface

Syntax

C++
C#
 
void avl::SurfaceNormalsImage
(
	const avl::Surface& inSurface,
	atl::Optional<const avl::Region&> inRoi,
	const float inScale,
	avl::Image& outNormalsImage,
	atl::Optional<avl::Region&> outComputedRegion = atl::NIL
)

Parameters

Name Type Range Default Description
Input value inSurface const Surface&
Input value inRoi Optional<const Region&> NIL Range of pixels to be processed
Input value inScale const float 0.0 - 1.0f
Output value outNormalsImage Image&
Output value outComputedRegion Optional<Region&> NIL

Optional Outputs

The computation of following outputs can be switched off by passing value atl::NIL to these parameters: outComputedRegion.

Read more about Optional Outputs.

Errors

List of possible exceptions:

Error type Description
DomainError Region of interest exceeds an input surface in SurfaceNormalsImage.