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

FisFilter_ScanSingleStripe3D

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

Header:	FIL.h
Namespace:	fis

Locates the strongest pair of changes of surface height along a given path.

Syntax

void fis::FisFilter_ScanSingleStripe3D
(
	ScanSingleStripe3DState& ioState,
	const fil::Surface& inSurface,
	const fil::Path& inScanPath,
	ftl::Optional<const fil::CoordinateSystem2D&> inScanPathAlignment,
	int inScanWidth,
	fil::InterpolationMethod::Type inSurfaceInterpolation,
	const fil::StripeScanParams3D& inStripeScanParams,
	fil::Selection::Type inStripeSelection,
	ftl::Optional<const fil::LocalBlindness&> inLocalBlindness,
	ftl::Optional<int> inMaxProfileGapWidth,
	ftl::Conditional<fil::SurfaceStripe1D>& outStripe,
	ftl::Optional<fil::Path&> outAlignedScanPath = ftl::NIL,
	fil::Profile& diagHeightProfile,
	fil::Profile& diagResponseProfile
)

Parameters

Name	Type	Range	Default	Description
ioState	ScanSingleStripe3DState&			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
inStripeScanParams	const StripeScanParams3D&		StripeScanParams3D ( ProfileInterpolation: Quadratic4 SmoothingStdDev: 0.6f MinMagnitude: 5.0f MaxInnerEdgeMagnitude: Nil StripePolarity: Low MinStripeWidth: 0.0f MaxStripeWidth: Nil )	Parameters controlling the surface stripe extraction process
inStripeSelection	Selection::Type			Selection mode of the resulting surface stripe
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
outStripe	Conditional<SurfaceStripe1D>&			Found surface stripe
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: outStripe, outAlignedScanPath.