You are here: Start » AVL.NET » Function Reference » Surface » Surface Fitting » AVL.FitPlaneToSurface
Approximates points of the input surface with a plane using the Least Squares method.
Namespace: | AvlNet |
---|---|
Assembly: | AVL.NET.dll |
Syntax
C++
C#
public static void FitPlaneToSurface ( AvlNet.Surface inSurface, NullableRef<AvlNet.Region> inRoi, out AvlNet.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 | |
---|---|---|---|---|---|
inSurface | AvlNet.Surface | Input surface. | |||
inRoi | AvlNet.NullableRef<AvlNet.Region> | Region of interest. Default value: atl::NIL. | |||
outPlane | AvlNet.Plane3D | Fitted plane. | |||
outDistances | AvlNet.NullableRef<System.Collections.Generic.List<float>> | Distances of the input surface points to a resulting plane. Can be null to skip this parameter calculation. | |||
outSignedDistanceSum | AvlNet.NullableValue<float> | Sum of signed distances of the input surface points to a resulting plane. Can be null to skip this parameter calculation. | |||
outDistanceSum | AvlNet.NullableValue<float> | Sum of distances of the input surface points to a resulting plane. Can be null to skip this parameter calculation. | |||
outSquaredDistances | AvlNet.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. | |||
outSquaredDistanceSum | AvlNet.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
- FitPlaneToSurface(Surface, Plane3D)
- FitPlaneToSurface(Surface, NullableRef<Region>, Plane3D)
- FitPlaneToSurface(Surface, NullableRef<Region>, Plane3D, IList<Single>, Single, Single, IList<Single>, Single)