Back to FabImage Library website

You are here: Start » Function Reference » Computer Vision » Shape Fitting 3D » FitCircleToRidges3D

FitCircleToRidges3D


Header: FIL.h
Namespace: fil
Module: Vision3DStandard

Performs a series of 1D ridge detections and finds a circle that best matches the detected points.

Applications: Precise detection of a circular object or hole, whose rough location is known beforehand.

Syntax

C++
C#
 
void fil::FitCircleToRidges3D
(
	const fil::Surface& inSurface,
	const CircleFittingMap& inFittingMap,
	const 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<ftl::Array<fil::Point3D>&> outInliers = ftl::NIL,
	ftl::Optional<ftl::Array<fil::Profile>&> outHeightProfiles = ftl::NIL,
	ftl::Optional<ftl::Array<fil::Profile>&> outResponseProfiles = ftl::NIL
)

Parameters

Name Type Range Default Description
Input value inSurface const Surface& Surface to fit the circle to
Input value inFittingMap const CircleFittingMap& Input fitting map
Input value inRidgeScanParams const RidgeScanParams3D& Parameters controlling the ridge extraction process
Input value inRidgeSelection Selection::Type SelectionBest Selection mode of ridges
Input value inLocalBlindness Optional<const LocalBlindness&> NIL Defines conditions in which weaker ridges can be detected in the vicinity of stronger ridges
Input value inMaxProfileGapWidth Optional<int> 0 - 1 Maximal number of consecutive not existing profile points
Input value inMaxIncompleteness float 0.0 - 0.999 0.1f Maximal fraction of ridge points not found
Input value inFittingMethod CircleFittingMethod::Type AlgebraicTaubin Method used to fit a circle
Input value inOutlierSuppression Optional<MEstimator::Type> NIL Selects a method for ignoring incorrectly detected points
Output value outCircle Conditional<Circle3D>& Fitted circle or nothing if the fitting fails
Output value outRidges Optional<Array<Conditional<SurfaceRidge1D>>&> NIL Found ridges
Output value outDeviationProfile Optional<Conditional<Profile>&> NIL Profile of distances between the actual circle points and the corresponding reference circle points
Output value outInliers Optional<Array<Point3D>&> NIL Points matching the fitting Circle
Output value outHeightProfiles Optional<Array<Profile>&> NIL Extracted surface height profiles
Output value outResponseProfiles Optional<Array<Profile>&> NIL 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, outInliers, outHeightProfiles, outResponseProfiles.

Read more about Optional Outputs.

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

List of possible exceptions:

Error type Description
DomainError Ridge operator parameters are too low in surface ridges detector in FitCircleToRidges3D.