ImageProfileAlongPath


Creates a series of segments across the input path, measures the average pixel intensity on each of the segments, and creates the final profile from those values.

Applications:This is the first step of all 1D Edge Detection operations. Here available for direct use by the user.

Syntax

C++
C#
Python
 
def ImageProfileAlongPath(
	state: ScanMapState,
	inImage: Image,
	inScanPath: Path,
	outProfile: Profile,
	outPath: Path,
	/,
	*,
	inScanPathAlignment: CoordinateSystem2D | None = None,
	inScanWidth: int = 5,
	inSamplingParams: SamplingParams = SamplingParams(InterpolationMethod.Bilinear, 1.0, None),
	inSmoothingStdDev: float = 0.6,
	inAccumulationMode: AccumulationMode = AccumulationMode.Average,
	inBorderColor: Pixel | None = Pixel(0.0, 0.0, 0.0, 0.0),
	outAlignedScanPath: Path | None = None
)
-> (
	diagSamplingPoints: list[Path],
	diagSamplingStep: float
)

Parameters

Name Type Range Default Description
Input will be modified ioState ScanMapState
Input value inImage Image Input image
Input value inScanPath Path Path along which the profile is extracted
Input value inScanPathAlignment CoordinateSystem2D | None None Adjusts the scan path to the position of the inspected object
Input value inScanWidth int 1 - 5 Width of the scan field in pixels
Input value inSamplingParams SamplingParams SamplingParams(InterpolationMethod.Bilinear, 1.0, None) Parameters controlling the sampling process
Input value inSmoothingStdDev float 0.0 - 0.6 Standard deviation of the gaussian smoothing applied to the extracted profile
Input value inAccumulationMode AccumulationMode AccumulationMode.Average Determines how the pixel values are combined
Input value inBorderColor Pixel | None Pixel(0.0, 0.0, 0.0, 0.0) Color of pixel outside image
Output value outProfile Profile The resulting profile of the pixel brightness
Output value outPath Path The path consisting of the points from which the resulting profile is extracted
Output value outAlignedScanPath Path | None None Input scan path after transformation (in the image coordinates)
Diagnostic input diagSamplingPoints list[Path] Array of paths each one containing the sampling points that contributed to a single value of the extracted profile
Diagnostic input diagSamplingStep float Used distance between consecutive sampling points on the scan path