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,
	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.
outPlaneFilNet.Plane3DFitted plane.
outDistancesFilNet.NullableRef<System.Collections.Generic.List<float>>Distances of the input surface points to a resulting plane. Can be null to skip this parameter calculation.
outSignedDistanceSumFilNet.NullableValue<float>Sum of signed distances of the input surface points to a resulting plane. Can be null to skip this parameter calculation.
outDistanceSumFilNet.NullableValue<float>Sum of distances of the input surface 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 surface points to a resulting plane. Can be null to skip this parameter calculation.
outSquaredDistanceSumFilNet.NullableValue<float>Sum of squared distances of the input surface 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.
DomainError Region of interest exceeds an input surface in FitPlaneToSurface.

Function Overrides

See also