You are here: Start » Function Reference » Computer Vision » 1D Edge Detection 3D » ScanSingleRidge3D_Direct

ScanSingleRidge3D_Direct

Header:	FIL.h
Namespace:	fil
Module:	Vision3DStandard

Locates the strongest high or low peak of surface height along a given path.

Syntax

void fil::ScanSingleRidge3D_Direct
(
	const fil::Surface& inSurface,
	const fil::Path& inScanPath,
	ftl::Optional<const fil::CoordinateSystem2D&> inScanPathAlignment,
	ftl::Optional<float> inSamplingStep,
	int inScanWidth,
	fil::InterpolationMethod::Type inSurfaceInterpolation,
	const fil::RidgeScanParams3D& inRidgeScanParams,
	fil::Selection::Type inRidgeSelection,
	ftl::Optional<const fil::LocalBlindness&> inLocalBlindness,
	ftl::Optional<int> inMaxProfileGapWidth,
	ftl::Conditional<fil::SurfaceRidge1D>& outRidge,
	ftl::Optional<fil::Path&> outAlignedScanPath = ftl::NIL,
	ftl::Optional<fil::Profile&> outHeightProfile = ftl::NIL,
	ftl::Optional<fil::Profile&> outResponseProfile = ftl::NIL,
	ftl::Array<fil::Path>& diagSamplingPoints,
	float& diagSamplingStep
)

Parameters

Name	Type	Range	Default	Description
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
inRidgeScanParams	const RidgeScanParams3D&		RidgeScanParams3D ( ProfileInterpolation: Quadratic4 SmoothingStdDev: 0.6f RidgeWidth: 5.0f RidgeMargin: 2.0f RidgeOperator: Minimum MinMagnitude: 5.0f RidgePolarity: Any )	Parameters controlling the surface ridge extraction process
inRidgeSelection	Selection::Type			Selection mode of the resulting ridge
inLocalBlindness	Optional<const LocalBlindness&>		NIL	Defines conditions in which weaker ridges can be detected in the vicinity of stronger ridges
inMaxProfileGapWidth	Optional<int>	0 -	1	Maximal number of consecutive not existing profile points
outRidge	Conditional<SurfaceRidge1D>&			Found surface ridge
outAlignedScanPath	Optional<Path&>		NIL	Path along which the scan is performed; in the image coordinate system
outHeightProfile	Optional<Profile&>		NIL	Extracted surface height profile
outResponseProfile	Optional<Profile&>		NIL	Profile of the ridge 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 ftl::NIL to these parameters: outAlignedScanPath, outHeightProfile, outResponseProfile.