You are here: Start » AVL.NET » Function Reference » Histogram » Histogram Basics » AVL.GetHistogramBin
Returns the value of a single histogram bin.
Namespace: | AvlNet |
---|---|
Assembly: | AVL.NET.dll |
Syntax
C++
C#
public static void GetHistogramBin ( AvlNet.Histogram inHistogram, int inIndex, bool inCyclic, bool inInverse, out double outValue, out float outBinStart, out float outBinEnd )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inHistogram | AvlNet.Histogram | Input histogram. | |||
inIndex | int | Input bin index. | |||
inCyclic | bool | False | Whether to wrap the index around or not. Default value: False. | ||
inInverse | bool | Reversed order of bins. | |||
outValue | double | Output value of the bin. | |||
outBinStart | float | Lower limit of the bin. | |||
outBinEnd | float | Upper limit of the bin. |
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Incorrect index on input in GetHistogramBin. |
Function Overrides
- GetHistogramBin(Histogram, Int32, Boolean, Boolean, Double)
- GetHistogramBin(Histogram, Int32, Boolean, Boolean, Double, NullableValue<Single>, NullableValue<Single>)