Obtains the RMS, max deviation, and signed maximum and minimum deviations for a specified relationship.
Input Arguments
0 |
Collection Object Name |
Relationship Name |
The name of the relationship to examine. |
Return Arguments
1 |
Double |
Absolute Max Deviation |
The absolute maximum deviation value of the relationship. |
2 |
Double |
RMS |
The RMS error of the relationship. |
3 |
Boolean |
Has Signed Deviation? |
Indicates whether the deviations are signed. |
4 |
Double |
Signed Max Deviation |
The signed maximum deviation. |
5 |
Double |
Signed Min Deviation |
The signed minimum deviation. |
Returned Status
SUCCESS |
The relationship values were obtained successfully. |
FAILURE |
The specified relationship could not be found. |
Remarks
Max = the highest Z dev
RMS = RMS of the individual X, Y, Z components
All the points contribute three values that are submitted to a composite 1D vector of length 3 * N (N = number of points). The “AbsMax” and “RMS” are developed from this 1D data set.
The “RMS” results as calculated provides the objective function output for relationship minimization. This is actually a very convenient way to manage degree of freedom constraints for minimization operations -- unfortunately, the output it produces is inconsistent with the sort you would expect from a vector group style representation.