You are here: Start » FIL.NET » Function Reference » Profile » Profile Metrics » FIL.ProfileDistance

FIL.ProfileDistance

Computes the [mean] square error between two profiles.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void ProfileDistance
(
	FilNet.Profile inProfile1,
	FilNet.Profile inProfile2,
	FilNet.Range? inRange,
	FilNet.DistanceMeasure inDistanceMeasure,
	out float outDistance
)

Parameters

Name Type Range Default Description
inProfile1FilNet.ProfileFirst input profile.
inProfile2FilNet.ProfileSecond input profile.
inRangeFilNet.Range?
inDistanceMeasureFilNet.DistanceMeasureMeasure of distance.
outDistancefloatOutput 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

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.

Function Overrides

See also