CreateImageFromSurface


Creates a depth image from the Z-values of the input surface.

Applications:Allows for performing 2D operations on 3D data.

Syntax

C++
C#
Python
 
def CreateImageFromSurface(
	inSurface: Surface,
	inResampleSurfaceMode: ResampleSurfaceMode,
	outImage: Image,
	/,
	*,
	inPixelType: PlainType = PlainType.Real,
	inXOffset: float | None = None,
	inYOffset: float | None = None,
	inPixelOffset: float | None = None,
	inPixelScale: float | None = 1.0,
	inMissingPointValue: float | None = 0.0,
	outSurfaceFormat: SurfaceFormat | None = None
)
-> None

Parameters

Name Type Range Default Description
Input value inSurface Surface Input surface
Input value inPixelType PlainType PlainType.Real Output image pixel type
Input value inResampleSurfaceMode ResampleSurfaceMode
Input value inXOffset float | None None Offset for the X axis of the output image; if set to Nil, surface X offset is chosen
Input value inYOffset float | None None Offset for the Y axis of the output image; if set to Nil, surface Y offset is chosen
Input value inPixelOffset float | None None Offset that the input surface values have in the output image; if set to Nil, surface Z offset is chosen
Input value inPixelScale float | None 0.0D - 1.0 Scale that the input surface values have in the output image; if set to Nil, surface Z scale is chosen
Input value inMissingPointValue float | None 0.0 Value assigned to pixels where point is undefined
Output value outImage Image Input surface depth image
Output value outSurfaceFormat SurfaceFormat | None None Format of the surface that the output image represents