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

FisFilter_FitCircleToRidges3D

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 ridge detections in 3D and finds a circle that best matches the detected points.

Syntax

void fis::FisFilter_FitCircleToRidges3D
(
	FitCircleToRidges3DState& ioState,
	const fil::Surface& inSurface,
	const fil::CircleFittingField& inFittingField,
	ftl::Optional<const fil::CoordinateSystem2D&> inFittingFieldAlignment,
	int inScanCount,
	ftl::Optional<float> inSamplingStep,
	int inScanWidth,
	const fil::InterpolationMethod::Type inSurfaceInterpolation,
	const fil::RidgeScanParams3D& inRidgeScanParams,
	fil::Selection::Type inRidgeSelection,
	ftl::Optional<const fil::LocalBlindness&> inLocalBlindness,
	ftl::Optional<int> inMaxProfileGapWidth,
	float inMaxIncompleteness,
	fil::CircleFittingMethod::Type inFittingMethod,
	ftl::Optional<fil::MEstimator::Type> inOutlierSuppression,
	ftl::Conditional<fil::Circle3D>& outCircle,
	ftl::Optional<ftl::Array<ftl::Conditional<fil::SurfaceRidge1D> >&> outRidges = ftl::NIL,
	ftl::Optional<ftl::Conditional<fil::Profile>&> outDeviationProfile = ftl::NIL,
	ftl::Optional<fil::CircleFittingField&> outAlignedFittingField = ftl::NIL,
	ftl::Optional<ftl::Array<fil::Point3D>&> outInliers = 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	FitCircleToRidges3DState&			Object used to maintain state of the function.
inSurface	const Surface&			Surface to fit the circle to
inFittingField	const CircleFittingField&			Circle fitting field
inFittingFieldAlignment	Optional<const CoordinateSystem2D&>		NIL	Adjusts the fitting field to the position of the inspected object
inScanCount	int	3 -	10	The number of points that will be searched to estimate the position of the circle
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
inRidgeScanParams	const RidgeScanParams3D&		RidgeScanParams3D ( ProfileInterpolation: Quadratic4 SmoothingStdDev: 0.6f RidgeWidth: 5.0f RidgeMargin: 2.0f RidgeOperator: Minimum MinMagnitude: 5.0f RidgePolarity: Low )	Parameters controlling the ridge extraction process
inRidgeSelection	Selection::Type			Selection mode of ridges
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
inMaxIncompleteness	float	0.0 - 0.999	0.1f	Maximal fraction of ridge points not found
inFittingMethod	CircleFittingMethod::Type		AlgebraicTaubin	Method used to fit a circle
inOutlierSuppression	Optional<MEstimator::Type>		NIL	Selects a method for ignoring incorrectly detected points
outCircle	Conditional<Circle3D>&			Fitted circle or nothing if the fitting fails
outRidges	Optional<Array<Conditional<SurfaceRidge1D> >&>		NIL	Found ridges
outDeviationProfile	Optional<Conditional<Profile>&>		NIL	Profile of distances between the actual circle points and the corresponding reference circle points
outAlignedFittingField	Optional<CircleFittingField&>		NIL	Fitting field used; in the image coordinate system
outInliers	Optional<Array<Point3D>&>		NIL	Points matching the fitting Circle
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 ridge operator response

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outRidges, outDeviationProfile, outAlignedFittingField, outInliers.

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.