You are here: Start » AVL.NET » AVL.ProfileDistance Method
AVL.ProfileDistance Method
Computes the [mean] square error between two profiles.
Namespace: | AvlNet |
---|---|
Assembly: | AVL.NET.dll |
Syntax
public static void ProfileDistance( AvlNet.Profile inProfile1, AvlNet.Profile inProfile2, AvlNet.DistanceMeasure inDistanceMeasure, out float outDistance )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inProfile1 | AvlNet.Profile | First input profile. | |||
inProfile2 | AvlNet.Profile | Second input profile. | |||
inDistanceMeasure | AvlNet.DistanceMeasure | Measure of distance. | |||
outDistance | float | Output distance value. |
Description
The operation computes the approximate difference between two profiles using the selected distance measure.
- If the inDistanceMeasure is set to MeanError then the resulting outDistance is the average difference between corresponding values of the profiles.
- If the inDistanceMeasure is set to MeanSquaredError then the resulting outDistance is the average squared difference between corresponding values of the profiles.
The operation requires that the profiles being compared have equal sizes, otherwise an error with appropriate description occurs.
Examples
Errors
Error type | Description |
---|---|
DomainError | Sizes of input profiles differ in ProfileDistance. |
DomainError | Empty profiles on input in ProfileDistance. |
DomainError | DistanceMeasure type not supported in ProfileDistance. |