C1Chart.GenerateHistogramData Method (Double[], Double, Double, Int32, Double, ByRef Double[], ByRef Double[], ByRef Double[])

Generates histogram data from raw data and a series of interval boundaries specified by a starting value, an interval width and the number of intervals.

[Visual Basic]

Overloads Public Shared Function GenerateHistogramData( _

ByVal RawData As Double(), _

ByVal Start As Double, _

ByVal IncrementalWidth As Double, _

ByVal Count As Integer, _

ByVal NormalizationWidth As Double, _

ByRef IntervalBounds As Double, _

ByRef IntervalCounts As Double, _

ByRef BoundaryIntervals As Double _

) As Boolean

[C#]

public static bool GenerateHistogramData(

double[] RawData,

double Start,

double IncrementalWidth,

int Count,

double NormalizationWidth,

ref double IntervalBounds,

ref double IntervalCounts,

ref double BoundaryIntervals

);

[Delphi]

public class function GenerateHistogramData(

RawData: Double();

Start: Double;

IncrementalWidth: Double;

Count: Int32;

NormalizationWidth: Double;

var IntervalBounds: Double;

var IntervalCounts: Double;

var BoundaryIntervals: Double

): Boolean; overload;

Parameters

RawData

Specifies a double array containing data values.

Start

Specifies the starting boundary of the first interval.

IncrementalWidth

Specifies the width of each interval.

Count

Specifies the number of consecutive, uniform width intervals.

NormalizationWidth

Specifies the interval width to be used for normalization. If less than or equal to zero, normalization is not performed.

IntervalBounds

A reference to a double array which will receive the actual ordered and trimmed boundaries of the intervals making up the histogram. This array is generated internally from the input Boundaries array.

IntervalCounts

A reference to a double array which will receive the count of data points that fall into the interval specified by the IntervalBounds array. The IntervalCounts array will necessarily have one less element than the IntervalBounds array.

BoundaryIntervals

A reference to a two element double array which will receive the count of data points that fall outside the specified Boundaries array. Element zero (0) of the array receives the count of data points with values less than the lowest value in the Boundaries array. Element one (1) of the array receives the count of data points with values greater than the highest value in the Boundaries array.

Return Value

A boolean indicating success or failure.

Exceptions

Exception Type	Condition
System.ArgumentNullException	Thrown when RawData is null.
System.ArgumentException	Thrown when the RawData array is too short.

Remarks

Each pair of consecutive interval boundary values is used to specify an interval. This results in one less interval than the number of boundary points. For example, if Start=1, IncrementalWidth=2 and Count=4, then intervals bounded by 1,3,5,7,9 are created, resulting in 4 intervals of 1-3, 3-5, 5-7, and 7-9.

Since all intervals are of equal width, it is not necessary to perform interval count normalization when only a single set of data is used. However, if multiple sets of data are used, and different interval widths are supplied, normalization provides a more consistent result.