LoadSurfaceWithImage


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#
Python
 
def LoadSurfaceWithImage(
	inFile: str,
	outSurface: Surface,
	outImage: Image,
	/,
	*,
	inFileFormat: Point3DFileFormat = Point3DFileFormat.STL,
	inXScale: float = 1.0,
	inXLimits: ValueLimits_f64 = ValueLimits_f64(None, None),
	inYScale: float = 1.0,
	inYLimits: ValueLimits_f64 = ValueLimits_f64(None, None),
	inZOffset: float = 0,
	inZScale: float = 1.0,
	inPointType: PlainType = PlainType.Real,
	inMultipointHeight: SurfaceMultipointHeight = SurfaceMultipointHeight.Mean,
	inBackgroundColor: Pixel = Pixel(0, 0, 0, 0),
	diagSurfaceValidPointsRegion: Region | None = None
)
-> (
	outMinX: float,
	outMinY: float
)

Parameters

Name Type Range Default Description
Input value inFile str
Input value inFileFormat Point3DFileFormat Point3DFileFormat.STL
Input value inXScale float 0.000001D - 1.0
Input value inXLimits ValueLimits_f64 ValueLimits_f64(None, None)
Input value inYScale float 0.000001D - 1.0
Input value inYLimits ValueLimits_f64 ValueLimits_f64(None, None)
Input value inZOffset float 0
Input value inZScale float 0.000001D - 1.0
Input value inPointType PlainType PlainType.Real Type of single surface point Z coordinate
Input value inMultipointHeight SurfaceMultipointHeight SurfaceMultipointHeight.Mean Determines the Z coordinate of a surface point created from more than one point
Input value inBackgroundColor Pixel Pixel(0, 0, 0, 0)
Output value outSurface Surface
Output value outImage Image Output image
Output value outMinX float
Output value outMinY float
Diagnostic input diagSurfaceValidPointsRegion Region | None None Region of locations where the surface points are valid