Back to Aurora Vision Library website

You are here: Start » Function Reference » All Functions » Surface Basics » MakeSurfaceFromImage

MakeSurfaceFromImage


This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Header: AVL.h
Namespace: avl
Module: Vision3DStandard

Creates a Surface structure from depth map mono image.

Applications: Creating Surface structure out of depth map image obtained from a 3D depth camera or other external sources using 2D images to transfer depth map data.

Syntax

void avl::MakeSurfaceFromImage
(
	const avl::Image& inImage,
	atl::Optional<const avl::Region&> inRoi,
	double inXOffset,
	double inXScale,
	double inYOffset,
	double inYScale,
	double inZOffset,
	double inZScale,
	avl::Surface& outSurface
)

Parameters

Name Type Range Default Description
Input value inImage const Image& Source mono image with depth map
Input value inRoi Optional<const Region&> NIL Region determining valid points in resulting Surface
Input value inXOffset double 0.0D
Input value inXScale double 0.000001 - 1.0D
Input value inYOffset double 0.0D
Input value inYScale double 0.000001 - 1.0D
Input value inZOffset double 0.0D
Input value inZScale double 0.000001 - 1.0D
Output value outSurface Surface&

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.

Errors

List of possible exceptions:

Error type Description
DomainError Not a mono image on input of MakeSurfaceFromImage.
DomainError Not supported inImage pixel format in MakeSurfaceFromImage. Supported formats: 1xUInt8, 1xInt8, 1xUInt16, 1xInt16, 1xInt32, 1xReal.