Back to Aurora Vision Library website

You are here: Start » Function Reference » Image » Image Features » ImageProfileAlongPath

ImageProfileAlongPath


Header: AVL.h
Namespace: avl
Module: FoundationPro

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#
 
void avl::ImageProfileAlongPath
(
	ScanMapState& ioState,
	const avl::Image& inImage,
	const avl::Path& inScanPath,
	atl::Optional<const avl::CoordinateSystem2D&> inScanPathAlignment,
	int inScanWidth,
	const avl::SamplingParams& inSamplingParams,
	float inSmoothingStdDev,
	avl::AccumulationMode::Type inAccumulationMode,
	atl::Optional<avl::Pixel> inBorderColor,
	avl::Profile& outProfile,
	avl::Path& outPath,
	atl::Optional<avl::Path&> outAlignedScanPath = atl::NIL,
	atl::Array<avl::Path>& diagSamplingPoints,
	float& diagSamplingStep
)

Parameters

Name Type Range Default Description
Input will be modified ioState ScanMapState& Object used to maintain state of the function.
Input value inImage const Image& Input image
Input value inScanPath const Path& Path along which the profile is extracted
Input value inScanPathAlignment Optional<const CoordinateSystem2D&> NIL 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 const SamplingParams& Parameters controlling the sampling process
Input value inSmoothingStdDev float 0.0 - 0.6f Standard deviation of the gaussian smoothing applied to the extracted profile
Input value inAccumulationMode AccumulationMode::Type Determines how the pixel values are combined
Input value inBorderColor Optional<Pixel> Pixel ( X: 0.0f Y: 0.0f Z: 0.0f W: 0.0f ) 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 Optional<Path&> NIL Input scan path after transformation (in the image coordinates)
Diagnostic input diagSamplingPoints Array<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

Optional Outputs

The computation of following outputs can be switched off by passing value atl::NIL to these parameters: outAlignedScanPath.

Read more about Optional Outputs.

Examples

ImageProfileAlongPath applied on an image of a bottle (inScanWidth = 5)