You are here: Start » Function Reference » Shape Fitting 3D » FisFilter_FitPathToEdges3D

FisFilter_FitPathToEdges3D

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

Performs a series of 1D edge detections in 3D and creates a path from the detected points.

Syntax

void fis::FisFilter_FitPathToEdges3D
(
	FitPathToEdges3DState& ioState,
	const fil::Surface& inSurface,
	const fil::PathFittingField& inFittingField,
	ftl::Optional<const fil::CoordinateSystem2D&> inFittingFieldAlignment,
	ftl::Optional<float> inScanStep,
	ftl::Optional<float> inSamplingStep,
	int inScanWidth,
	const fil::InterpolationMethod::Type inSurfaceInterpolation,
	const fil::EdgeScanParams3D& inEdgeScanParams,
	fil::Selection::Type inEdgeSelection,
	ftl::Optional<const fil::LocalBlindness&> inLocalBlindness,
	ftl::Optional<int> inMaxProfileGapWidth,
	ftl::Optional<int> inMaxPathInterpolationLength,
	ftl::Optional<float> inMaxDeviationDelta,
	float inMaxIncompleteness,
	ftl::Conditional<ftl::Array<fil::Point3D> >& outPath,
	ftl::Optional<ftl::Array<ftl::Conditional<fil::SurfaceEdge1D> >&> outEdges = ftl::NIL,
	ftl::Optional<ftl::Conditional<fil::Profile>&> outDeviationProfile = ftl::NIL,
	ftl::Optional<fil::PathFittingField&> outAlignedFittingField = ftl::NIL,
	ftl::Array<fil::Segment2D>& diagScanSegments,
	ftl::Array<fil::Rectangle2D>& diagSamplingAreas,
	ftl::Array<fil::Profile>& diagHeightProfiles,
	ftl::Array<fil::Profile>& diagResponseProfiles
)

Parameters

Name	Type	Range	Default	Description
ioState	FitPathToEdges3DState&			Object used to maintain state of the function.
inSurface	const Surface&			Surface to fit path to
inFittingField	const PathFittingField&			Path fitting field
inFittingFieldAlignment	Optional<const CoordinateSystem2D&>		NIL	Adjusts the fitting field to the position of the inspected object
inScanStep	Optional<float>	0.0 -	5.0f	Optional implicit conversion of the input path to an equidistant one
inSamplingStep	Optional<float>		NIL	Desired distance between consecutive sampling points on the scan segments; if Nil, the bigger of surface X and Y scales is chosen
inScanWidth	int	1 -	5	The width of each scan field (in pixels)
inSurfaceInterpolation	const InterpolationMethod::Type		Bilinear	Interpolation method used for extraction of surface points
inEdgeScanParams	const EdgeScanParams3D&		EdgeScanParams3D ( ProfileInterpolation: Quadratic4 SmoothingStdDev: 1.0f MinMagnitude: 5.0f EdgeTransition: LowToHigh )	Parameters controlling the edge extraction process
inEdgeSelection	Selection::Type			Selection mode of 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
inMaxPathInterpolationLength	Optional<int>	0 -	1	Maximal number of consecutive points not found
inMaxDeviationDelta	Optional<float>	0.0 -	NIL	Maximal difference between deviations of consecutive path points
inMaxIncompleteness	float	0.0 - 0.999	0.1f	Maximal fraction of edge points not found
outPath	Conditional<Array<Point3D> >&			Fitted path or nothing if the fitting failed
outEdges	Optional<Array<Conditional<SurfaceEdge1D> >&>		NIL	Found edges
outDeviationProfile	Optional<Conditional<Profile>&>		NIL	Profile of distances between the actual path points and the corresponding reference path points
outAlignedFittingField	Optional<PathFittingField&>		NIL	Fitting field used; in the image coordinate system
diagScanSegments	Array<Segment2D>&			Segments along which the scans were run
diagSamplingAreas	Array<Rectangle2D>&			Areas from which the input image is sampled
diagHeightProfiles	Array<Profile>&			Extracted surface height profiles
diagResponseProfiles	Array<Profile>&			Profiles 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, outDeviationProfile, outAlignedFittingField.

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.