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

LoadSurfaceWithImage

Header:	FIL.h
Namespace:	fil
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

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

Parameters

Name	Type	Range	Default	Description
inFile	const File&
inFileFormat	Point3DFileFormat::Type
inXScale	const double	0.000001 -	1.0D
inXLimits	const ValueLimits_f64&
inYScale	const double	0.000001 -	1.0D
inYLimits	const ValueLimits_f64&
inZOffset	const double
inZScale	const double	0.000001 -	1.0D
inPointType	PlainType::Type		Real	Type of single surface point Z coordinate
inMultipointHeight	SurfaceMultipointHeight::Type		Mean	Determines the Z coordinate of a surface point created from more than one point
inBackgroundColor	const Pixel&
outSurface	Surface&
outImage	Image&			Output image
outMinX	Optional<double&>		NIL
outMinY	Optional<double&>		NIL
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 ftl::NIL to these parameters: outMinX, outMinY.

Errors

List of possible exceptions:

Error type	Description
DomainError	Unknown file format in LoadSurfaceWithImage.