You are here: Start » FIL.NET » Function Reference » Surface » Surface Fitting » FIL.FitPlaneToSurface_M

FIL.FitPlaneToSurface_M

Approximates points of the input surface with a plane using selected M-estimator for outlier suppression.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void FitPlaneToSurface_M
(
	FilNet.Surface inSurface,
	NullableRef<FilNet.Region> inRoi,
	FilNet.MEstimator inOutlierSuppression,
	float inClippingFactor,
	int inIterationCount,
	FilNet.Plane3D? inInitialPlane,
	out FilNet.Plane3D outPlane,
	NullableRef<List<FilNet.Point3D>> outInliers,
	NullableRef<List<float>> outDistances,
	NullableValue<float> outSignedDistanceSum,
	NullableValue<float> outDistanceSum,
	NullableRef<List<float>> outSquaredDistances,
	NullableValue<float> outSquaredDistanceSum
)

Parameters

Name Type Range Default Description
inSurfaceFilNet.SurfaceInput surface.
inRoiFilNet.NullableRef<FilNet.Region>Region of interest. Default value: ftl::NIL.
inOutlierSuppressionFilNet.MEstimatorSelects a method for ignoring points being much different from the rest.
inClippingFactorfloat<0.675f, 6.0f>2.5fMultitude of standard deviation within which points are considered inliers. Default value: 2.5f.
inIterationCountint<0, INF>5Number of iterations of outlier suppressing algorithm. Default value: 5.
inInitialPlaneFilNet.Plane3D?Initial approximation (if available). Default value: ftl::NIL.
outPlaneFilNet.Plane3DFitted plane.
outInliersFilNet.NullableRef<System.Collections.Generic.List<FilNet.Point3D>>Points matching the computed plane. Can be null to skip this parameter calculation.
outDistancesFilNet.NullableRef<System.Collections.Generic.List<float>>Distances of the input points to a resulting plane. Can be null to skip this parameter calculation.
outSignedDistanceSumFilNet.NullableValue<float>Sum of signed distances of the input points to a resulting plane. Can be null to skip this parameter calculation.
outDistanceSumFilNet.NullableValue<float>Sum of distances of the input points to a resulting plane. Can be null to skip this parameter calculation.
outSquaredDistancesFilNet.NullableRef<System.Collections.Generic.List<float>>Squared distances of the input points to a resulting plane. Can be null to skip this parameter calculation.
outSquaredDistanceSumFilNet.NullableValue<float>Sum of squared distances of the input points to a resulting plane. Can be null to skip this parameter calculation.

Errors

List of possible exceptions:

Error type Description
DomainError No points to fit the plane to in FitPlaneToSurface_M.
DomainError Region of interest exceeds an input surface in FitPlaneToSurface_M.

Function Overrides

See also