Back to Aurora Vision Library website

You are here: Start » Function Reference » System » Interoperability » LoadSurfaceWithImage

LoadSurfaceWithImage


Header: AVL.h
Namespace: avl
Module: FoundationBasic

Loads entities from a file of one of available types as an array of points in 3D and an image. Assumes an unordered grid with possible holes.

Syntax

C++
C#
 
void avl::LoadSurfaceWithImage
(
	const atl::File& inFile,
	avl::Point3DFileFormat::Type inFileFormat,
	const double inXScale,
	const avl::ValueLimits_f64& inXLimits,
	const double inYScale,
	const avl::ValueLimits_f64& inYLimits,
	const double inZOffset,
	const double inZScale,
	avl::PlainType::Type inPointType,
	avl::SurfaceMultipointHeight::Type inMultipointHeight,
	const avl::Pixel& inBackgroundColor,
	avl::Surface& outSurface,
	avl::Image& outImage,
	atl::Optional<double&> outMinX = atl::NIL,
	atl::Optional<double&> outMinY = atl::NIL,
	avl::Region& diagSurfaceValidPointsRegion
)

Parameters

Name Type Range Default Description
Input value inFile const File&
Input value inFileFormat Point3DFileFormat::Type
Input value inXScale const double 0.000001 - 1.0D
Input value inXLimits const ValueLimits_f64&
Input value inYScale const double 0.000001 - 1.0D
Input value inYLimits const ValueLimits_f64&
Input value inZOffset const double
Input value inZScale const double 0.000001 - 1.0D
Input value inPointType PlainType::Type Real Type of single surface point Z coordinate
Input value inMultipointHeight SurfaceMultipointHeight::Type Mean Determines the Z coordinate of a surface point created from more than one point
Input value inBackgroundColor const Pixel&
Output value outSurface Surface&
Output value outImage Image& Output image
Output value outMinX Optional<double&> NIL
Output value outMinY Optional<double&> NIL
Diagnostic input diagSurfaceValidPointsRegion Region& Region of locations where the surface points are valid

Optional Outputs

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

Read more about Optional Outputs.

Errors

List of possible exceptions:

Error type Description
DomainError Unknown file format in LoadSurfaceWithImage.