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

FisFilter_ScanMultipleEdges3D

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

Header:	FIL.h
Namespace:	fis

Locates multiple changes of surface height along a given path.

Syntax

void fis::FisFilter_ScanMultipleEdges3D
(
	ScanMultipleEdges3DState& ioState,
	const fil::Surface& inSurface,
	const fil::Path& inScanPath,
	ftl::Optional<const fil::CoordinateSystem2D&> inScanPathAlignment,
	int inScanWidth,
	fil::InterpolationMethod::Type inSurfaceInterpolation,
	const fil::EdgeScanParams3D& inEdgeScanParams,
	float inMinDistance,
	ftl::Optional<float> inMaxDistance,
	ftl::Optional<const fil::LocalBlindness&> inLocalBlindness,
	ftl::Optional<int> inMaxProfileGapWidth,
	ftl::Array<fil::SurfaceEdge1D>& outEdges,
	ftl::Optional<fil::Path&> outAlignedScanPath = ftl::NIL,
	fil::Profile& diagHeightProfile,
	fil::Profile& diagResponseProfile
)

Parameters

Name	Type	Range	Default	Description
ioState	ScanMultipleEdges3DState&			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
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
inMinDistance	float	0.0 -	0.0f	Minimal distance between consecutive edges
inMaxDistance	Optional<float>	0.0 -	NIL	Maximal distance between consecutive edges
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
outEdges	Array<SurfaceEdge1D>&			Found surface edges
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

Optional Outputs

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

Description

The operation scans the surface along inScanPath and detects surface edges perpendicular to the path. Depending on the inEdgeScanParams.edgeTransition parameter, edges representing increase or decrease (or both) of surface height along the path will be taken into account.

When the number of edges to be found is known, one can use the FisFilter_ScanExactlyNEdges3D.

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.

Note that in case of a scan path which is closed, the parameters controlling the distances between consecutive found objects do not control the distance between the first and the last of the found objects (counting from the beginning of the scan path).

The operation is very similar to ScanMultipleEdges 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.

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 too few edges are 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.
Adjust inMinDistance (in surface coordinates) to filter out false edges that appear in proximity to other edges.

Remarks

For more information about local coordinate systems please refer to the following article.