Start » Filter Reference » Profile » Profile Metrics » ProfileDistance

ProfileDistance


Module: FoundationPro

Computes the [mean] square error between two profiles.

Name Type Description
Input value
inProfile1 Profile First input profile
Input value
inProfile2 Profile Second input profile
Input value
inRange Range*
Input value
inDistanceMeasure DistanceMeasure Measure of distance
Output value
outDistance Real 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

Mean Squared Error between the sample profiles equals 25245.070.

Mean Error between the sample profiles equals 0.803.

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type Description
DomainError DistanceMeasure type not supported in ProfileDistance.
DomainError Empty profile range in ProfileDistance.
DomainError Empty profiles on input in ProfileDistance.
DomainError Input profiles have different X coordinates in ProfileDistance.
DomainError Range exceeds the input profile in ProfileDistance.
DomainError Sizes of input profiles differ in ProfileDistance.

Complexity Level

This filter is available on Basic Complexity Level.