You are here: Start » Function Reference » 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

Creates a Surface structure from depth map mono image.

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
inImage	const Image&			Source mono image with depth map
inRoi	Optional<const Region&>		NIL	Region determining valid points in resulting Surface
inXOffset	double		0.0D
inXScale	double	0.000001 -	1.0D
inYOffset	double		0.0D
inYScale	double	0.000001 -	1.0D
inZOffset	double		0.0D
inZScale	double	0.000001 -	1.0D
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.