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

FIL.FitPlaneToSurface

Approximates points of the input surface with a plane using the Least Squares method.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void FitPlaneToSurface
(
	FilNet.Surface inSurface,
	NullableRef<FilNet.Region> inRoi,
	out FilNet.Plane3D outPlane,
	IList<float> outDistances,
	out float outSignedDistanceSum,
	out float outDistanceSum,
	IList<float> outSquaredDistances,
	out float outSquaredDistanceSum
)

Parameters

Name Type Range Default Description
inSurfaceFilNet.SurfaceInput surface.
inRoiFilNet.NullableRef<FilNet.Region>Region of interest. Default value: ftl::NIL.
outPlaneFilNet.Plane3DFitted plane.
outDistancesSystem.Collections.Generic.IList<float>Distances of the input surface points to a resulting plane.
outSignedDistanceSumfloatSum of signed distances of the input surface points to a resulting plane.
outDistanceSumfloatSum of distances of the input surface points to a resulting plane.
outSquaredDistancesSystem.Collections.Generic.IList<float>Squared distances of the input surface points to a resulting plane.
outSquaredDistanceSumfloatSum of squared distances of the input surface points to a resulting plane.

Errors

List of possible exceptions:

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

Function Overrides

See also