You are here: Start » FIL.NET » Function Reference » Histogram » Histogram Basics » FIL.MakeHistogram
FIL.MakeHistogram
Creates a histogram out of an array of bin values.
| Namespace: | FilNet |
|---|---|
| Assembly: | FIL.NET.dll |
Syntax
C++
C#
public static void MakeHistogram ( IList<double> inValues, float inDomainStart, float inBinSize, int inStartIndex, int? inBinCount, FilNet.Histogram outHistogram )
Parameters
| Name | Type | Range | Default | Description | |
|---|---|---|---|---|---|
 | inValues | System.Collections.Generic.IList<double> | Input array of bin values. | ||
| inDomainStart | float | 0.0f | Input domain begin. Default value: 0.0f. | |
| inBinSize | float | <0.0f, INF> | 1.0f | Input length of the domain range covered by a single bin. Default value: 1.0f. |
| inStartIndex | int | <0, +INF> | 0 | Index of the first bin in the values array. Default value: 0. |
| inBinCount | int? | <1, +INF> | Number of bins in the resulting histogram. Default value: ftl::NIL. | |
 | outHistogram | FilNet.Histogram | Output histogram. |
Remarks
The calculated bin count must be equal to element count of the inValues array.
Errors
List of possible exceptions:
| Error type | Description |
|---|---|
| DomainError | Empty inValues array on input in MakeHistogram. |
| DomainError | Input inStartIndex out of bound in MakeHistogram. |
| DomainError | Non-positive value of inBinSize in MakeHistogram. |
| DomainError | Not enough data to fill all bins or inBinCount too large in MakeHistogram. |
