CreateScanMap


Precomputes a data object that is required for fast 1D edge detection.

Applications:Used together with 1D Edge Detection filters (excluding "_Direct"), but can be moved before the loop if only the scan parameters do not change.

Syntax

C++
C#
Python
 
def CreateScanMap(
	inImageFormat: ImageFormat,
	inScanPath: Path,
	inScanWidth: int,
	inSamplingParams: SamplingParams,
	outScanMap: ScanMap,
	/,
	*,
	inScanPathAlignment: CoordinateSystem2D | None = None,
	outAlignedScanPath: Path | None = None
)
-> (
	diagSamplingPoints: list[Path],
	diagSamplingStep: float
)

Parameters

Name Type Range Default Description
Input value inImageFormat ImageFormat Dimensions, depth and pixel type of the image on which edge detection will be performed
Input value inScanPath Path Path along which the scan is performed
Input value inScanPathAlignment CoordinateSystem2D | None None Adjusts the scan path to the position of the inspected object
Input value inScanWidth int 1 - Width of the scan field in pixels
Input value inSamplingParams SamplingParams Parameters controlling the sampling process
Output value outScanMap ScanMap Optimized data object required for 1D edge detection
Output value outAlignedScanPath Path | None None Transformed input path
Diagnostic input diagSamplingPoints list[Path] Array of paths each one containing the sampling points that contributes to a single value of the extracted profile
Diagnostic input diagSamplingStep float Used distance between consecutive sampling points on the scan path