You are here: Start » FIL.NET » Function Reference » Histogram » Histogram Basics » FIL.GetHistogramBin
Returns the value of a single histogram bin.
Namespace: | FilNet |
---|---|
Assembly: | FIL.NET.dll |
Syntax
C++
C#
public static void GetHistogramBin ( FilNet.Histogram inHistogram, int inIndex, bool inCyclic, bool inInverse, out double outValue, NullableValue<float> outBinStart, NullableValue<float> outBinEnd )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
![]() | inHistogram | FilNet.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 | FilNet.NullableValue<float> | Lower limit of the bin. Can be null to skip this parameter calculation. | ||
![]() | outBinEnd | FilNet.NullableValue<float> | Upper limit of the bin. Can be null to skip this parameter calculation. |
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, Single, Single)