You are here: Start » AVL.NET » AVL.HistogramDistance
Computes the numeric distance between two histograms.
Namespace: | AvlNet |
---|---|
Assembly: | AVL.NET.dll |
Syntax
C++
C#
public static void HistogramDistance ( AvlNet.Histogram inHistogram1, AvlNet.Histogram inHistogram2, AvlNet.DistanceMeasure inDistanceMeasure, out float outDistance )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inHistogram1 | AvlNet.Histogram | First input histogram. | |||
inHistogram2 | AvlNet.Histogram | Second input histogram. | |||
inDistanceMeasure | AvlNet.DistanceMeasure | Measure of distance. | |||
outDistance | float | Output 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
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. |