You are here: Start » Function Reference » 1D Edge Detection 3D » AvsFilter_ScanSingleEdge3D

AvsFilter_ScanSingleEdge3D

This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code. CreateSurfaceScanMap and ScanSingleEdge3D should be used instead.

Header:	AVL.h
Namespace:	avs

Locates the strongest change of surface height along a given path.

Syntax

void avs::AvsFilter_ScanSingleEdge3D
(
	ScanSingleEdge3DState& ioState,
	const avl::Surface& inSurface,
	const avl::Path& inScanPath,
	atl::Optional<const avl::CoordinateSystem2D&> inScanPathAlignment,
	atl::Optional<float> inSamplingStep,
	int inScanWidth,
	avl::InterpolationMethod::Type inSurfaceInterpolation,
	const avl::EdgeScanParams3D& inEdgeScanParams,
	avl::Selection::Type inEdgeSelection,
	atl::Optional<const avl::LocalBlindness&> inLocalBlindness,
	atl::Optional<int> inMaxProfileGapWidth,
	atl::Conditional<avl::SurfaceEdge1D>& outEdge,
	atl::Optional<avl::Path&> outAlignedScanPath = atl::NIL,
	avl::Profile& diagHeightProfile,
	avl::Profile& diagResponseProfile,
	atl::Array<avl::Path>& diagSamplingPoints,
	float& diagSamplingStep
)

Parameters

Name	Type	Range	Default	Description
ioState	ScanSingleEdge3DState&			Object used to maintain state of the function.
inSurface	const Surface&			Input surface
inScanPath	const Path&			Path along which the scan is performed
inScanPathAlignment	Optional<const CoordinateSystem2D&>		NIL	Adjusts the scan path to the position of the inspected object
inSamplingStep	Optional<float>	0.0 -	NIL	Distance between consecutive sampling points on the scan path; if Nil, the bigger of surface X and Y scales is chosen
inScanWidth	int	1 -	5	Width of the scan field in pixels
inSurfaceInterpolation	InterpolationMethod::Type		Bilinear	Interpolation method used for extraction of surface points
inEdgeScanParams	const EdgeScanParams3D&		EdgeScanParams3D ( ProfileInterpolation: Quadratic4 SmoothingStdDev: 0.6f MinMagnitude: 5.0f EdgeTransition: LowToHigh )	Parameters controlling the surface edge extraction process
inEdgeSelection	Selection::Type			If many edge points are possible, defines which one is selected
inLocalBlindness	Optional<const LocalBlindness&>		NIL	Defines conditions in which weaker edges can be detected in the vicinity of stronger edges
inMaxProfileGapWidth	Optional<int>	0 -	1	Maximal number of consecutive not existing profile points
outEdge	Conditional<SurfaceEdge1D>&			Found surface edge
outAlignedScanPath	Optional<Path&>		NIL	Path along which the scan is performed; in the image coordinate system
diagHeightProfile	Profile&			Extracted surface height profile
diagResponseProfile	Profile&			Profile of the edge (derivative) operator response
diagSamplingPoints	Array<Path>&			Array of paths each one containing the sampling points that contributed to a single value of the extracted profile; in the image coordinate system
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.

Description

The operation scans the surface along inScanPath and locates the strongest edge perpendicular to the path. If the strongest edge is weaker than inEdgeScanParams.minMagnitude then the outputs are set to NIL.

The optional parameter inScanPathAlignment defines a transform to be performed on the inScanPath so that the actual scan path (outAlignedScanPath) is adjusted to the position of the object.

The operation is very similar to ScanSingleEdge from 1D Edge Detection category, but there are some substantial differences. One of these is the possibility of absence of information, because some surface points may not exist at all. To detect such edges, where solely change of existence matters, Valid/Invalid options of inEdgeScanParams.EdgeTransition can be used. Outside the surface domain (i.e. rectangle defined by input surface width, height, offsets and scales) there are no valid or invalid points, so no edge can be found in the direct vicinity of the domain border.

Because in the Valid/Invalid mode all edges have equal strength, if inEdgeSelection is set to Best, it will be implicitly substituted with First selection option.

Please note that when the input surface has unequal scales along X and Y axes and the scan path is not parallel to any of the axes, the results may be slightly less accurate because of uneven sampling along axes.

Hints

Define inEdgeScanParams.EdgeTransition to detect a particular edge type, and only that type.
If no edge is found, try decreasing inEdgeScanParams.MinMagnitude. Verify this with the values on the diagResponseProfile output.
If consecutive edges are closer than 6 pixels apart, change inEdgeScanParams.ProfileInterpolation to Quadratic3.

Remarks

Read more about Local Coordinate Systems in Machine Vision Guide: Local Coordinate Systems.