CreateSurfaceMeasurementMap


(Pre)computes surface sampling locations used by MeasureObjectWidth3D function.

Syntax

C++
C#
Python
 
def CreateSurfaceMeasurementMap(
	inSurfaceFormat: SurfaceFormat,
	inScanField: SegmentScanField,
	inScanCount: int,
	inScanWidth: int,
	inSurfaceInterpolation: InterpolationMethod,
	/,
	*,
	inScanFieldAlignment: CoordinateSystem2D | None = None,
	inSamplingStep: float | None = None,
	outAlignedScanField: SegmentScanField | None = None
)
-> (
	outMeasurementMap: list[ScanMap],
	diagScanSegments: list[Segment2D]
)

Parameters

Name Type Range Default Description
Input value inSurfaceFormat SurfaceFormat Information about dimensions, depth and pixel type of the surface
Input value inScanField SegmentScanField Field in which scans will be performed
Input value inScanFieldAlignment CoordinateSystem2D | None None Adjusts the scan field to the position of the inspected object
Input value inScanCount int 2 - Number of scans to be performed
Input value inSamplingStep float | None None Desired distance between consecutive sampling points on the scan segments; if Nil, the bigger of surface X and Y scales is chosen
Input value inScanWidth int 1 - Width of the scan area
Input value inSurfaceInterpolation InterpolationMethod Interpolation method used in extraction of image pixel values
Output value outMeasurementMap list[ScanMap]
Output value outAlignedScanField SegmentScanField | None None Field in which the scans will be performed
Diagnostic input diagScanSegments list[Segment2D] Array of scan segments