You are here: Start » FIL.NET » Function Reference » Histogram » Histogram Metrics » FIL.HistogramDistance

FIL.HistogramDistance

Computes the numeric distance between two histograms.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void HistogramDistance
(
	FilNet.Histogram inHistogram1,
	FilNet.Histogram inHistogram2,
	FilNet.DistanceMeasure inDistanceMeasure,
	out double outDistance
)

Parameters

Name Type Range Default Description
inHistogram1FilNet.HistogramFirst input histogram.
inHistogram2FilNet.HistogramSecond input histogram.
inDistanceMeasureFilNet.DistanceMeasureMeasure of distance.
outDistancedoubleOutput distance value.

Description

The operation computes the approximate difference between two histograms using the selected distance measure.

  • If the inDistanceMeasure is set to MeanError then the resulting outDistance is the average difference between corresponding bins of the histograms.
  • If the inDistanceMeasure is set to MeanSquaredError then the resulting outDistance is the average squared difference between corresponding bins of the histograms.

Examples

Mean Squared Error between the sample histograms equals 68302.590.

Mean Squared Error between the sample histograms equals 3043686.

Remarks

  • inHistogram1 and inHistogram2 must have the same BinSizes, otherwise an error with appropriate description occurs.

Errors

List of possible exceptions:

Error type Description
DomainError Empty histograms on input in HistogramDistance.
DomainError Inconsistent histogram bin sizes / domains in HistogramDistance.
DomainError Not supported DistanceMeasure in HistogramDistance.

See also