Generates the 6-DOF transform required to best-fit one point group to another (scale is fixed at 1.0).
Input Arguments
0 |
Collection Object Name |
Reference Group |
The group to fit to. |
1 |
Collection Object Name |
Corresponding Group |
The group to fit. |
2 |
Boolean |
Show Interface |
Indicates whether the best-fit interface should be displayed for the fit. |
3 |
Double |
RMS Tolerance (0.0 for none) |
An RMS tolerance for the fit. |
4 |
Double |
Maximum Absolute Tolerance (0.0 for none) |
A maximum absolute tolerance for the fit. |
5 |
Boolean |
Allow Scale |
Indicates if scaling should be allowed. |
6 |
Boolean |
Allow X |
Indicates if the X degree of freedom is allowed. |
7 |
Boolean |
Allow Y |
Indicates if the Y degree of freedom is allowed. |
8 |
Boolean |
Allow Z |
Indicates if the Z degree of freedom is allowed. |
9 |
Boolean |
Allow Rx |
Indicates if the Rx rotational degree of freedom is allowed. |
10 |
Boolean |
Allow Ry |
Indicates if the Ry rotational degree of freedom is allowed. |
11 |
Boolean |
Allow Rz |
Indicates if the Rz rotational degree of freedom is allowed. |
12 |
Boolean |
Lock Degrees of Freedom |
True enables locking of degrees of freedom |
13 |
Boolean |
Generate Event |
True enables event generation |
14 |
File Path or Embedded File |
File Path for CSV Text Report (requires Show Interface = TRUE) |
The path for a CSV text report to create as a result of the fit. This will only create the file if the inter- face is shown. |
Return Arguments
15 |
Transform |
Transform in Working |
The resulting transform in working coordinates. |
16 |
World Transform Operator |
Optimum Transform |
The resulting transform represented as a world transform operator. |
17 |
Double |
RMS Deviation |
The actual RMS deviation of the fit. |
18 |
Double |
Maximum Absolute Deviation |
The actual maximum absolute deviation of the fit. |
19 |
Integer |
Number of Unknowns |
The number of unknowns |
20 |
Integer |
Number of Equations |
The number of equations used |
21 |
Double |
Robustness |
The solution robustness |
Returned Status
SUCCESS |
The fit was successful. |
FAILURE |
One or both groups could not be found, or a tolerance was violated. |
Remarks
A tolerance of 0.0 implies that a tolerance should not be applied.
Monitoring the solution robustness factor is a great way to identify the mathematical stability of the solution.