Locate Instrument (Best Fit - Group to Group)

Locates an instrument by fitting measured points to a set of reference points.

 

Input Arguments

 

0

Collection Object Name

Reference Group

The group to fit to.

1

Collection Object Name

Corresponding Group

The measured points to fit.

2

Boolean

Show Interface

Indicate whether the best fit interface should be displayed.

3

Double

RMS Tolerance (0.0 for none)

A tolerance for the RMS error of the fit.

4

Double

Maximum Absolute Tolerance (0.0 for none)

A maximum absolute error allowed for the fit.

5

Boolean

Allow Scale

Indicates whether the instrument is allowed to

scale in the fit.

6

Boolean

Allow X

Indicates whether the X position degree of free- dom is allowed to float in the fit.

7

Boolean

Allow Y

Indicates whether the Y position degree of free-

dom is allowed to float in the fit.

8

Boolean

Allow Z

Indicates whether the Z position degree of free- dom is allowed to float in the fit.

9

Boolean

Allow Rx

Indicates whether the Rx rotational degree of

freedom is allowed to float in the fit.

10

Boolean

Allow Ry

Indicates whether the Ry rotational degree of free- dom is allowed to float in the fit.

11

Boolean

Allow Rz

Indicates whether the Rz rotational degree of

freedom is allowed to float in the fit.

 

12

 

Boolean

 

Lock Degrees of Freedom

If True, the DoF controls in the interface will be locked out such that a user cannot access them when the dialog is displayed.

13

Boolean

Generate Event

When True, an event will be generated.

 

14

 

File Path or Embedded File

File Path for CSV Text Report (requires Show Interface = TRUE)

A path for a CSV text report to create as a result of the fit (only created if the Show Interface argu- ment is set to TRUE).

 

Return Arguments

 

13

Transform

Transform in Working

The calculated transform (in working coordinates) for the fit.

14

World Transform Operator

Optimum Transform

The calculated transform (in world coordinates)

for the fit.

15

Double

RMS Deviation

The calculated RMS error for the fit.

16

Double

Maximum Absolute Deviation

The actual maximum absolute error for 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 and no tolerances were exceeded.

FAILURE

The reference or corresponding group could not be found, the fit could not be performed, or one or more tolerances were exceeded.

 

Remarks

The transform will not be applied to the instrument if any tolerance is exceeded. Also, monitoring the solution robust- ness factor is a great way to identify the mathematical stability of the solution.